함수 wandb.init()
W&B에 추적하고 로깅하기 위해 새 run을 시작합니다. ML 트레이닝 파이프라인에서 트레이닝 스크립트뿐만 아니라 평가 스크립트의 시작 부분에도wandb.init()을 추가할 수 있으며, 각 부분은 W&B에서 run으로 추적됩니다.
wandb.init()은 데이터를 run에 로깅하기 위해 새 백그라운드 프로세스를 생성하며, 기본적으로 데이터를 https://wandb.ai 에 동기화하므로 결과를 실시간으로 확인할 수 있습니다. 데이터 로깅을 완료하면 run.finish()를 호출하여 run을 종료하거나, run을 컨텍스트 관리자로 사용하여 자동으로 호출되도록 하십시오:
with wandb.init() as run:
… # 블록 끝에서 run.finish()가 실행됩니다.
run.finish()를 호출하지 않으면 스크립트가 종료될 때 run이 종료됩니다.
Run ID에는 다음 특수 문자 / \ # ? % :가 포함되어서는 안 됩니다.
인수
str | None
run을 로깅할 사용자 이름 또는 팀 이름입니다. entity는 이미 존재해야 하므로 run 로깅을 시작하기 전에 UI에서 계정이나 팀을 생성하세요. 지정하지 않으면 run에 기본 entity가 사용됩니다. 기본 entity를 변경하려면 설정으로 이동하여 “기본 팀” 아래의 “새 프로젝트를 생성할 기본 위치”를 업데이트하세요.
str | None
이 run을 로깅할 프로젝트의 이름입니다. 지정하지 않으면 Git 루트나 현재 프로그램 파일을 확인하는 등의 휴리스틱을 사용하여 시스템을 기반으로 프로젝트 이름을 추론합니다. 프로젝트 이름을 추론할 수 없으면 프로젝트는 기본적으로
"uncategorized"가 됩니다.StrPath | None
실험 로그와 메타데이터 파일을 저장할 디렉터리의 절대 경로입니다. 지정하지 않으면 기본적으로
./wandb 디렉터리가 사용됩니다. 이는 download()를 호출할 때 아티팩트가 저장되는 위치에는 영향을 주지 않습니다.str | None
재개에 사용되는 이 run의 고유 식별자입니다. 프로젝트 내에서 고유해야 하며 run이 삭제되면 재사용할 수 없습니다. 짧은 설명용 이름에는
name 필드를 사용하고, run 간 비교를 위해 하이퍼파라미터를 저장하려면 config를 사용하세요.str | None
이 run을 파악하기 쉽도록 UI에 표시되는 짧은 표시 이름입니다. 기본적으로 table과 차트 간에 run을 쉽게 대조할 수 있도록 두 단어로 구성된 무작위 이름을 생성합니다. run 이름을 짧게 유지하면 차트 범례와 table의 가독성이 높아집니다. 하이퍼파라미터를 저장하려면
config 필드를 사용하는 것이 좋습니다.str | None
Git의 커밋 메시지와 유사한 run의 상세 설명입니다. 이 인수를 사용하여 나중에 이 run의 목적이나 설정을 떠올리는 데 도움이 될 맥락이나 세부 정보를 캡처하세요.
Sequence[str] | None
UI에서 이 run에 레이블을 지정할 태그 목록입니다. 태그는 run을 정리하거나 “베이스라인” 또는 “프로덕션”과 같은 임시 식별자를 추가하는 데 유용합니다. UI에서 태그를 쉽게 추가하거나 제거하고 태그별로 필터링할 수 있습니다. run을 재개하는 경우 여기에 제공된 태그가 기존 태그를 대체합니다. 현재 태그를 덮어쓰지 않고 재개된 run에 태그를 추가하려면
run = wandb.init()를 호출한 후 run.tags += ("new_tag",)를 사용하세요.dict[str, Any] | str | None
모델 하이퍼파라미터나 데이터 전처리 설정 등 run의 입력 매개변수를 저장하는 딕셔너리형 객체인
wandb.config를 설정합니다. 설정은 UI의 개요 페이지에 표시되며, 이러한 매개변수를 기준으로 run을 그룹화하고 필터링하고 정렬할 수 있습니다. 키에는 마침표(.)가 포함되어서는 안 되며, 값의 크기는 10 MB 미만이어야 합니다. 딕셔너리, argparse.Namespace 또는 absl.flags.FLAGS를 제공하면 키-값 쌍이 wandb.config에 직접 로드됩니다. 문자열을 제공하면 YAML 파일 경로로 해석되며, 해당 파일의 설정 값이 wandb.config에 로드됩니다.list[str] | None
wandb.config에서 제외할 특정 키 목록입니다.list[str] | None
wandb.config에 포함할 특정 키 목록입니다.bool | None
설정 값을 최초 설정 이후에 수정할 수 있는지 제어합니다. 기본적으로 설정 값을 덮어쓰면 예외가 발생합니다. 학습률처럼 트레이닝 중에 변경되는 변수를 추적하려면 대신
wandb.log() 사용을 고려하세요. 기본값은 스크립트에서는 False이고 노트북 환경에서는 True입니다.str | None
개별 run을 더 큰 실험의 일부로 정리하려면 그룹 이름을 지정하세요. 교차 검증이나 서로 다른 테스트 세트에서 모델을 트레이닝하고 평가하는 여러 작업을 실행하는 경우에 유용합니다. 그룹화를 사용하면 UI에서 관련 run을 한꺼번에 관리할 수 있으므로, 하나의 통합된 실험으로 결과를 쉽게 표시/숨기기하고 검토할 수 있습니다.
str | None
run의 유형을 지정합니다. 특히 더 큰 실험의 일부로 그룹 내에서 run을 정리할 때 유용합니다. 예를 들어, 그룹 내에서 “train” 및 “eval”과 같은 작업 유형으로 run에 레이블을 지정할 수 있습니다. 작업 유형을 정의하면 UI에서 유사한 run을 쉽게 필터링하고 그룹화하여 직접 비교할 수 있습니다.
Literal['online', 'offline', 'disabled', 'shared'] | None
run 데이터가 관리되는 방식을 지정하며, 다음 옵션이 있습니다:
"online"(기본값): 네트워크 연결이 가능할 때 W&B와 실시간 동기화를 활성화하고, 시각화에 대한 실시간 업데이트를 제공합니다."offline": 에어갭 또는 오프라인 환경에 적합하며, 데이터는 로컬에 저장되고 나중에 동기화할 수 있습니다. 향후 동기화를 위해 run 폴더를 보존해야 합니다."disabled": 모든 W&B 기능을 비활성화하여 run의 메서드를 no-ops로 만듭니다. 일반적으로 테스트에서 W&B 오퍼레이션을 우회하는 데 사용됩니다."shared": (이 기능은 experimental입니다). 여러 프로세스(서로 다른 머신에 있을 수 있음)가 동시에 동일한 run에 로깅할 수 있도록 허용합니다. 이 접근 방식에서는 primary node와 하나 이상의 워커 노드를 사용하여 동일한 run에 데이터를 로깅합니다. primary node 내에서 run을 초기화합니다. 각 워커 노드의 경우 primary node에서 사용한 run ID를 사용하여 run을 초기화합니다.
bool | None
W&B 로그인이 스크립트 실행에 필요한지 확인합니다.
True이면 사용자가 W&B에 로그인해야 하며, 그렇지 않으면 스크립트가 진행되지 않습니다. False(기본값)인 경우 로그인 없이 스크립트를 진행할 수 있으며, 사용자가 로그인하지 않은 경우 offline mode로 전환됩니다.bool | Literal[None, 'default', 'return_previous', 'finish_previous', 'create_new']
“reinit” 설정의 단축형입니다. run이 active일 때
wandb.init()의 동작을 확인합니다."default": 노트북에서는 “finish_previous”를 사용하고, 그렇지 않은 경우 “return_previous”를 사용합니다."return_previous": 아직 완료되지 않은 가장 최근에 생성된 run을 반환합니다.wandb.run을 업데이트하지 않습니다. “create_new” 옵션을 참조하세요."finish_previous": 모든 active run을 종료한 후 새 run을 반환합니다."create_new": 다른 active run을 수정하지 않고 새 run을 생성합니다.wandb.run및wandb.log와 같은 최상위 함수를 업데이트하지 않습니다. 이로 인해 전역 run에 의존하는 일부 이전 인테그레이션이 작동하지 않을 수 있습니다.
bool | Literal['allow', 'never', 'must', 'auto'] | None
지정된
id로 run을 재개할 때의 동작을 제어합니다. 사용 가능한 옵션은 다음과 같습니다:"allow": 지정된id의 run이 존재하면 마지막 step에서 재개합니다. 그렇지 않으면 새 run이 생성됩니다."never": 지정된id의 run이 존재하면 오류가 발생합니다. 해당 run을 찾을 수 없으면 새 run이 생성됩니다."must": 지정된id의 run이 존재하면 마지막 step에서 재개합니다. run을 찾을 수 없으면 오류가 발생합니다."auto": 이 머신에서 crash된 경우 이전 run을 자동으로 재개합니다. 그렇지 않으면 새 run을 시작합니다.True: 사용 중단. 대신"auto"를 사용하세요.False: 사용 중단. 기본 동작(resume을 설정하지 않은 상태로 두기)을 사용하여 항상 새 run을 시작하세요.resume이 설정된 경우fork_from및resume_from을 사용할 수 없습니다.resume이 설정되지 않은 경우 시스템은 항상 새 run을 시작합니다.
str | None
{run_id}?_step={step} 형식으로 이전 run의 특정 시점을 지정하여 run을 재개합니다. 이를 통해 run에 로깅된 이력을 중간 step에서 잘라내고 해당 step부터 로깅을 재개할 수 있습니다. 대상 run은 동일한 프로젝트에 있어야 합니다. id 인수도 제공된 경우 resume_from 인수가 우선합니다. resume, resume_from 및 fork_from은 함께 사용할 수 없으며, 한 번에 하나만 사용할 수 있습니다. 이 기능은 베타 버전이며 향후 변경될 수 있습니다.str | None
이전 run의 특정 지점을 지정하여 새 run을 포크합니다. 형식은
{id}?_step={step}입니다. 이렇게 하면 대상 run의 이력에서 지정된 step부터 로깅을 재개하는 새 run이 생성됩니다. 대상 run은 현재 프로젝트의 일부여야 합니다. id 인수도 제공된 경우 fork_from 인수와 달라야 하며, 동일한 경우 오류가 발생합니다. resume, resume_from, fork_from은 함께 사용할 수 없으며, 한 번에 하나만 사용할 수 있습니다. 이 기능은 베타 버전이며 향후 변경될 수 있습니다.bool | None
W&B에 메인 스크립트 또는 노트북을 저장할 수 있게 하여 실험 재현성을 돕고 UI에서 run 간 코드 비교를 허용합니다. 기본적으로 비활성화되어 있지만, 설정 페이지에서 기본값을 변경하여 활성화할 수 있습니다.
bool | None
사용 중단. 대신
sync_tensorboard를 사용하세요.bool | None
TensorBoard 또는 TensorBoardX에서 W&B 로그를 자동으로 동기화하여 W&B UI에서 볼 수 있도록 관련 이벤트 파일을 저장합니다.
bool | None
OpenAI Gym 사용 시 환경 비디오를 자동으로 로깅합니다.
Settings | dict[str, Any] | None
run에 대한 고급 설정이 포함된 딕셔너리 또는
wandb.Settings 객체를 지정합니다.DoNotSet
설명이 제공되지 않았습니다.
반환값
Run 객체.
예외
Error: run 초기화 중 알 수 없거나 내부 오류가 발생한 경우.AuthenticationError: 사용자가 유효한 자격 증명을 제공하지 못한 경우.CommError: wandb server와 통신하는 데 문제가 발생한 경우.UsageError: 사용자가 유효하지 않은 인수를 제공한 경우.KeyboardInterrupt: 사용자가 run을 중단한 경우.
예시
wandb.init()은 Run 객체를 반환합니다. run 객체를 사용하여 데이터를 로깅하고,
아티팩트를 저장하고, run 라이프사이클을 관리하세요.