View the source code
예시:
가장 일반적인 초기화 방법| ARG | |
|---|---|
| overrides | (사전) https://api.wandb.ai가 아닌 wandb 서버를 사용하는 경우base_url을 설정할 수 있습니다.entity,project및run에 대한 기본값을 설정할 수도 있습니다. | 
| 속성 | 
|---|
메소드
artifact
소스 보기
project/name 또는 entity/project/name 형식으로 경로를 파싱하여 단일 아티팩트를 반환합니다.
| ARG | |
|---|---|
| name | (str) 아티팩트 이름입니다. project/ 또는 entity/project/로 시작할 수 있습니다. 이름에 entity가 지정되지 않은 경우 Run 또는 API 설정의 entity가 사용됩니다. 유효한 이름은 name:version name:alias 형식일 수 있습니다. | 
| type | (str, 선택 사항) 가져올 아티팩트의 유형입니다. | 
| 반환 | |
|---|---|
| Artifact오브젝트입니다. | 
| 예외 | |
|---|---|
| ValueError | 아티팩트 이름이 지정되지 않은 경우 | 
| ValueError | 아티팩트 유형이 지정되었지만 가져온 아티팩트의 유형과 일치하지 않는 경우 | 
참고:
이 메소드는 외부 전용입니다. wandb 리포지토리 코드 내에서api.artifact()를 호출하지 마십시오.
artifact_collection
소스 보기
entity/project/name 형식으로 경로를 파싱합니다.
| ARG | |
|---|---|
| type_name | (str) 가져올 아티팩트 컬렉션의 유형입니다. | 
| name | (str) 아티팩트 컬렉션 이름입니다. entity/project로 시작할 수 있습니다. | 
| 반환 | |
|---|---|
| ArtifactCollection오브젝트입니다. | 
artifact_collection_exists
소스 보기
| ARG | |
|---|---|
| name | (str) 아티팩트 컬렉션 이름입니다. entity/project로 시작할 수 있습니다. entity 또는 project가 지정되지 않은 경우 채워진 경우 오버라이드 파라미터에서 추론됩니다. 그렇지 않으면 entity는 사용자 설정에서 가져오고 project는 기본적으로 “uncategorized”로 설정됩니다. | 
| type | (str) 아티팩트 컬렉션의 유형 | 
| 반환 | |
|---|---|
| 아티팩트 컬렉션이 있으면 True, 그렇지 않으면 False입니다. | 
artifact_collections
소스 보기
| ARG | |
|---|---|
| project_name | (str) 필터링할 프로젝트의 이름입니다. | 
| type_name | (str) 필터링할 아티팩트 유형의 이름입니다. | 
| per_page | (int, 선택 사항) 쿼리 페이지 매김에 대한 페이지 크기를 설정합니다. None은 기본 크기를 사용합니다. 일반적으로 이를 변경할 이유는 없습니다. | 
| 반환 | |
|---|---|
| 반복 가능한 ArtifactCollections오브젝트입니다. | 
artifact_exists
소스 보기
| ARG | |
|---|---|
| name | (str) 아티팩트 이름입니다. entity/project로 시작할 수 있습니다. entity 또는 project가 지정되지 않은 경우 채워진 경우 오버라이드 파라미터에서 추론됩니다. 그렇지 않으면 entity는 사용자 설정에서 가져오고 project는 기본적으로 “uncategorized”로 설정됩니다. 유효한 이름은 name:version name:alias 형식일 수 있습니다. | 
| type | (str, 선택 사항) 아티팩트 유형 | 
| 반환 | |
|---|---|
| 아티팩트 버전이 있으면 True, 그렇지 않으면 False입니다. | 
artifact_type
소스 보기
ArtifactType을 반환합니다.
| ARG | |
|---|---|
| type_name | (str) 검색할 아티팩트 유형의 이름입니다. | 
| project | (str, 선택 사항) 지정된 경우 필터링할 프로젝트 이름 또는 경로입니다. | 
| 반환 | |
|---|---|
| ArtifactType오브젝트입니다. | 
artifact_types
소스 보기
| ARG | |
|---|---|
| project | (str, 선택 사항) 지정된 경우 필터링할 프로젝트 이름 또는 경로입니다. | 
| 반환 | |
|---|---|
| 반복 가능한 ArtifactTypes오브젝트입니다. | 
artifact_versions
소스 보기
artifacts(type_name, name)을 사용하세요.
artifacts
소스 보기
Artifacts 컬렉션을 반환합니다.
| ARG | |
|---|---|
| type_name | (str) 가져올 아티팩트의 유형입니다. | 
| name | (str) 아티팩트 컬렉션 이름입니다. entity/project로 시작할 수 있습니다. | 
| per_page | (int, 선택 사항) 쿼리 페이지 매김에 대한 페이지 크기를 설정합니다. None은 기본 크기를 사용합니다. 일반적으로 이를 변경할 이유는 없습니다. | 
| tags | (list[str], 선택 사항) 이러한 모든 태그가 있는 아티팩트만 반환합니다. | 
| 반환 | |
|---|---|
| 반복 가능한 Artifacts오브젝트입니다. | 
create_project
소스 보기
| ARG | |
|---|---|
| name | (str) 새 프로젝트의 이름입니다. | 
| entity | (str) 새 프로젝트의 entity입니다. | 
create_run
소스 보기
| ARG | |
|---|---|
| run_id | (str, 선택 사항) 지정된 경우 run에 할당할 ID입니다. run ID는 기본적으로 자동으로 생성되므로 일반적으로 이를 지정할 필요가 없으며 자신의 책임하에만 수행해야 합니다. | 
| project | (str, 선택 사항) 지정된 경우 새 run의 프로젝트입니다. | 
| entity | (str, 선택 사항) 지정된 경우 새 run의 entity입니다. | 
| 반환 | |
|---|---|
| 새로 생성된 Run입니다. | 
create_run_queue
소스 보기
| ARG | |
|---|---|
| name | (str) 만들 대기열의 이름 | 
| type | (str) 대기열에 사용할 리소스 유형입니다. “local-container”, “local-process”, “kubernetes”, “sagemaker” 또는 “gcp-vertex” 중 하나입니다. | 
| entity | (str) 대기열을 만들 entity의 선택적 이름입니다. None이면 구성된 entity 또는 기본 entity가 사용됩니다. | 
| prioritization_mode | (str) 사용할 우선 순위 지정의 선택적 버전입니다. “V0” 또는 None입니다. | 
| config | (dict) 대기열에 사용할 선택적 기본 리소스 구성입니다. 핸들바( {{var}}등)를 사용하여 템플릿 변수를 지정합니다. | 
| template_variables | (dict) 구성과 함께 사용할 템플릿 변수 스키마의 사전입니다. 예상 형식: { "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } } | 
| 반환 | |
|---|---|
| 새로 생성된 RunQueue | 
| 예외 | |
|---|---|
| 파라미터가 유효하지 않으면 ValueError wandb API 오류 시 wandb.Error | 
create_team
소스 보기
| ARG | |
|---|---|
| team | (str) 팀의 이름 | 
| admin_username | (str) 팀의 관리자 사용자의 선택적 사용자 이름이며, 기본값은 현재 사용자입니다. | 
| 반환 | |
|---|---|
| Team오브젝트 | 
create_user
소스 보기
| ARG | |
|---|---|
| email | (str) 사용자의 이메일 주소 | 
| admin | (bool) 이 사용자가 전역 인스턴스 관리자인지 여부 | 
| 반환 | |
|---|---|
| User오브젝트 | 
flush
소스 보기
api.flush()로 로컬 캐시를 지워야 합니다. 그래야 run과 관련된 최신 값을 얻을 수 있습니다.
from_path
소스 보기
예시:
| ARG | |
|---|---|
| path | (str) 프로젝트, run, 스윕 또는 리포트의 경로 | 
| 반환 | |
|---|---|
| Project,Run,Sweep또는BetaReport인스턴스입니다. | 
| 예외 | |
|---|---|
| 경로가 유효하지 않거나 오브젝트가 존재하지 않으면 wandb.Error | 
job
소스 보기
Job을 반환합니다.
| ARG | |
|---|---|
| name | (str) 작업 이름입니다. | 
| path | (str, 선택 사항) 지정된 경우 작업 아티팩트를 다운로드할 루트 경로입니다. | 
| 반환 | |
|---|---|
| Job오브젝트입니다. | 
list_jobs
소스 보기
| ARG | |
|---|---|
| entity | (str) 나열된 작업의 entity입니다. | 
| project | (str) 나열된 작업의 프로젝트입니다. | 
| 반환 | |
|---|---|
| 일치하는 작업 목록입니다. | 
project
소스 보기
Project를 반환합니다.
| ARG | |
|---|---|
| name | (str) 프로젝트 이름입니다. | 
| entity | (str) 요청된 entity의 이름입니다. None이면 Api에 전달된 기본 entity로 대체됩니다. 기본 entity가 없으면ValueError가 발생합니다. | 
| 반환 | |
|---|---|
| Project오브젝트입니다. | 
projects
소스 보기
| ARG | |
|---|---|
| entity | (str) 요청된 entity의 이름입니다. None이면 Api에 전달된 기본 entity로 대체됩니다. 기본 entity가 없으면ValueError가 발생합니다. | 
| per_page | (int) 쿼리 페이지 매김에 대한 페이지 크기를 설정합니다. None은 기본 크기를 사용합니다. 일반적으로 이를 변경할 이유는 없습니다. | 
| 반환 | |
|---|---|
| Project오브젝트의 반복 가능한 컬렉션인Projects오브젝트입니다. | 
queued_run
소스 보기
registries
소스 보기
예시:
이름에 “model”이 포함된 모든 레지스트리 찾기| ARG | |
|---|---|
| organization | (str, 선택 사항) 가져올 레지스트리의 조직입니다. 지정하지 않으면 사용자 설정에 지정된 조직을 사용합니다. | 
| filter | (dict, 선택 사항) 레지스트리 반복자의 각 오브젝트에 적용할 MongoDB 스타일 필터입니다. 컬렉션에 대해 필터링할 수 있는 필드는 name,description,created_at,updated_at입니다. 컬렉션에 대해 필터링할 수 있는 필드는name,tag,description,created_at,updated_at입니다. 버전에 대해 필터링할 수 있는 필드는tag,alias,created_at,updated_at,metadata입니다. | 
| 반환 | |
|---|---|
| 레지스트리 반복기입니다. | 
reports
소스 보기
| ARG | |
|---|---|
| path | (str) 리포트가 있는 프로젝트의 경로이며 “entity/project” 형식이어야 합니다. | 
| name | (str, 선택 사항) 요청된 리포트의 선택적 이름입니다. | 
| per_page | (int) 쿼리 페이지 매김에 대한 페이지 크기를 설정합니다. None은 기본 크기를 사용합니다. 일반적으로 이를 변경할 이유는 없습니다. | 
| 반환 | |
|---|---|
| BetaReport오브젝트의 반복 가능한 컬렉션인Reports오브젝트입니다. | 
run
소스 보기
entity/project/run_id 형식으로 경로를 파싱하여 단일 run을 반환합니다.
| ARG | |
|---|---|
| path | (str) entity/project/run_id형식의 run 경로입니다.api.entity가 설정된 경우project/run_id형식일 수 있으며api.project가 설정된 경우 run_id일 수 있습니다. | 
| 반환 | |
|---|---|
| Run오브젝트입니다. | 
run_queue
소스 보기
RunQueue를 반환합니다.
새 RunQueue를 만들려면 wandb.Api().create_run_queue(...)를 사용하세요.
runs
소스 보기
- createdAt: run이 생성된 타임스탬프입니다. (ISO 8601 형식, 예: “2023-01-01T12:00:00Z”)
- displayName: run의 사람이 읽을 수 있는 표시 이름입니다. (예: “eager-fox-1”)
- duration: run의 총 런타임(초)입니다.
- group: 관련 run을 함께 구성하는 데 사용되는 그룹 이름입니다.
- host: run이 실행된 호스트 이름입니다.
- jobType: run의 작업 유형 또는 목적입니다.
- name: run의 고유 식별자입니다. (예: “a1b2cdef”)
- state: run의 현재 상태입니다.
- tags: run과 연결된 태그입니다.
- username: run을 시작한 사용자의 사용자 이름입니다.
config.experiment_name, summary_metrics.loss 등.
더 복잡한 필터링을 위해 MongoDB 쿼리 연산자를 사용할 수 있습니다.
자세한 내용은 https://docs.mongodb.com/manual/reference/operator/query/ 를 참조하세요.
다음 작업이 지원됩니다.
- $and
- $or
- $nor
- $eq
- $ne
- $gt
- $gte
- $lt
- $lte
- $in
- $nin
- $exists
- $regex
예시:
config.experiment_name이 “foo”로 설정된 my_project에서 run 찾기| ARG | |
|---|---|
| path | (str) 프로젝트 경로이며 “entity/project” 형식이어야 합니다. | 
| filters | (dict) MongoDB 쿼리 언어를 사용하여 특정 run을 쿼리합니다. config.key, summary_metrics.key, state, entity, createdAt 등과 같은 run 속성으로 필터링할 수 있습니다. 예: {"config.experiment_name": "foo"}는 experiment name이 “foo”로 설정된 config 항목이 있는 run을 찾습니다. | 
| order | (str) 순서는 created_at,heartbeat_at,config.*.value또는summary_metrics.*일 수 있습니다. +를 사용하여 순서를 앞에 추가하면 오름차순입니다. -를 사용하여 순서를 앞에 추가하면 내림차순입니다(기본값). 기본 순서는 run.created_at이며 가장 오래된 것부터 가장 최신 것 순입니다. | 
| per_page | (int) 쿼리 페이지 매김에 대한 페이지 크기를 설정합니다. | 
| include_sweeps | (bool) 스윕 run을 결과에 포함할지 여부입니다. | 
| 반환 | |
|---|---|
| Run오브젝트의 반복 가능한 컬렉션인Runs오브젝트입니다. | 
sweep
소스 보기
entity/project/sweep_id 형식으로 경로를 파싱하여 스윕을 반환합니다.
| ARG | |
|---|---|
| path | (str, 선택 사항) entity/project/sweep_id 형식의 스윕 경로입니다. api.entity가 설정된 경우 project/sweep_id 형식일 수 있으며api.project가 설정된 경우 sweep_id일 수 있습니다. | 
| 반환 | |
|---|---|
| Sweep오브젝트입니다. | 
sync_tensorboard
소스 보기
team
소스 보기
Team을 반환합니다.
| ARG | |
|---|---|
| team | (str) 팀의 이름입니다. | 
| 반환 | |
|---|---|
| Team오브젝트입니다. | 
upsert_run_queue
소스 보기
| ARG | |
|---|---|
| name | (str) 만들 대기열의 이름 | 
| entity | (str) 대기열을 만들 entity의 선택적 이름입니다. None이면 구성된 entity 또는 기본 entity가 사용됩니다. | 
| resource_config | (dict) 대기열에 사용할 선택적 기본 리소스 구성입니다. 핸들바( {{var}}등)를 사용하여 템플릿 변수를 지정합니다. | 
| resource_type | (str) 대기열에 사용할 리소스 유형입니다. “local-container”, “local-process”, “kubernetes”, “sagemaker” 또는 “gcp-vertex” 중 하나입니다. | 
| template_variables | (dict) 구성과 함께 사용할 템플릿 변수 스키마의 사전입니다. 예상 형식: { "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } } | 
| external_links | (dict) 대기열과 함께 사용할 외부 링크의 선택적 사전입니다. 예상 형식: { "name": "url" } | 
| prioritization_mode | (str) 사용할 우선 순위 지정의 선택적 버전입니다. “V0” 또는 None입니다. | 
| 반환 | |
|---|---|
| upsert된 RunQueue입니다. | 
| 예외 | |
|---|---|
| 파라미터가 유효하지 않으면 ValueError wandb API 오류 시 wandb.Error | 
user
소스 보기
api.viewer를 사용하세요.
| ARG | |
|---|---|
| username_or_email | (str) 사용자의 사용자 이름 또는 이메일 주소 | 
| 반환 | |
|---|---|
| User오브젝트 또는 사용자를 찾을 수 없으면 None | 
users
소스 보기
api.viewer를 사용하세요.
| ARG | |
|---|---|
| username_or_email | (str) 찾을 사용자의 접두사 또는 접미사 | 
| 반환 | |
|---|---|
| User오브젝트 배열 | 
| 클래스 변수 | |
|---|---|
| CREATE_PROJECT | |
| DEFAULT_ENTITY_QUERY | |
| USERS_QUERY | |
| VIEWER_QUERY |