메인 콘텐츠로 건너뛰기

View the source code

wandb에 의해 기록되는 계산 단위입니다. 일반적으로 이는 ML 실험입니다.
wandb.init()으로 run을 생성합니다:
어떤 프로세스에서든 최대 하나의 활성 wandb.Run만 존재하며, wandb.run으로 엑세스할 수 있습니다:
wandb.log로 기록하는 모든 내용은 해당 run으로 전송됩니다. 동일한 스크립트 또는 노트북에서 더 많은 run을 시작하려면 진행 중인 run을 완료해야 합니다. Run은 wandb.finish를 사용하거나 with 블록에서 사용하여 완료할 수 있습니다:
run 생성에 대한 자세한 내용은 wandb.init 문서를 참조하거나 wandb.init 가이드를 확인하세요. 분산 트레이닝에서 순위 0 프로세스에서 단일 run을 생성한 다음 해당 프로세스에서만 정보를 기록하거나, 각 프로세스에서 run을 생성하고 각 프로세스에서 별도로 기록한 다음 wandb.init에 대한 group 인수로 결과를 함께 그룹화할 수 있습니다. W&B를 사용한 분산 트레이닝에 대한 자세한 내용은 가이드를 확인하세요. 현재 wandb.Api에 병렬 Run 오브젝트가 있습니다. 결국 이 두 오브젝트는 병합될 것입니다.

메소드

alert

소스 보기
지정된 제목과 텍스트로 알림을 시작합니다.

define_metric

소스 보기
wandb.log()로 기록된 메트릭을 사용자 정의합니다.

detach

소스 보기

display

소스 보기
이 run을 jupyter에서 표시합니다.

finish

소스 보기
run을 완료하고 남은 데이터를 업로드합니다. W&B run의 완료를 표시하고 모든 데이터가 서버에 동기화되도록 합니다. run의 최종 상태는 종료 조건 및 동기화 상태에 따라 결정됩니다.

Run 상태:

  • Running: 데이터를 기록하거나 하트비트를 보내는 활성 run입니다.
  • Crashed: 예기치 않게 하트비트 전송을 중단한 run입니다.
  • Finished: 모든 데이터가 동기화된 상태로 성공적으로 완료된 run입니다(exit_code=0).
  • Failed: 오류가 발생하여 완료된 run입니다(exit_code!=0).

finish_artifact

소스 보기
run의 출력으로 아직 완료되지 않은 아티팩트를 완료합니다. 동일한 분산 ID를 사용한 후속 “업서트”는 새 버전을 생성합니다.

get_project_url

소스 보기
run과 관련된 W&B 프로젝트의 URL을 반환합니다(있는 경우). 오프라인 run에는 프로젝트 URL이 없습니다.

get_sweep_url

소스 보기
run과 관련된 스윕의 URL을 반환합니다(있는 경우).

get_url

소스 보기
W&B run의 URL을 반환합니다(있는 경우). 오프라인 run에는 URL이 없습니다.

join

소스 보기
finish()의 더 이상 사용되지 않는 에일리어스입니다. 대신 finish를 사용하세요. 소스 보기
지정된 아티팩트를 포트폴리오(승격된 아티팩트 모음)에 연결합니다. 연결된 아티팩트는 지정된 포트폴리오의 UI에 표시됩니다. 소스 보기
모델 아티팩트 버전을 기록하고 모델 레지스트리의 등록된 모델에 연결합니다. 연결된 모델 버전은 지정된 등록된 모델의 UI에 표시됩니다.

단계:

  • ‘name’ 모델 아티팩트가 기록되었는지 확인합니다. 그렇다면 ‘path’에 있는 파일과 일치하는 아티팩트 버전을 사용하거나 새 버전을 기록합니다. 그렇지 않으면 ‘path’ 아래의 파일을 ‘model’ 유형의 새 모델 아티팩트 ‘name’으로 기록합니다.
  • 이름이 ‘registered_model_name’인 등록된 모델이 ‘model-registry’ 프로젝트에 있는지 확인합니다. 그렇지 않으면 이름이 ‘registered_model_name’인 새 등록된 모델을 만듭니다.
  • 모델 아티팩트 ‘name’ 버전을 등록된 모델 ‘registered_model_name’에 연결합니다.
  • ‘aliases’ 목록에서 에일리어스를 새로 연결된 모델 아티팩트 버전에 연결합니다.

예:

잘못된 사용법

log

소스 보기
run 데이터를 업로드합니다. log를 사용하여 스칼라, 이미지, 비디오, 히스토그램, 플롯 및 테이블과 같은 run 데이터를 기록합니다. 라이브 예제, 코드 조각, 모범 사례 등에 대한 로깅 가이드를 참조하세요. 가장 기본적인 사용법은 run.log({"train-loss": 0.5, "accuracy": 0.9})입니다. 이렇게 하면 손실 및 정확도가 run의 기록에 저장되고 이러한 메트릭에 대한 summary 값이 업데이트됩니다. wandb.ai의 워크스페이스 또는 W&B 앱의 자체 호스팅 인스턴스에서 기록된 데이터를 시각화하거나, API를 사용하여 로컬에서 시각화하고 탐색할 데이터를 내보냅니다(예: Jupyter 노트북). 기록된 값은 스칼라일 필요가 없습니다. 모든 wandb 오브젝트의 로깅이 지원됩니다. 예를 들어 run.log({"example": wandb.Image("myimage.jpg")})는 W&B UI에 멋지게 표시될 예제 이미지를 기록합니다. 지원되는 모든 유형에 대한 참조 문서를 참조하거나 3D 분자 구조 및 분할 마스크에서 PR 곡선 및 히스토그램에 이르기까지 예제에 대한 로깅 가이드를 확인하세요. wandb.Table을 사용하여 구조화된 데이터를 기록할 수 있습니다. 자세한 내용은 테이블 로깅 가이드를 참조하세요. W&B UI는 이름에 슬래시(/)가 있는 메트릭을 최종 슬래시 앞의 텍스트를 사용하여 명명된 섹션으로 구성합니다. 예를 들어, 다음은 “train” 및 “validate”라는 두 개의 섹션을 생성합니다.
한 수준의 중첩만 지원됩니다. run.log({"a/b/c": 1})는 “a/b”라는 이름의 섹션을 생성합니다. run.log는 초당 몇 번 이상 호출하도록 설계되지 않았습니다. 최적의 성능을 위해 로깅을 N번 반복할 때마다 한 번으로 제한하거나 여러 반복에 걸쳐 데이터를 수집하고 단일 단계로 기록합니다.

W&B 단계

기본 사용법에서 log를 호출할 때마다 새 “단계”가 생성됩니다. 단계는 항상 증가해야 하며 이전 단계에 기록하는 것은 불가능합니다. 차트에서 모든 메트릭을 X축으로 사용할 수 있습니다. 많은 경우 W&B 단계를 트레이닝 단계가 아닌 타임스탬프로 취급하는 것이 좋습니다.
define_metric도 참조하세요. 여러 log 호출을 사용하여 stepcommit 파라미터로 동일한 단계에 기록할 수 있습니다. 다음은 모두 동일합니다.

예:

자세한 내용은 로깅 가이드를 참조하세요.

기본 사용법

증분 로깅

히스토그램

numpy에서 이미지

PIL에서 이미지

numpy에서 비디오

Matplotlib 플롯

PR 곡선

3D 오브젝트

log_artifact

소스 보기
아티팩트를 run의 출력으로 선언합니다.

log_code

소스 보기
코드의 현재 상태를 W&B Artifact에 저장합니다. 기본적으로 현재 디렉토리를 탐색하고 .py로 끝나는 모든 파일을 기록합니다.

예:

기본 사용법
고급 사용법

log_model

소스 보기
‘path’ 내부의 콘텐츠를 포함하는 모델 아티팩트를 run에 기록하고 이 run에 대한 출력으로 표시합니다.

예:

잘못된 사용법

mark_preempting

소스 보기
이 run을 선점하는 것으로 표시합니다. 또한 내부 프로세스에 이를 즉시 서버에 보고하도록 지시합니다.

project_name

소스 보기

restore

소스 보기
클라우드 스토리지에서 지정된 파일을 다운로드합니다. 파일은 현재 디렉토리 또는 run 디렉토리에 배치됩니다. 기본적으로 파일이 아직 존재하지 않는 경우에만 다운로드합니다.

save

소스 보기
하나 이상의 파일을 W&B에 동기화합니다. 상대 경로는 현재 작업 디렉토리를 기준으로 합니다. “myfiles/*“와 같은 Unix glob은 policy에 관계없이 save가 호출될 때 확장됩니다. 특히 새 파일은 자동으로 선택되지 않습니다. base_path는 업로드된 파일의 디렉토리 구조를 제어하기 위해 제공될 수 있습니다. glob_str의 접두사여야 하며 그 아래의 디렉토리 구조가 유지됩니다. 다음 예를 통해 가장 잘 이해할 수 있습니다.
참고: 절대 경로 또는 glob이 제공되고 base_path가 없는 경우 위 예제와 같이 한 디렉토리 수준이 유지됩니다.

status

소스 보기
내부 백엔드에서 현재 run의 동기화 상태에 대한 동기화 정보를 가져옵니다.

to_html

소스 보기
현재 run을 표시하는 iframe을 포함하는 HTML을 생성합니다.

unwatch

소스 보기
pytorch 모델 토폴로지, 그레이디언트 및 파라미터 훅을 제거합니다.

upsert_artifact

소스 보기
run의 출력으로 아직 완료되지 않은 아티팩트를 선언하거나 추가합니다. 아티팩트를 완료하려면 run.finish_artifact()를 호출해야 합니다. 이는 분산 작업이 모두 동일한 아티팩트에 기여해야 하는 경우에 유용합니다.

use_artifact

소스 보기
아티팩트를 run의 입력으로 선언합니다. 반환된 오브젝트에서 download 또는 file을 호출하여 콘텐츠를 로컬로 가져옵니다.

use_model

소스 보기
모델 아티팩트 ‘name’에 기록된 파일을 다운로드합니다.

예:

잘못된 사용법

watch

소스 보기
지정된 PyTorch 모델에 훅을 연결하여 그레이디언트 및 모델의 계산 그래프를 모니터링합니다. 이 함수는 트레이닝 중에 파라미터, 그레이디언트 또는 둘 다를 추적할 수 있습니다. 향후 임의의 기계 학습 모델을 지원하도록 확장해야 합니다.

__enter__

소스 보기

__exit__

소스 보기