이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

Command Line Interface

사용법

wandb [OPTIONS] COMMAND [ARGS]...

옵션

옵션 설명
--version 버전을 표시하고 종료합니다.

커맨드

커맨드 설명
agent W&B 에이전트 를 실행합니다.
artifact Artifacts 와 상호 작용하기 위한 커맨드
beta wandb CLI 커맨드의 베타 버전.
controller W&B 로컬 스윕 컨트롤러 를 실행합니다.
disabled W&B를 비활성화합니다.
docker docker 컨테이너 에서 코드를 실행합니다.
docker-run docker run을 래핑하고 WANDB_API_KEY 및 WANDB_DOCKER…를 추가합니다.
enabled W&B를 활성화합니다.
init Weights & Biases 로 디렉토리를 구성합니다.
job W&B jobs를 관리하고 보기 위한 커맨드
launch W&B Job을 시작하거나 대기열에 넣습니다.
launch-agent W&B launch 에이전트 를 실행합니다.
launch-sweep W&B launch 스윕 을 실행합니다 (실험적).
login Weights & Biases 에 로그인합니다.
offline W&B 동기화를 비활성화합니다.
online W&B 동기화를 활성화합니다.
pull Weights & Biases 에서 파일을 가져옵니다.
restore run 에 대한 코드, 설정 및 docker 상태를 복원합니다.
scheduler W&B launch 스윕 스케줄러 를 실행합니다 (실험적).
server 로컬 W&B 서버 를 운영하기 위한 커맨드
status 구성 설정을 표시합니다.
sweep 하이퍼파라미터 스윕 을 초기화합니다.
sync 오프라인 트레이닝 디렉토리를 W&B에 업로드합니다.
verify 로컬 인스턴스를 확인합니다.

1 - wandb agent

사용법

wandb agent [OPTIONS] SWEEP_ID

요약

W&B 에이전트 실행

옵션

옵션 설명
-p, --project 스윕에서 생성된 W&B run이 전송될 프로젝트 이름입니다. 프로젝트가 지정되지 않은 경우, run은 ‘Uncategorized’라는 프로젝트로 전송됩니다.
-e, --entity 스윕에서 생성된 W&B run을 전송할 사용자 이름 또는 팀 이름입니다. 지정하는 엔티티가 이미 존재하는지 확인하십시오. 엔티티를 지정하지 않으면, run은 기본 엔티티 (일반적으로 사용자 이름)로 전송됩니다.
--count 이 에이전트의 최대 run 횟수입니다.

2 - wandb artifact

사용법

wandb artifact [OPTIONS] COMMAND [ARGS]...

요약

아티팩트와 상호 작용하기 위한 코맨드

옵션

옵션 설명

코맨드

코맨드 설명
cache 아티팩트 캐시와 상호 작용하기 위한 코맨드
get wandb에서 아티팩트를 다운로드합니다
ls wandb 프로젝트의 모든 아티팩트를 나열합니다
put wandb에 아티팩트를 업로드합니다

2.1 - wandb artifact cache

사용법

wandb artifact cache [OPTIONS] COMMAND [ARGS]...

요약

아티팩트 캐시와 상호 작용하기 위한 코맨드

옵션

옵션 설명

코맨드

코맨드 설명
cleanup 아티팩트 캐시에서 덜 자주 사용되는 파일을 정리합니다

2.1.1 - wandb artifact cache cleanup

사용법

wandb artifact cache cleanup [OPTIONS] TARGET_SIZE

요약

덜 자주 사용되는 파일을 Artifacts 캐시에서 정리합니다.

옵션

옵션 설명
--remove-temp / --no-remove-temp 임시 파일을 제거합니다.

2.2 - wandb artifact get

사용법

wandb artifact get [OPTIONS] PATH

요약

wandb에서 아티팩트 다운로드

옵션

옵션 설명
--root 아티팩트를 다운로드할 디렉토리
--type 다운로드할 아티팩트의 유형

2.3 - wandb artifact ls

사용법

wandb artifact ls [OPTIONS] PATH

요약

wandb 프로젝트의 모든 아티팩트 나열

옵션

옵션 설명
-t, --type 나열할 아티팩트의 유형

2.4 - wandb artifact put

사용법

wandb artifact put [OPTIONS] PATH

요약

아티팩트를 wandb에 업로드합니다.

옵션

옵션 설명
-n, --name 업로드할 아티팩트의 이름: 프로젝트/artifact_name
-d, --description 이 아티팩트에 대한 설명
-t, --type 아티팩트의 유형
-a, --alias 이 아티팩트에 적용할 에일리어스
--id 업로드할 run입니다.
--resume 현재 디렉토리에서 마지막 run을 재개합니다.
--skip_cache 아티팩트 파일을 업로드하는 동안 캐싱을 건너뜁니다.
--policy [mutable|immutable] 아티팩트 파일을 업로드하는 동안 스토리지 정책을 설정합니다.

3 - wandb beta

사용법

wandb beta [OPTIONS] COMMAND [ARGS]...

요약

wandb CLI 코맨드의 베타 버전입니다. wandb-core가 필요합니다.

옵션

옵션 설명

코맨드

코맨드 설명
sync 트레이닝 run을 W&B에 업로드합니다

3.1 - wandb beta sync

사용법

wandb beta sync [OPTIONS] WANDB_DIR

요약

트레이닝 run을 W&B에 업로드합니다.

옵션

옵션 설명
--id 업로드할 run입니다.
-p, --project 업로드할 project입니다.
-e, --entity 범위를 지정할 entity입니다.
--skip-console 콘솔 로그를 건너뜁니다.
--append run을 추가합니다.
-i, --include 포함할 glob입니다. 여러 번 사용할 수 있습니다.
-e, --exclude 제외할 glob입니다. 여러 번 사용할 수 있습니다.
--mark-synced / --no-mark-synced run을 동기화됨으로 표시합니다.
--skip-synced / --no-skip-synced 동기화된 run을 건너뜁니다.
--dry-run 아무것도 업로드하지 않고 dry run을 수행합니다.

4 - wandb controller

사용법

wandb controller [OPTIONS] SWEEP_ID

요약

W&B 로컬 스윕 컨트롤러를 실행합니다.

옵션

옵션 설명
--verbose 상세한 출력 표시

5 - wandb disabled

사용법

wandb disabled [OPTIONS]

요약

W&B를 비활성화합니다.

옵션

옵션 설명
--service W&B 서비스를 비활성화합니다 [기본값: True]

6 - wandb docker

사용법

wandb docker [OPTIONS] [DOCKER_RUN_ARGS]... [DOCKER_IMAGE]

요약

docker 컨테이너에서 코드를 실행합니다.

W&B docker를 사용하면 wandb가 구성되었는지 확인하면서 docker 이미지에서 코드를 실행할 수 있습니다. 이 명령어는 컨테이너에 WANDB_DOCKERWANDB_API_KEY 환경 변수를 추가하고 기본적으로 현재 디렉토리를 /app에 마운트합니다. 이미지 이름이 선언되기 전에 docker run에 추가될 추가 인수를 전달할 수 있습니다. 이미지가 전달되지 않은 경우 기본 이미지를 선택합니다.

images-public/tensorflow-1.12.0-notebook-cpu:v0.4.0 --jupyter wandb docker
wandb/deepo:keras-gpu --no-tty --cmd "python train.py --epochs=5" ```

기본적으로 wandb의 존재를 확인하고 없는 경우 설치하기 위해 진입점을 재정의합니다. `--jupyter` 플래그를 전달하면 jupyter가 설치되었는지 확인하고 8888 포트에서 jupyter lab을 시작합니다. 시스템에서 nvidia-docker를 감지하면 nvidia 런타임을 사용합니다. 기존 docker run 코맨드에 wandb가 환경 변수를 설정하도록 하려면 wandb docker-run 코맨드를 참조하세요.

**옵션**

| **옵션** | **설명** |
| :--- | :--- |
| `--nvidia / --no-nvidia` | nvidia 런타임을 사용합니다. nvidia-docker가 있는 경우 기본적으로 nvidia를 사용합니다. |
| `--digest` | 이미지 다이제스트를 출력하고 종료합니다. |
| `--jupyter / --no-jupyter` | 컨테이너에서 jupyter lab을 실행합니다. |
| `--dir` | 컨테이너에서 코드를 마운트할 디렉토리입니다. |
| `--no-dir` | 현재 디렉토리를 마운트하지 않습니다. |
| `--shell` | 컨테이너를 시작할 쉘입니다. |
| `--port` | jupyter를 바인딩할 호스트 포트입니다. |
| `--cmd` | 컨테이너에서 실행할 코맨드입니다. |
| `--no-tty` | tty 없이 코맨드를 실행합니다. |

7 - wandb docker-run

사용법

wandb docker-run [OPTIONS] [DOCKER_RUN_ARGS]...

요약

docker run을 래핑하고 WANDB_API_KEY 및 WANDB_DOCKER 환경 변수를 추가합니다.

이것은 또한 시스템에 nvidia-docker 실행 파일이 있고 –runtime이 설정되지 않은 경우 런타임을 nvidia로 설정합니다.

자세한 내용은 docker run --help를 참조하십시오.

옵션

옵션 설명

8 - wandb enabled

사용법

wandb enabled [OPTIONS]

요약

W&B를 활성화합니다.

옵션

옵션 설명
--service W&B 서비스 활성화 [기본값: True]

9 - wandb init

사용법

wandb init [OPTIONS]

요약

Weights & Biases 와 함께 디렉토리를 구성합니다.

옵션

옵션 설명
-p, --project 사용할 프로젝트입니다.
-e, --entity 프로젝트 범위를 지정할 엔티티입니다.
--reset 설정을 재설정합니다.
-m, --mode “online”, “offline” 또는 “disabled"가 될 수 있습니다. 기본값은 온라인입니다.

10 - wandb job

사용법

wandb job [OPTIONS] COMMAND [ARGS]...

요약

W&B job을 관리하고 보기 위한 코맨드

옵션

옵션 설명

코맨드

코맨드 설명
create wandb run 없이 소스에서 job을 생성합니다.
describe Launch job을 설명합니다.
list 프로젝트의 job을 나열합니다.

10.1 - wandb job create

사용법

wandb job create [OPTIONS] {git|code|image} PATH

요약

wandb run 없이 소스에서 job을 생성합니다.

job은 git, code 또는 image의 세 가지 유형일 수 있습니다.

git: 경로 또는 명시적으로 제공된 메인 Python 실행 파일을 가리키는 진입점이 있는 git 소스입니다. code: requirements.txt 파일이 포함된 코드 경로입니다. image: Docker 이미지입니다.

옵션

옵션 설명
-p, --project job을 나열하려는 Project입니다.
-e, --entity job이 속한 Entity입니다.
-n, --name job 이름
-d, --description job 설명
-a, --alias job의 에일리어스
--entry-point 실행 파일 및 진입점 파일을 포함한 스크립트의 진입점입니다. code 또는 repo job에 필요합니다. --build-context가 제공된 경우 진입점 코맨드의 경로는 빌드 컨텍스트를 기준으로 합니다.
-g, --git-hash git job의 소스로 사용할 커밋 참조
-r, --runtime job을 실행할 Python 런타임
-b, --build-context job 소스 코드의 루트에서 빌드 컨텍스트까지의 경로입니다. 제공된 경우 Dockerfile 및 진입점의 기본 경로로 사용됩니다.
--base-image job에 사용할 기본 이미지입니다. image job과 호환되지 않습니다.
--dockerfile job의 Dockerfile 경로입니다. --build-context가 제공된 경우 Dockerfile 경로는 빌드 컨텍스트를 기준으로 합니다.

10.2 - wandb job describe

사용법

wandb job describe [OPTIONS] JOB

요약

Launch job에 대해 설명합니다. entity/project/job-name:alias-or-version 형식으로 Launch job을 제공하세요.

옵션

옵션 설명

10.3 - wandb job list

사용법

wandb job list [OPTIONS]

요약

프로젝트의 jobs 목록을 표시합니다.

옵션

옵션 설명
-p, --project jobs 목록을 표시할 프로젝트입니다.
-e, --entity jobs이 속한 엔티티입니다.

11 - wandb launch

사용법

wandb launch [OPTIONS]

요약

W&B Job을 시작하거나 대기열에 추가합니다. https://wandb.me/launch를 참조하세요.

옵션

옵션 설명
-u, --uri (str) 시작할 로컬 경로 또는 Git 저장소 URI입니다. 제공된 경우 이 코맨드는 지정된 URI에서 Job을 생성합니다.
-j, --job (str) 시작할 Job의 이름입니다. 전달된 경우 Launch는 URI를 필요로 하지 않습니다.
--entry-point 프로젝트 내 진입점입니다. [기본값: main]. 진입점을 찾을 수 없는 경우, 지정된 이름으로 프로젝트 파일을 스크립트로 실행하려고 시도합니다. .py 파일은 ‘python’을 사용하여 실행하고, .sh 파일은 환경 변수 $SHELL에 지정된 기본 셸을 사용하여 실행합니다. 전달된 경우, 설정 파일을 사용하여 전달된 진입점 값을 덮어씁니다.
--build-context (str) 소스 코드 내 빌드 컨텍스트 경로입니다. 기본값은 소스 코드의 루트입니다. -u와만 호환됩니다.
--name run을 시작할 run 이름입니다. 지정하지 않으면 임의의 run 이름이 run을 시작하는 데 사용됩니다. 전달된 경우, 설정 파일을 사용하여 전달된 이름을 덮어씁니다.
-e, --entity (str) 새 run이 전송될 대상 Entity의 이름입니다. 기본적으로 로컬 wandb/settings 폴더에 의해 설정된 Entity를 사용합니다. 전달된 경우, 설정 파일을 사용하여 전달된 Entity 값을 덮어씁니다.
-p, --project (str) 새 run이 전송될 대상 Project의 이름입니다. 기본적으로 소스 URI에서 제공하는 Project 이름 또는 Github run의 경우 Git 저장소 이름을 사용합니다. 전달된 경우, 설정 파일을 사용하여 전달된 Project 값을 덮어씁니다.
-r, --resource run에 사용할 실행 리소스입니다. 지원되는 값: ’local-process’, ’local-container’, ‘kubernetes’, ‘sagemaker’, ‘gcp-vertex’ 입니다. 리소스 설정 없이 대기열에 푸시하는 경우 이제 필수 파라미터입니다. 전달된 경우, 설정 파일을 사용하여 전달된 리소스 값을 덮어씁니다.
-d, --docker-image 사용하려는 특정 Docker 이미지입니다. name:tag 형식입니다. 전달된 경우, 설정 파일을 사용하여 전달된 Docker 이미지 값을 덮어씁니다.
--base-image Job 코드를 실행할 Docker 이미지입니다. –docker-image와 호환되지 않습니다.
-c, --config Launch 설정을 전달할 JSON 파일(확장자가 ‘.json’이어야 함) 경로 또는 JSON 문자열입니다. Launch된 run이 구성되는 방식을 지정합니다.
-v, --set-var 허용 목록이 활성화된 대기열에 대한 템플릿 변수 값을 설정합니다. 키-값 쌍으로 지정합니다. 예: --set-var key1=value1 --set-var key2=value2
-q, --queue 푸시할 run 대기열의 이름입니다. 없는 경우 단일 run을 직접 시작합니다. 인수 없이 제공된 경우 (--queue), 기본적으로 ‘default’ 대기열로 설정됩니다. 그렇지 않고 이름이 제공된 경우, 지정된 run 대기열은 제공된 Project 및 Entity 하에 존재해야 합니다.
--async Job을 비동기적으로 실행하는 플래그입니다. 기본값은 false입니다. 즉, –async가 설정되지 않은 경우 wandb launch는 Job이 완료될 때까지 기다립니다. 이 옵션은 –queue와 호환되지 않습니다. 에이전트로 실행할 때 비동기 옵션은 wandb launch-agent에서 설정해야 합니다.
--resource-args 컴퓨팅 리소스에 리소스 인수로 전달될 JSON 파일(확장자가 ‘.json’이어야 함) 경로 또는 JSON 문자열입니다. 제공해야 하는 정확한 콘텐츠는 각 실행 백엔드마다 다릅니다. 이 파일의 레이아웃은 설명서를 참조하십시오.
--dockerfile Job을 빌드하는 데 사용되는 Dockerfile의 경로입니다 (Job의 루트를 기준으로).
`–priority [critical high

12 - wandb launch-agent

사용법

wandb launch-agent [OPTIONS]

요약

W&B Launch 에이전트를 실행합니다.

옵션

옵션 설명
-q, --queue 에이전트가 감시할 큐의 이름입니다. 다중 -q 플래그가 지원됩니다.
-e, --entity 사용할 엔티티입니다. 기본적으로 현재 로그인한 사용자입니다.
-l, --log-file 내부 에이전트 로그의 대상입니다. stdout의 경우 -를 사용하십시오. 기본적으로 모든 에이전트 로그는 wandb/ 하위 디렉토리 또는 WANDB_DIR (설정된 경우)의 debug.log로 이동합니다.
-j, --max-jobs 이 에이전트가 병렬로 실행할 수 있는 최대 Launch 작업 수입니다. 기본값은 1입니다. 상한이 없도록 -1로 설정합니다.
-c, --config 사용할 에이전트 구성 yaml 파일의 경로입니다.
-v, --verbose 자세한 출력을 표시합니다.

13 - wandb launch-sweep

사용법

wandb launch-sweep [OPTIONS] [CONFIG]

요약

W&B launch 스윕을 실행합니다 (실험적 기능).

옵션

옵션 설명
-q, --queue 스윕을 푸시할 큐의 이름
-p, --project 에이전트가 감시할 프로젝트 이름. 전달된 경우, 구성 파일을 사용하여 전달된 프로젝트 값을 덮어씁니다.
-e, --entity 사용할 엔티티. 기본적으로 현재 로그인한 사용자입니다.
-r, --resume_id 8자 스윕 ID를 전달하여 launch 스윕을 재개합니다. 큐가 필요합니다.
--prior_run 이 스윕에 추가할 기존 run의 ID

14 - wandb login

사용법

wandb login [OPTIONS] [KEY]...

요약

Weights & Biases 에 로그인합니다.

옵션

옵션 설명
--cloud 로컬 대신 클라우드에 로그인합니다.
--host, --base-url 특정 W&B 인스턴스에 로그인합니다.
--relogin 이미 로그인한 경우 강제로 다시 로그인합니다.
--anonymously 익명으로 로그인합니다.
--verify / --no-verify 로그인 자격 증명을 확인합니다.

15 - wandb offline

사용법

wandb offline [OPTIONS]

요약

W&B 동기화 비활성화

옵션

옵션 설명

16 - wandb online

사용법

wandb online [OPTIONS]

요약

W&B 동기화 활성화

옵션

옵션 설명

17 - wandb pull

사용법

wandb pull [OPTIONS] RUN

요약

Weights & Biases에서 파일 가져오기

옵션

옵션 설명
-p, --project 다운로드하려는 project입니다.
-e, --entity 목록의 범위를 지정할 entity입니다.

18 - wandb restore

사용법

wandb restore [OPTIONS] RUN

요약

run에 대한 코드, config, Docker 상태 복원

옵션

옵션 설명
--no-git Git 상태를 복원하지 않습니다.
--branch / --no-branch branch를 만들지 분리된 checkout을 할지 여부
-p, --project 업로드하려는 project입니다.
-e, --entity 목록의 범위를 지정할 entity입니다.

19 - wandb scheduler

사용법

wandb scheduler [OPTIONS] SWEEP_ID

요약

W&B Launch 스윕 스케줄러를 실행합니다 (실험적).

옵션

옵션 설명

20 - wandb server

사용법

wandb server [OPTIONS] COMMAND [ARGS]...

요약

로컬 W&B 서버를 운영하기 위한 코맨드

옵션

옵션 설명

코맨드

코맨드 설명
start 로컬 W&B 서버 시작
stop 로컬 W&B 서버 중지

20.1 - wandb server start

사용법

wandb server start [OPTIONS]

요약

로컬 W&B 서버 시작

옵션

옵션 설명
-p, --port W&B 서버를 바인딩할 호스트 포트
-e, --env wandb/local에 전달할 환경 변수
--daemon / --no-daemon 데몬 모드로 실행 여부

20.2 - wandb server stop

사용법

wandb server stop [OPTIONS]

요약

로컬 W&B 서버를 중지합니다.

옵션

옵션 설명

21 - wandb status

사용법

wandb status [OPTIONS]

요약

설정(configuration settings) 표시

옵션

옵션 설명
--settings / --no-settings 현재 설정(settings) 표시

22 - wandb sweep

사용법

wandb sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID

요약

하이퍼파라미터 스윕을 초기화합니다. 다양한 조합을 테스트하여 기계 학습 모델의 비용 함수를 최적화하는 하이퍼파라미터를 검색합니다.

옵션

옵션 설명
-p, --project 스윕에서 생성된 W&B run이 전송될 Project 이름입니다. Project 가 지정되지 않은 경우, run은 Uncategorized 라는 Project 로 전송됩니다.
-e, --entity 스윕에서 생성된 W&B run을 전송할 사용자 이름 또는 팀 이름입니다. 지정한 Entity 가 이미 존재하는지 확인하십시오. Entity 를 지정하지 않으면 run은 기본 Entity (일반적으로 사용자 이름)로 전송됩니다.
--controller 로컬 컨트롤러 실행
--verbose 자세한 출력 표시
--name 스윕의 이름입니다. 이름이 지정되지 않은 경우 스윕 ID가 사용됩니다.
--program 스윕 프로그램 설정
--update 보류 중인 스윕 업데이트
--stop 새 run 실행을 중지하고 현재 실행 중인 run이 완료되도록 스윕을 종료합니다.
--cancel 실행 중인 모든 run을 중단하고 새 run 실행을 중지하도록 스윕을 취소합니다.
--pause 새 run 실행을 일시적으로 중지하도록 스윕을 일시 중지합니다.
--resume 새 run 실행을 계속하도록 스윕을 재개합니다.
--prior_run 이 스윕에 추가할 기존 run의 ID

23 - wandb sync

사용법

wandb sync [OPTIONS] [PATH]...

요약

오프라인 트레이닝 디렉토리를 W&B에 업로드합니다.

옵션

옵션 설명
--id 업로드할 대상 run입니다.
-p, --project 업로드할 대상 프로젝트입니다.
-e, --entity 범위를 지정할 엔티티입니다.
--job_type 관련된 run들을 함께 그룹화하기 위한 run의 유형을 지정합니다.
--sync-tensorboard / --no-sync-tensorboard tfevent 파일을 wandb로 스트리밍합니다.
--include-globs 포함할 glob 목록 (쉼표로 구분)입니다.
--exclude-globs 제외할 glob 목록 (쉼표로 구분)입니다.
--include-online / --no-include-online 온라인 run을 포함합니다.
--include-offline / --no-include-offline 오프라인 run을 포함합니다.
--include-synced / --no-include-synced 동기화된 run을 포함합니다.
--mark-synced / --no-mark-synced run을 동기화됨으로 표시합니다.
--sync-all 모든 run을 동기화합니다.
--clean 동기화된 run을 삭제합니다.
--clean-old-hours 지정된 시간보다 먼저 생성된 run을 삭제합니다. –clean 플래그와 함께 사용해야 합니다.
--clean-force 확인 프롬프트 없이 삭제합니다.
--show 표시할 run의 수입니다.
--append run을 추가합니다.
--skip-console 콘솔 로그를 건너뜁니다.

24 - wandb verify

사용법

wandb verify [OPTIONS]

요약

로컬 인스턴스 확인

옵션

옵션 설명
--host 특정 W&B 인스턴스 테스트