메인 콘텐츠로 건너뛰기
자동화된 환경에서 스크립트를 실행할 때는, 스크립트 실행 전에 또는 스크립트 내에서 설정한 환경 변수를 통해 W&B를 제어할 수 있습니다.
# 이것은 비밀이므로 버전 관리에 체크인하면 안 됩니다
WANDB_API_KEY=$YOUR_API_KEY
# 이름과 메모는 선택 사항입니다
WANDB_NAME="My first run"
WANDB_NOTES="Smaller learning rate, more regularization."
# wandb/settings 파일을 버전 관리에 포함하지 않는 경우에만 필요
WANDB_ENTITY=$username
WANDB_PROJECT=$project
# 스크립트를 클라우드에 동기화하지 않으려는 경우
os.environ["WANDB_MODE"] = "offline"

# 실행 오브젝트 및 관련 클래스에 sweep ID 추적 추가
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"

선택적 환경 변수

원격 머신에서 인증을 설정하는 등의 작업에 다음 선택적 환경 변수를 사용할 수 있습니다.
변수 이름사용법
WANDB_API_KEY계정과 연결된 인증 키를 설정합니다. User Settings에서 API key를 생성하세요. 원격 머신에서 아직 wandb login을 실행하지 않았다면 이 값을 반드시 설정해야 합니다.
WANDB_BASE_URLwandb/local을 사용하는 경우 이 환경 변수 값을 http://YOUR_IP:YOUR_PORT로 설정해야 합니다
WANDB_CACHE_DIR기본값은 ~/.cache/wandb이며, 이 환경 변수를 통해 경로를 변경할 수 있습니다.
WANDB_CONFIG_DIR기본값은 ~/.config/wandb이며, 이 환경 변수를 통해 경로를 변경할 수 있습니다.
WANDB_CONFIG_PATHSwandb.config에 로드할 YAML 파일 목록으로, 쉼표로 구분됩니다. config를 참고하세요.
WANDB_CONSOLEstdout / stderr 로깅을 비활성화하려면 이 값을 “off”로 설정합니다. 이 기능을 지원하는 환경에서는 기본값이 “on”입니다.
WANDB_DATA_DIR스테이징 아티팩트를 업로드하는 위치입니다. 기본 위치는 사용 중인 플랫폼에 따라 달라지며, platformdirs Python 패키지의 user_data_dir 값을 사용해 결정됩니다. 이 디렉터리가 존재하는지, 그리고 실행 중인 사용자에게 여기에 쓸 수 있는 권한이 있는지 확인하십시오.
WANDB_DIR모든 생성된 파일의 저장 위치입니다. 설정하지 않으면 학습 스크립트를 기준으로 하는 wandb 디렉터리가 기본값입니다. 이 디렉터리가 존재하며 실행 중인 사용자가 여기에 쓸 수 있는 권한이 있는지 확인하십시오. 이 변수는 다운로드된 아티팩트의 위치를 제어하지 않으며, 해당 위치는 WANDB_ARTIFACT_DIR 환경 변수로 설정할 수 있습니다.
WANDB_ARTIFACT_DIR모든 다운로드된 아티팩트를 저장할 위치입니다. 설정하지 않으면 기본적으로 학습 스크립트 기준의 artifacts 디렉터리가 사용됩니다. 이 디렉터리가 존재하고, 실행 중인 프로세스의 사용자가 해당 디렉터리에 쓸 수 있는 권한이 있는지 확인하세요. 이 변수는 생성된 메타데이터 파일의 위치를 제어하지 않으며, 메타데이터 파일 위치는 WANDB_DIR 환경 변수를 사용해 설정할 수 있습니다.
WANDB_DISABLE_GITwandb가 git 저장소를 검색해 최신 커밋과 diff를 수집하지 못하도록 합니다.
WANDB_DISABLE_CODEwandb가 노트북이나 git diff를 저장하지 않게 하려면 이 값을 true로 설정합니다. git 저장소 내에 있는 경우 현재 커밋은 계속 저장합니다.
WANDB_DOCKER실행을 복원할 수 있도록 이 값을 Docker 이미지 다이제스트로 설정하세요. 이 값은 wandb docker 명령으로 자동으로 설정됩니다. wandb docker my/image/name:tag --digest를 실행하여 이미지 다이제스트를 얻을 수 있습니다.
WANDB_ENTITY실행과 연결된 엔터티입니다. 학습 스크립트가 있는 디렉터리에서 wandb init을 실행했다면 wandb라는 디렉터리가 생성되고, 버전 관리 시스템에 커밋할 수 있는 기본 엔터티가 저장됩니다. 해당 파일을 생성하지 않으려 하거나 파일에 설정된 값을 재정의하려면 이 환경 변수를 사용할 수 있습니다.
WANDB_ERROR_REPORTINGwandb가 치명적인 오류를 자체 오류 추적 시스템에 기록하지 않도록 하려면 이 값을 false로 설정합니다.
WANDB_HOST시스템에서 제공하는 호스트 이름을 사용하지 않으려면, wandb 인터페이스에 표시할 호스트 이름으로 이 값을 설정합니다.
WANDB_IGNORE_GLOBS무시할 파일 glob 패턴을 쉼표로 구분한 목록으로 설정합니다. 이 파일들은 클라우드와 동기화되지 않습니다.
WANDB_JOB_NAMEwandb가 생성하는 모든 작업에 사용할 이름을 지정합니다.
WANDB_JOB_TYPE”training” 또는 “evaluation”과 같은 작업 유형을 지정하여 실행의 유형을 나타냅니다. 자세한 내용은 grouping을 참고하세요.
WANDB_MODE이 값을 “offline”으로 설정하면 wandb는 실행 메타데이터를 로컬에 저장하고 서버와 동기화하지 않습니다. 이 값을 disabled로 설정하면 wandb는 완전히 비활성화됩니다.
WANDB_NAME실행에 대해 사람이 알아볼 수 있는 이름입니다. 설정하지 않으면 임의의 이름이 자동으로 생성됩니다.
WANDB_NOTEBOOK_NAMEJupyter에서 실행 중이라면 이 변수로 노트북 이름을 설정할 수 있습니다. 이 값은 자동으로 감지하려고 시도합니다.
WANDB_NOTES실행에 대한 더 자세한 메모입니다. Markdown을 사용할 수 있으며, 이후 UI에서 수정할 수 있습니다.
WANDB_PROJECT실행과 연결된 Project입니다. 이는 wandb init으로도 설정할 수 있지만, 환경 변수로 설정된 값이 우선 적용됩니다.
WANDB_RESUME기본값은 never입니다. auto로 설정하면 wandb가 실패한 실행을 자동으로 재개합니다. must로 설정하면 시작 시 실행이 이미 존재해야 합니다. 항상 고유한 ID를 직접 생성하려면 allow로 설정하고 항상 WANDB_RUN_ID를 설정하세요.
WANDB_RUN_GROUP실행을 자동으로 하나의 그룹으로 묶을 실험 이름을 지정합니다. 자세한 내용은 그룹화 문서를 참고하세요.
WANDB_RUN_ID스크립트의 단일 실행에 해당하는, 프로젝트 내에서 전역적으로 고유한 문자열로 설정합니다. 길이는 64자를 넘을 수 없습니다. 단어 문자가 아닌 모든 문자는 대시(-)로 변환됩니다. 장애 발생 시 기존 실행을 재개하는 데 사용할 수 있습니다.
WANDB_QUIET표준 출력으로 기록되는 로그 메시지를 critical 수준의 메시지로만 제한하려면 이를 true로 설정하세요. 이렇게 설정하면 모든 로그는 $WANDB_DIR/debug.log에 기록됩니다.
WANDB_SILENTtrue로 설정하면 wandb 로그 출력을 비활성화합니다. 스크립트 기반 명령에 유용합니다. 이 값을 설정하면 모든 로그는 $WANDB_DIR/debug.log에 기록됩니다.
WANDB_SHOW_RUNtrue로 설정하면, 운영 체제가 지원하는 경우 실행 URL이 브라우저에서 자동으로 열립니다.
WANDB_SWEEP_IDRun 객체 및 관련 클래스에 스위프 ID 추적을 추가하고 UI에 표시합니다.
WANDB_TAGS실행에 적용할 태그를 쉼표로 구분한 목록입니다.
WANDB_USERNAME실행과 연결된 팀 구성원의 사용자 이름입니다. 서비스 계정 API key와 함께 사용하면 팀 구성원에게 자동 실행을 귀속시키는 데 사용할 수 있습니다.
WANDB_USER_EMAIL실행과 연결된 팀 구성원의 이메일입니다. 서비스 계정 API key와 함께 사용하면 팀 구성원에게 자동 실행을 귀속시키는 데 사용할 수 있습니다.

Singularity 환경

Singularity에서 컨테이너를 실행하는 경우, 위에서 설명한 환경 변수들 앞에 SINGULARITYENV_ 접두사를 붙여 전달할 수 있습니다. Singularity 환경 변수에 대한 자세한 내용은 여기에서 확인할 수 있습니다.

AWS에서 실행하기

AWS에서 배치 작업을 실행하는 경우, W&B 자격 증명으로 머신을 쉽게 인증할 수 있습니다. User Settings에서 API key를 생성한 다음, WANDB_API_KEY 환경 변수를 AWS Batch 작업 사양에 설정하십시오.