메인 콘텐츠로 건너뛰기
자동화된 환경에서 스크립트를 실행할 때는, 스크립트 실행 전에 또는 스크립트 내부에서 설정한 환경 변수로 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"

# Run 객체 및 관련 클래스에 스윕 ID 추적 추가
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"

선택적 환경 변수

원격 머신에서 인증을 설정하는 등 작업을 할 때 사용할 수 있는 선택적 환경 변수입니다.
변수 이름설명
WANDB_API_KEY계정에 연결된 API 키를 설정합니다. User Settings에서 API 키를 생성하세요. 원격 머신에서 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 저장소를 검사하여 최신 커밋/차이 정보를 수집하지 않도록 합니다.
WANDB_DISABLE_CODEwandb가 노트북이나 git diff를 저장하지 않게 하려면 이 값을 true로 설정합니다. git 저장소 안에 있는 경우 현재 커밋은 계속 저장합니다.
WANDB_DOCKERRuns를 복원할 수 있도록 여기에 Docker 이미지 다이제스트를 설정하세요. 이 값은 wandb docker 명령으로 자동으로 설정됩니다. wandb docker my/image/name:tag --digest 명령을 실행하여 이미지 다이제스트를 얻을 수 있습니다.
WANDB_ENTITYrun과 연결된 entity입니다. 트레이닝 스크립트가 있는 디렉터리에서 wandb init을 실행하면 wandb라는 디렉터리가 생성되고, 버전 관리 시스템에 커밋할 수 있는 기본 entity가 그 안에 저장됩니다. 해당 파일을 만들고 싶지 않거나 파일에 저장된 값을 덮어쓰고 싶은 경우 이 환경 변수를 사용할 수 있습니다.
WANDB_ERROR_REPORTINGwandb가 치명적인 오류를 자체 오류 추적 시스템에 기록하지 않게 하려면 이 값을 false로 설정합니다.
WANDB_HOST시스템에서 제공하는 호스트 이름을 사용하지 않으려는 경우, wandb 인터페이스에 표시할 호스트 이름을 여기에서 설정합니다.
WANDB_IGNORE_GLOBS무시할 파일 glob 패턴을 쉼표로 구분한 목록으로 설정합니다. 이 파일들은 클라우드와 동기화되지 않습니다.
WANDB_JOB_NAMEwandb에서 생성하는 모든 작업의 이름을 지정합니다.
WANDB_JOB_TYPE작업 유형을 “트레이닝” 또는 “평가”처럼 지정하여 run의 종류를 구분합니다. 자세한 내용은 그룹화를 참고하세요.
WANDB_MODE이 값을 “offline”으로 설정하면 wandb는 run 메타데이터를 로컬에 저장하고 서버와는 동기화하지 않습니다. 이 값을 disabled로 설정하면 wandb는 완전히 비활성화됩니다.
WANDB_NAMErun의 사람이 읽기 쉬운 이름입니다. 설정하지 않으면 임의의 이름이 자동으로 생성됩니다.
WANDB_NOTEBOOK_NAMEJupyter에서 실행 중인 경우, 이 변수를 사용해 노트북 이름을 설정할 수 있습니다. wandb가 이를 자동으로 감지하려고 시도합니다.
WANDB_NOTESrun에 대한 더 긴 메모입니다. Markdown을 사용할 수 있으며, 이후 UI에서 수정할 수 있습니다.
WANDB_PROJECTrun과 연결된 프로젝트입니다. wandb init으로도 설정할 수 있지만, 환경 변수로 설정된 값이 우선 적용됩니다.
WANDB_RESUME기본값은 never입니다. auto로 설정하면 wandb가 실패한 run을 자동으로 재개합니다. must로 설정하면 시작 시 해당 run이 반드시 존재해야 합니다. 항상 고유한 ID를 직접 생성하려면 이 값을 allow로 설정하고 WANDB_RUN_ID를 항상 지정하십시오.
WANDB_RUN_GROUP실험 이름을 지정하면 run이 자동으로 하나의 그룹으로 묶입니다. 자세한 내용은 grouping을 참조하세요.
WANDB_RUN_ID스크립트의 단일 run에 해당하는, 프로젝트 내 전역적으로 고유한 문자열을 설정합니다. 길이는 64자 이하여야 합니다. 단어 문자가 아닌 모든 문자는 대시(-)로 변환됩니다. 이는 장애 발생 시 기존 run을 재개하는 데 사용할 수 있습니다.
WANDB_QUIET이 값을 true로 설정하면 표준 출력으로 기록되는 로그를 CRITICAL 수준의 메시지로만 제한합니다. 이렇게 설정하면 모든 로그는 $WANDB_DIR/debug.log에 기록됩니다.
WANDB_SILENT이 값을 true로 설정하면 wandb 로그 메시지가 출력되지 않습니다. 스크립트형 명령을 사용할 때 유용합니다. 이 값이 설정되면 모든 로그는 $WANDB_DIR/debug.log에 기록됩니다.
WANDB_SHOW_RUN운영체제가 지원하는 경우 이 값을 true로 설정하면 브라우저에서 run URL이 자동으로 열립니다.
WANDB_SWEEP_ID스윕 ID 추적을 Run 객체 및 관련 클래스에 추가하고 UI에 표시합니다.
WANDB_TAGSrun에 적용할 태그를 쉼표로 구분한 목록입니다.
WANDB_USERNAMErun과 연결할 팀 구성원의 사용자 이름입니다. 서비스 계정 API 키와 함께 사용하여 자동화된 run을 해당 팀 구성원에게 귀속시키는 데 사용할 수 있습니다.
WANDB_USER_EMAILrun과 연결할 팀 구성원의 이메일입니다. 서비스 계정 API 키와 함께 사용하여 자동화된 run을 해당 팀 구성원에게 귀속시키는 데 사용할 수 있습니다.

Singularity 환경

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

AWS에서 실행하기

AWS에서 배치 작업을 실행한다면 W&B 자격 증명을 사용해 머신을 간편하게 인증할 수 있습니다. User Settings에서 API 키를 생성한 다음, AWS Batch 작업 사양에서 WANDB_API_KEY 환경 변수를 설정하세요.