> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-docs-sandboxes-integrations-placement.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> 인증, 프로젝트 설정, 로깅 모드 등을 위해 환경 변수를 사용해 W&B SDK 동작을 구성할 수 있습니다.
# 환경 변수
자동화된 환경에서 스크립트를 실행할 때는 스크립트 실행 전에 설정하거나 스크립트 내에서 설정한 환경 변수를 사용해 W\&B를 제어할 수 있습니다.
```bash theme={null}
# 이 값은 비밀이므로 버전 관리에 체크인하지 마세요
WANDB_API_KEY=$YOUR_API_KEY
# name과 notes는 선택 사항
WANDB_NAME="My first run"
WANDB_NOTES="Smaller learning rate, more regularization."
```
```bash theme={null}
# wandb/settings 파일을 체크인하지 않는 경우에만 필요
WANDB_ENTITY=$username
WANDB_PROJECT=$project
```
```python theme={null}
# 스크립트를 클라우드에 동기화하지 않으려면
os.environ["WANDB_MODE"] = "offline"
# Run 객체 및 관련 클래스에 sweep ID tracking 추가
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"
```
## 선택적 환경 변수
원격 머신에서 인증을 설정하는 등의 작업에 이 선택적 환경 변수를 사용할 수 있습니다.
| 변수 이름 | 사용 |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `WANDB_API_KEY` | 계정에 연결된 인증 키를 설정합니다. [User Settings](https://wandb.ai/settings)에서 API 키를 생성하세요. 원격 머신에서 `wandb login`을 실행하지 않았다면 반드시 이 값을 설정해야 합니다. |
| `WANDB_BASE_URL` | [wandb/local](/ko/platform/hosting/)을 사용하는 경우, 이 환경 변수를 `http://YOUR_IP:YOUR_PORT`로 설정해야 합니다 |
| `WANDB_CACHE_DIR` | 기본 위치는 \~/.cache/wandb이며, 이 환경 변수로 해당 위치를 재정의할 수 있습니다. |
| `WANDB_CONFIG_DIR` | 기본 위치는 \~/.config/wandb이며, 이 환경 변수로 해당 위치를 재정의할 수 있습니다. |
| `WANDB_CONFIG_PATHS` | wandb.config에 로드할 YAML 파일의 쉼표로 구분된 목록입니다. [설정](./config#file-based-configs)을 참조하세요. |
| `WANDB_CONSOLE` | stdout / stderr 로깅을 비활성화하려면 이 값을 "off"로 설정하세요. 이를 지원하는 환경에서는 기본값이 "on"입니다. |
| `WANDB_DATA_DIR` | 스테이징 artifact를 업로드하는 위치입니다. 기본 위치는 `platformdirs` Python 패키지의 `user_data_dir` 값을 사용하므로 플랫폼에 따라 달라집니다. 이 디렉터리가 존재하며 실행 중인 사용자가 여기에 쓸 권한이 있는지 확인하세요. |
| `WANDB_DIR` | 생성된 모든 파일을 저장할 위치입니다. 설정하지 않으면 트레이닝 스크립트 기준의 `wandb` 디렉터리가 기본값으로 사용됩니다. 이 디렉터리가 존재하고 현재 실행 중인 사용자가 여기에 쓸 수 있는 권한이 있는지 확인하세요. 이 변수는 다운로드된 artifacts의 저장 위치는 제어하지 않으며, 해당 위치는 `WANDB_ARTIFACT_DIR` 환경 변수를 사용해 설정할 수 있습니다. |
| `WANDB_ARTIFACT_DIR` | 다운로드한 모든 artifacts를 저장할 위치입니다. 설정하지 않으면 트레이닝 스크립트 기준 상대 경로의 `artifacts` 디렉터리를 기본값으로 사용합니다. 이 디렉터리가 존재하고 현재 실행 중인 사용자가 여기에 쓸 권한이 있는지 확인하세요. 이 설정은 생성된 메타데이터 파일의 위치에는 영향을 주지 않으며, 해당 위치는 `WANDB_DIR` 환경 변수로 설정할 수 있습니다. |
| `WANDB_DISABLE_GIT` | wandb가 git 저장소를 검색해 최신 커밋 / diff를 수집하지 않도록 합니다. |
| `WANDB_DISABLE_CODE` | wandb가 노트북이나 git diff를 저장하지 않도록 하려면 이 값을 true로 설정합니다. git 리포지토리에 있는 경우에는 현재 커밋은 계속 저장됩니다. |
| `WANDB_DOCKER` | run 복원을 사용하려면 이 값을 도커 이미지 다이제스트로 설정하세요. 이 값은 wandb docker 명령어를 사용하면 자동으로 설정됩니다. `wandb docker my/image/name:tag --digest`를 실행해 이미지 다이제스트를 획득할 수 있습니다. |
| `WANDB_ENTITY` | run에 연결된 entity입니다. 트레이닝 스크립트 디렉터리에서 `wandb init`을 실행하면 *wandb*라는 디렉터리가 생성되고, 소스 제어에 체크인할 수 있는 기본 entity가 저장됩니다. 이 파일을 만들고 싶지 않거나 이 파일을 재정의하려면 환경 변수를 사용할 수 있습니다. |
| `WANDB_ERROR_REPORTING` | wandb가 치명적인 오류를 자체 오류 추적 시스템에 기록하지 않도록 하려면 이 값을 false로 설정합니다. |
| `WANDB_HOST` | 시스템에서 제공하는 호스트 이름을 사용하지 않으려면 wandb 인터페이스에 표시할 호스트 이름으로 이 값을 설정합니다. |
| `WANDB_IGNORE_GLOBS` | 무시할 파일 glob의 쉼표로 구분된 목록으로 이 값을 설정합니다. 이 파일은 클라우드에 동기화되지 않습니다. |
| `WANDB_JOB_NAME` | `wandb`가 생성하는 모든 작업의 이름을 지정합니다. |
| `WANDB_JOB_TYPE` | 서로 다른 유형의 run을 나타내려면 "training" 또는 "evaluation" 같은 작업 유형을 지정합니다. 자세한 내용은 [grouping](/ko/models/runs/grouping/)을 참조하세요. |
| `WANDB_MODE` | 이를 "offline"로 설정하면 wandb가 run 메타데이터를 로컬에 저장하고 서버와는 동기화하지 않습니다. 이를 `disabled`로 설정하면 wandb가 완전히 꺼집니다. |
| `WANDB_NAME` | run의 사람이 읽을 수 있는 이름입니다. 설정하지 않으면 임의로 생성됩니다. |
| `WANDB_NOTEBOOK_NAME` | Jupyter에서 실행 중인 경우 이 변수로 노트북 이름을 설정할 수 있습니다. 이 값은 자동으로 감지되도록 시도합니다. |
| `WANDB_NOTES` | run에 대한 자세한 메모입니다. Markdown을 사용할 수 있으며, 나중에 UI에서 편집할 수 있습니다. |
| `WANDB_PROJECT` | run과 연결된 프로젝트입니다. `wandb init`으로도 설정할 수 있지만, 환경 변수가 이 값을 재정의합니다. |
| `WANDB_RESUME` | 기본값은 *never*입니다. *auto*로 설정하면 wandb가 실패한 run을 자동으로 재개합니다. *must*로 설정하면 시작 시 run이 반드시 이미 존재해야 합니다. 항상 직접 고유 ID를 생성하려면 *allow*로 설정하고 `WANDB_RUN_ID`를 항상 지정하세요. |
| `WANDB_RUN_GROUP` | 실험 이름을 지정하면 run이 자동으로 그룹화됩니다. 자세한 내용은 [grouping](/ko/models/runs/grouping/)을 참조하세요. |
| `WANDB_RUN_ID` | 스크립트의 단일 run에 해당하는 전역적으로 고유한 문자열(프로젝트별)로 설정하세요. 길이는 64자를 넘을 수 없습니다. 영숫자와 밑줄이 아닌 모든 문자는 대시로 변환됩니다. 실패한 경우 기존 run을 재개하는 데 사용할 수 있습니다. |
| `WANDB_QUIET` | 표준 출력에 로깅되는 메시지를 중요 메시지만 출력하도록 제한하려면 이 값을 `true`로 설정합니다. 이렇게 설정하면 모든 로그가 `$WANDB_DIR/debug.log`에 기록됩니다. |
| `WANDB_SILENT` | wandb 로그 메시지를 출력하지 않으려면 이 값을 `true`로 설정하세요. 스크립트로 실행하는 명령에서 유용합니다. 이렇게 설정하면 모든 로그가 `$WANDB_DIR/debug.log`에 기록됩니다. |
| `WANDB_SHOW_RUN` | 운영 체제에서 지원하는 경우 run URL이 브라우저에서 자동으로 열리도록 하려면 이 값을 `true`로 설정합니다. |
| `WANDB_SWEEP_ID` | `Run` 객체 및 관련 클래스에 `sweep ID` 추적 기능을 추가하고, 이를 UI에 표시합니다. |
| `WANDB_TAGS` | run에 적용할 태그의 쉼표로 구분된 목록입니다. |
| `WANDB_USERNAME` | run과 연결된 팀 멤버의 사용자 이름입니다. 서비스 계정 API 키와 함께 사용하면 자동화된 run의 소유자를 팀 멤버로 귀속시킬 수 있습니다. |
| `WANDB_USER_EMAIL` | run과 연결된 팀 멤버의 이메일입니다. 서비스 계정 API 키와 함께 사용하면 자동화된 run의 소유자를 팀 멤버로 귀속시킬 수 있습니다. |
## Singularity 환경
[Singularity](https://singularity.lbl.gov/index.html)에서 컨테이너를 실행하는 경우, 위의 변수 이름 앞에 `SINGULARITYENV_`를 붙여 환경 변수를 전달할 수 있습니다. Singularity 환경 변수에 대한 자세한 내용은 [여기](https://singularity.lbl.gov/docs-environment-metadata#environment)에서 확인하세요.
## AWS에서 실행하기
AWS에서 배치 작업을 실행하는 경우 W\&B 자격 증명을 사용해 머신을 쉽게 인증할 수 있습니다. [User Settings](https://wandb.ai/settings)에서 API 키를 생성한 다음, [AWS Batch 작업 사양](https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters)에서 `WANDB_API_KEY` 환경 변수를 설정하세요.