> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

> 환경 변수를 사용하여 인증, 프로젝트 설정, 로깅 모드 등 W&B SDK의 동작을 설정하세요.

# 환경 변수

자동화된 환경에서 스크립트를 실행할 때는 스크립트 실행 전이나 스크립트 내에서 환경 변수를 설정하여 W\&B를 제어할 수 있습니다.

```bash theme={"system"}
# 이 값은 시크릿이므로 버전 관리 시스템에 커밋하지 마세요
WANDB_API_KEY=$YOUR_API_KEY
# 이름과 메모는 선택 사항입니다
WANDB_NAME="My first run"
WANDB_NOTES="Smaller learning rate, more regularization."
```

```bash theme={"system"}
# wandb/settings 파일을 체크인하지 않는 경우에만 필요합니다
WANDB_ENTITY=$username
WANDB_PROJECT=$project
```

```python theme={"system"}
# 스크립트를 클라우드와 동기화하지 않으려면
os.environ["WANDB_MODE"] = "offline"

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

<h2 id="optional-environment-variables">
  선택 환경 변수
</h2>

원격 머신에서 인증을 설정하는 등의 작업에는 다음 선택 환경 변수를 사용하세요.

| 변수 이름 | 사용 |
| - | - |
| `WANDB_API_KEY` | 계정에 연결된 인증 키를 설정합니다. [User Settings](https://forge.coreweave.com/settings)에서 API 키를 생성하세요. 원격 머신에서 `wandb login`을 실행하지 않은 경우 반드시 설정해야 합니다. |
| `WANDB_BASE_URL` | [wandb/local](/ko/products/wandb/platform/hosting)을 사용하는 경우 이 환경 변수를 `http://YOUR_IP:YOUR_PORT`로 설정해야 합니다. |
| `WANDB_CACHE_DIR` | 기본값은 \~/.cache/wandb이며, 이 환경 변수로 위치를 재정의할 수 있습니다. |
| `WANDB_CONFIG_DIR` | 기본값은 \~/.config/wandb이며, 이 환경 변수로 위치를 재정의할 수 있습니다. |
| `WANDB_CONFIG_PATHS` | wandb.config에 로드할 yaml 파일 목록으로, 쉼표로 구분합니다. [설정](/ko/products/wandb/track/config#file-based-configs)을 참조하세요. |
| `WANDB_CONSOLE` | stdout / 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_GIT` | wandb가 git 저장소를 탐색하거나 최신 커밋 / diff를 캡처하지 않도록 합니다. |
| `WANDB_DISABLE_CODE` | wandb가 노트북이나 git diff를 저장하지 않도록 하려면 true로 설정하세요. git 저장소 안에서 실행 중이면 현재 커밋은 계속 저장됩니다. |
| `WANDB_DOCKER` | run 복원을 활성화하려면 도커 이미지 digest로 설정하세요. wandb docker 명령어를 사용하면 자동으로 설정됩니다. `wandb docker my/image/name:tag --digest`를 실행하여 이미지 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` | "training"이나 "evaluation"과 같은 작업 유형을 지정하여 run의 유형을 구분합니다. 자세한 내용은 [그룹화](/ko/products/wandb/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을 자동으로 그룹화할 실험 이름을 지정합니다. 자세한 내용은 [그룹화](/ko/products/wandb/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` 객체 및 관련 클래스에 스윕 ID 추적을 추가하고 UI에 표시합니다. |
| `WANDB_TAGS` | run에 적용할 태그 목록으로, 쉼표로 구분합니다. |
| `WANDB_USERNAME` | run과 연결된 팀 구성원의 사용자 이름입니다. 서비스 계정 API 키와 함께 사용하면 자동화된 run의 작성자를 팀 구성원으로 지정할 수 있습니다. |
| `WANDB_USER_EMAIL` | run과 연결된 팀 구성원의 이메일입니다. 서비스 계정 API 키와 함께 사용하면 자동화된 run의 작성자를 팀 구성원으로 지정할 수 있습니다. |

<h2 id="singularity-environments">
  Singularity 환경
</h2>

[Singularity](https://singularity.lbl.gov/index.html)에서 컨테이너를 실행하는 경우, 위 변수 이름 앞에 `SINGULARITYENV_`를 붙여 환경 변수를 전달할 수 있습니다. Singularity 환경 변수에 대한 자세한 내용은 [여기](https://singularity.lbl.gov/docs-environment-metadata#environment)를 참조하세요.

<h2 id="running-on-aws">
  AWS에서 실행하기
</h2>

AWS에서 배치 작업을 실행하는 경우 W\&B 자격 증명으로 머신을 간편하게 인증할 수 있습니다. [User Settings](https://forge.coreweave.com/settings)에서 API 키를 생성한 다음 [AWS Batch 작업 사양](https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters)에 `WANDB_API_KEY` 환경 변수를 설정하세요.
