Run

wandb에서 기록된 계산 단위입니다. 일반적으로 이는 ML 실험입니다.

Run(
    settings: Settings,
    config: Optional[Dict[str, Any]] = None,
    sweep_config: Optional[Dict[str, Any]] = None,
    launch_config: Optional[Dict[str, Any]] = None
) -> None

wandb.init()으로 run을 생성합니다:

import wandb

run = wandb.init()

어떤 프로세스에도 항상 최대 하나의 활성 wandb.Run이 있으며, wandb.run으로 접근할 수 있습니다:

import wandb

assert wandb.run is None

wandb.init()

assert wandb.run is not None

wandb.log로 기록하는 모든 것은 해당 run으로 전송됩니다.

동일한 스크립트나 노트북에서 더 많은 run을 시작하려면, 실행 중인 run을 종료해야 합니다. Run은 wandb.finish를 사용하거나 with 블록에서 사용하여 종료할 수 있습니다:

import wandb

wandb.init()
wandb.finish()

assert wandb.run is None

with wandb.init() as run:
    pass  # 여기에 데이터 기록

assert wandb.run is None

run을 생성하는 방법에 대한 자세한 내용은 wandb.init 문서를 참조하거나 wandb.init에 대한 가이드를 확인하세요.

분산 트레이닝에서는 rank 0 프로세스에서 단일 run을 생성한 다음 해당 프로세스에서만 정보를 기록하거나, 각 프로세스에서 run을 생성하여 각각 별도로 기록하고 wandb.init의 group 인수를 사용하여 결과를 그룹화할 수 있습니다. W&B와 함께 분산 트레이닝에 대한 자세한 내용은 가이드를 확인하세요.

현재, wandb.Api에는 병렬 Run 오브젝트가 있습니다. 결국 이 두 오브젝트는 병합될 것입니다.

속성
`summary`	각 `wandb.log()` 키에 대해 설정된 단일 값입니다. 기본적으로 summary는 기록된 마지막 값으로 설정됩니다. 최종 값 대신 최고 값, 예를 들어 최대 정확도와 같은 최고의 값으로 summary를 수동으로 설정할 수 있습니다.
`config`	이 run과 관련된 설정 오브젝트입니다.
`dir`	run과 관련된 파일이 저장되는 디렉토리입니다.
`entity`	run과 관련된 W&B 엔티티의 이름입니다. 엔티티는 사용자 이름이거나 팀 또는 조직의 이름일 수 있습니다.
`group`	run과 관련된 그룹의 이름입니다. 그룹을 설정하면 W&B UI가 run을 합리적인 방식으로 구성하는 데 도움이 됩니다. 분산 트레이닝을 수행하는 경우 트레이닝의 모든 run에 동일한 그룹을 지정해야 합니다. 교차 검증을 수행하는 경우 모든 교차 검증 폴드에 동일한 그룹을 지정해야 합니다.
`id`	이 run의 식별자입니다.
`mode`	`0.9.x` 및 이전 버전과의 호환성을 위해 최종적으로 폐지됩니다.
`name`	run의 표시 이름입니다. 표시 이름은 고유하지 않을 수 있으며 설명적일 수 있습니다. 기본적으로 무작위로 생성됩니다.
`notes`	run과 관련된 노트가 있는 경우입니다. 노트는 다줄 문자열일 수 있으며 `$$` 안에 마크다운 및 라텍스 방정식을 사용할 수도 있습니다, 예를 들어 $x + 3$ .
`path`	run의 경로입니다. Run 경로에는 엔티티, 프로젝트 및 run ID가 포함되며, 형식은 `entity/project/run_id`입니다.
`project`	run과 관련된 W&B 프로젝트의 이름입니다.
`resumed`	run이 재개되었는지 여부입니다.
`settings`	run의 설정 오브젝트의 동결된 복사본입니다.
`start_time`	run이 시작된 시간의 유닉스 타임스탬프(초)입니다.
`starting_step`	run의 첫 번째 단계입니다.
`step`	현재 단계의 값입니다. 이 카운터는 `wandb.log`에 의해 증가됩니다.
`sweep_id`	run과 관련된 스윕의 ID입니다(있는 경우).
`tags`	run과 관련된 태그가 있는 경우입니다.
`url`	run과 관련된 W&B URL입니다.

인수
`title`	(str) 알림의 제목이며, 64자를 초과할 수 없습니다.
`text`	(str) 알림의 본문 텍스트입니다.
`level`	(str 또는 wandb.AlertLevel, 선택 사항) 사용할 알림 수준이며, `INFO`, `WARN`, 또는 `ERROR` 중 하나입니다.
`wait_duration`	(int, float, 또는 timedelta, 선택 사항) 이 제목으로 다른 알림을 보내기 전에 기다릴 시간(초)입니다.

인수
`name`	메트릭의 이름입니다.
`step_metric`	메트릭과 관련된 독립 변수입니다.
`step_sync`	필요한 경우 자동으로 `step_metric`을 기록에 추가합니다. step_metric이 지정된 경우 기본값은 True입니다.
`hidden`	이 메트릭을 자동 플롯에서 숨깁니다.
`summary`	요약에 추가될 집계 메트릭을 지정합니다. 지원되는 집계: "min,max,mean,best,last,none" 기본 집계는 `copy`입니다. 집계 `best`는 기본적으로 `goal`이 `minimize`일 때 적용됩니다.
`goal`	메트릭을 최적화하는 방향을 지정합니다. 지원되는 방향: "minimize,maximize"

인수
`exit_code`	0이 아닌 것으로 설정하여 run을 실패로 표시합니다
`quiet`	로그 출력을 최소화하려면 true로 설정하세요

인수
`artifact_or_path`	(str 또는 Artifact) 이 아티팩트의 내용에 대한 경로로, 다음 형식 중 하나일 수 있습니다: - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path` `wandb.Artifact`를 호출하여 생성된 Artifact 오브젝트도 전달할 수 있습니다.
`name`	(str, 선택 사항) 아티팩트의 이름입니다. 엔티티/프로젝트로 접두사를 붙일 수 있습니다. 유효한 이름은 다음 형식 중 하나일 수 있습니다: - name:version - name:alias - digest 지정하지 않으면 기본적으로 현재 run ID로 시작하는 경로의 기본 이름이 사용됩니다.
`type`	(str) 기록할 아티팩트의 유형입니다. 예를 들어 `dataset`, `model`과 같은 예가 있습니다.
`aliases`	(list, 선택 사항) 이 아티팩트에 적용할 별칭으로, 기본값은 `["latest"]`입니다.
`distributed_id`	(string, 선택 사항) 모든 분산 작업이 공유하는 고유 문자열입니다. None인 경우 기본값은 run의 그룹 이름입니다.

인수
`artifact`	연결될 (공개 또는 로컬) 아티팩트입니다.
`target_path`	`str` - 다음 형식을 취합니다: {portfolio}, {project}/{portfolio}, 또는 {entity}/{project}/{portfolio}
`aliases`	`List[str]` - 이 포트폴리오 내에서 연결된 아티팩트에만 적용될 선택적 별칭입니다. "latest" 별칭은 항상 연결된 아티팩트의 최신 버전에 적용됩니다.

발생할 수 있는 오류
`wandb.Error`	`wandb.init` 호출 전에 사용된 경우
`ValueError`	잘못된 데이터가 전달된 경우

인수
`artifact_or_path`	(str 또는 Artifact) 이 아티팩트의 내용에 대한 경로, 다음 형식 중 하나일 수 있습니다: - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path` `wandb.Artifact`를 호출하여 생성된 Artifact 오브젝트도 전달할 수 있습니다.
`name`	(str, 선택사항) 아티팩트 이름. entity/project로 접두사가 붙을 수 있습니다. 유효한 이름 형식은 다음과 같습니다: - name:version - name:alias - digest 지정하지 않은 경우 경로의 기본 이름에 현재 run id를 접두사로 붙입니다.
`type`	(str) 로그하는 아티팩트의 유형, 예를 들어 `dataset`, `model`
`aliases`	(list, 선택사항) 이 아티팩트에 적용할 에일리어스, 기본값은 `["latest"]`

인수
`root`	코드를 재귀적으로 찾을 상대적(대 `os.getcwd()`) 또는 절대 경로.
`name`	(str, 선택사항) 코드 아티팩트의 이름. 기본적으로, 아티팩트 이름은 `source-$PROJECT_ID-$ENTRYPOINT_RELPATH`로 지정됩니다. 여러 run이 동일한 아티팩트를 공유하고자 하는 시나리오에서 이름을 지정하면 그것을 달성할 수 있습니다.
`include_fn`	파일 경로와 (선택적으로) 루트 경로를 받아서 포함해야 할 경우 True를, 그렇지 않을 경우 False를 반환하는 callable입니다. 기본값은: `lambda path, root: path.endswith(".py")`
`exclude_fn`	파일 경로와 (선택적으로) 루트 경로를 받아서 제외해야 할 경우 True를, 그렇지 않을 경우 False를 반환하는 callable입니다. 기본값은 `<root>/.wandb/` 및 `<root>/wandb/` 디렉토리 내의 모든 파일을 제외하는 함수입니다.

인수
`path`	(str) 이 모델의 내용에 대한 경로, 다음 형식 중 하나일 수 있습니다: - `/local/directory` - `/local/directory/file.txt` - `s3://bucket/path`
`name`	(str, 선택사항) 파일 내용이 추가될 모델 아티팩트에 할당할 이름. 문자열에는 다음 알파뉴메릭 문자만 포함될 수 있습니다: 대시, 밑줄, 점. 지정하지 않은 경우 경로의 기본 이름에 현재 run id를 접두사로 붙입니다.
`aliases`	(list, 선택사항) 생성된 모델 아티팩트에 적용할 에일리어스, 기본값은 `["latest"]`

인수
`vega_spec_name`	플롯에 대한 스펙의 이름
`data_table`	시각화에 사용될 데이터를 포함하는 wandb.Table 오브젝트
`fields`	사용자 지정 시각화에 필요한 필드로부터 테이블 키를 매핑하는 딕셔너리
`string_fields`	사용자 지정 시각화에 필요한 모든 문자열 상수에 대한 값을 제공하는 딕셔너리

인수
`name`	파일의 이름
`run_path`	파일을 가져올 run의 선택적 경로, 즉 `username/project_name/run_id` `wandb.init`이 호출되지 않은 경우 이는 필수입니다.
`replace`	이미 로컬에 존재하는 파일이라도 다운로드할지 여부
`root`	파일을 다운로드할 디렉토리. 기본값은 현재 디렉토리 또는 `wandb.init`이 호출된 경우 run 디렉토리입니다.

인수
`glob_str`	(문자열) 유닉스 글롭 또는 정규 경로에 대한 상대적 또는 절대 경로. 지정되지 않은 경우 이 메소드는 아무 작업도 수행하지 않습니다.
`base_path`	글롭을 실행할 기본 경로
`policy`	(문자열) `live`, `now`, `end` 중 하나 - live: 파일이 변경될 때마다 이전 버전을 덮어쓰면서 업로드 - now: 지금 한 번 업로드 - end: run이 끝날 때만 파일 업로드

발생할 수 있는 오류
`wandb.CommError`	wandb 백엔드에 연결할 수 없는 경우
`ValueError`	파일을 찾을 수 없거나 run_path를 찾을 수 없는 경우

Run

메소드​

alert​

define_metric​

detach​

display​

finish​

finish_artifact​

get_project_url​

get_sweep_url​

get_url​

join​

link_artifact​

link_model​

Matplotlib 플롯​

PR 커브​

3D 오브젝트​

log_artifact​

log_code​

예시:​

log_model​

예시:​

mark_preempting​

plot_table​

project_name​

restore​

save​

status​

to_html​

unwatch​

upsert_artifact​

use_artifact​

메소드

`alert`

`define_metric`

`detach`

`display`

`finish`

`finish_artifact`

`get_project_url`

`get_sweep_url`

`get_url`

`join`

`link_artifact`

`link_model`

Matplotlib 플롯

PR 커브

3D 오브젝트

`log_artifact`

`log_code`

예시:

`log_model`

예시:

`mark_preempting`

`plot_table`

`project_name`

`restore`

`save`

`status`

`to_html`

`unwatch`

`upsert_artifact`

`use_artifact`