메인 콘텐츠로 건너뛰기
자동화된 환경에서 스크립트를 실행할 때, 스크립트 실행 전 또는 스크립트 내에서 설정된 환경 변수를 통해 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 오브젝트 및 관련 클래스에 sweep ID 트래킹 추가
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"

선택적 환경 변수

원격 머신에서 인증을 설정하는 등의 작업을 수행하려면 다음 선택적 환경 변수를 사용하세요.
변수명사용법
WANDB_API_KEY계정과 연결된 인증 키를 설정합니다. 사용자 설정에서 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 파이썬 패키지의 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_DOCKERRuns 복원을 활성화하려면 이 변수를 docker 이미지 다이제스트로 설정하세요. 이는 wandb docker 코맨드와 함께 자동으로 설정됩니다. wandb docker my/image/name:tag --digest를 실행하여 이미지 다이제스트를 얻을 수 있습니다.
WANDB_ENTITY해당 run과 연결된 Entity입니다. 트레이닝 스크립트 디렉토리에서 wandb init을 실행했다면 wandb 디렉토리가 생성되고 소스 제어에 체크인할 수 있는 기본 Entity가 저장됩니다. 해당 파일을 만들고 싶지 않거나 파일을 오버라이드하고 싶을 때 이 환경 변수를 사용하세요.
WANDB_ERROR_REPORTINGwandb가 치명적인 오류를 오류 트래킹 시스템에 로깅하지 않도록 하려면 false로 설정하세요.
WANDB_HOST시스템에서 제공하는 호스트네임 대신 wandb 인터페이스에서 보고 싶은 호스트네임으로 설정하세요.
WANDB_IGNORE_GLOBS무시할 파일 글로브(glob)의 쉼표로 구분된 리스트를 설정하세요. 이 파일들은 클라우드에 동기화되지 않습니다.
WANDB_JOB_NAMEwandb에 의해 생성된 모든 job의 이름을 지정합니다.
WANDB_JOB_TYPE서로 다른 유형의 runs를 나타내기 위해 “training” 또는 “evaluation”과 같은 job 유형을 지정합니다. 자세한 정보는 grouping을 참조하세요.
WANDB_MODE”offline”으로 설정하면 wandb는 run 메타데이터를 로컬에 저장하고 서버에 동기화하지 않습니다. disabled로 설정하면 wandb가 완전히 꺼집니다.
WANDB_NAME사용자가 읽을 수 있는 run의 이름입니다. 설정하지 않으면 무작위로 생성됩니다.
WANDB_NOTEBOOK_NAMEjupyter에서 실행 중인 경우 이 변수로 노트북 이름을 설정할 수 있습니다. 자동으로 감지하려고 시도합니다.
WANDB_NOTESrun에 대한 자세한 메모입니다. 마크다운을 사용할 수 있으며 나중에 UI에서 수정할 수 있습니다.
WANDB_PROJECTrun과 연결된 Project입니다. wandb init으로도 설정할 수 있지만, 환경 변수가 해당 값을 오버라이드합니다.
WANDB_RESUME기본값은 _never_입니다. _auto_로 설정하면 wandb가 실패한 runs를 자동으로 재개합니다. _must_로 설정하면 시작 시 run이 반드시 존재해야 합니다. 항상 고유한 ID를 직접 생성하려면 _allow_로 설정하고 항상 WANDB_RUN_ID를 설정하세요.
WANDB_RUN_GROUPruns를 자동으로 그룹화하기 위해 실험 이름을 지정합니다. 자세한 정보는 grouping을 참조하세요.
WANDB_RUN_ID스크립트의 단일 run에 해당하는 전역적으로 고유한 문자열(프로젝트당)로 설정하세요. 64자 이내여야 합니다. 단어가 아닌 문자는 대시(-)로 변환됩니다. 실패 시 기존 run을 재개하는 데 사용할 수 있습니다.
WANDB_QUIET표준 출력으로 로깅되는 구문을 중요한 구문으로만 제한하려면 true로 설정하세요. 이 변수가 설정되면 모든 로그는 $WANDB_DIR/debug.log에 기록됩니다.
WANDB_SILENTwandb 로그 구문을 소거하려면 true로 설정하세요. 스크립트 명령에 유용합니다. 이 변수가 설정되면 모든 로그는 $WANDB_DIR/debug.log에 기록됩니다.
WANDB_SHOW_RUN운영 체제가 지원하는 경우 run URL이 포함된 브라우저를 자동으로 열려면 true로 설정하세요.
WANDB_SWEEP_IDRun 오브젝트 및 관련 클래스에 Sweeps ID 트래킹을 추가하고 UI에 표시합니다.
WANDB_TAGSrun에 적용할 태그의 쉼표로 구분된 리스트입니다.
WANDB_USERNAMErun과 연결된 팀 멤버의 사용자 이름입니다. 서비스 계정 API 키와 함께 사용하여 자동화된 runs를 팀 멤버의 기여로 할당하는 데 사용할 수 있습니다.
WANDB_USER_EMAILrun과 연결된 팀 멤버의 이메일입니다. 서비스 계정 API 키와 함께 사용하여 자동화된 runs를 팀 멤버의 기여로 할당하는 데 사용할 수 있습니다.

Singularity 환경

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

AWS에서 실행하기

AWS에서 배치 작업을 실행하는 경우, W&B 자격 증명으로 머신을 쉽게 인증할 수 있습니다. 사용자 설정에서 API 키를 생성하고, AWS 배치 작업 사양WANDB_API_KEY 환경 변수를 설정하세요.