Import & Export API

• 1: Api
• 2: File
• 3: Files
• 4: Job
• 5: Project
• 6: Projects
• 7: QueuedRun
• 8: Run
• 9: RunQueue
• 10: Runs
• 11: Sweep

1 - Api

wandb 서버를 쿼리하는 데 사용됩니다.

Api(
    overrides: Optional[Dict[str, Any]] = None,
    timeout: Optional[int] = None,
    api_key: Optional[str] = None
) -> None

예시:

가장 일반적인 초기화 방법

>>> wandb.Api()

메소드

artifact

소스 보기

artifact(
    name: str,
    type: Optional[str] = None
)

project/name 또는 entity/project/name 형식으로 경로를 파싱하여 단일 아티팩트를 반환합니다.

참고:

이 메소드는 외부 전용입니다. wandb 리포지토리 코드 내에서 api.artifact()를 호출하지 마십시오.

artifact_collection

소스 보기

artifact_collection(
    type_name: str,
    name: str
) -> "public.ArtifactCollection"

유형별로 단일 아티팩트 컬렉션을 반환하고 entity/project/name 형식으로 경로를 파싱합니다.

artifact_collection_exists

소스 보기

artifact_collection_exists(
    name: str,
    type: str
) -> bool

지정된 프로젝트 및 entity 내에 아티팩트 컬렉션이 있는지 여부를 반환합니다.

artifact_collections

소스 보기

artifact_collections(
    project_name: str,
    type_name: str,
    per_page: Optional[int] = 50
) -> "public.ArtifactCollections"

일치하는 아티팩트 컬렉션의 컬렉션을 반환합니다.

artifact_exists

소스 보기

artifact_exists(
    name: str,
    type: Optional[str] = None
) -> bool

지정된 프로젝트 및 entity 내에 아티팩트 버전이 있는지 여부를 반환합니다.

artifact_type

소스 보기

artifact_type(
    type_name: str,
    project: Optional[str] = None
) -> "public.ArtifactType"

일치하는 ArtifactType을 반환합니다.

artifact_types

소스 보기

artifact_types(
    project: Optional[str] = None
) -> "public.ArtifactTypes"

일치하는 아티팩트 유형의 컬렉션을 반환합니다.

artifact_versions

소스 보기

artifact_versions(
    type_name, name, per_page=50
)

더 이상 사용되지 않습니다. 대신 artifacts(type_name, name)을 사용하세요.

artifacts

소스 보기

artifacts(
    type_name: str,
    name: str,
    per_page: Optional[int] = 50,
    tags: Optional[List[str]] = None
) -> "public.Artifacts"

지정된 파라미터에서 Artifacts 컬렉션을 반환합니다.

create_project

소스 보기

create_project(
    name: str,
    entity: str
) -> None

새 프로젝트를 만듭니다.

create_run

소스 보기

create_run(
    *,
    run_id: Optional[str] = None,
    project: Optional[str] = None,
    entity: Optional[str] = None
) -> "public.Run"

새 run을 만듭니다.

create_run_queue

소스 보기

create_run_queue(
    name: str,
    type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None,
    config: Optional[dict] = None,
    template_variables: Optional[dict] = None
) -> "public.RunQueue"

새 run 대기열(Launch)을 만듭니다.

create_team

소스 보기

create_team(
    team, admin_username=None
)

새 팀을 만듭니다.

create_user

소스 보기

create_user(
    email, admin=(False)
)

새 사용자를 만듭니다.

flush

소스 보기

flush()

로컬 캐시를 플러시합니다.

api 오브젝트는 run의 로컬 캐시를 유지하므로 스크립트를 실행하는 동안 run의 상태가 변경될 수 있는 경우 api.flush()로 로컬 캐시를 지워야 합니다. 그래야 run과 관련된 최신 값을 얻을 수 있습니다.

from_path

소스 보기

from_path(
    path
)

경로에서 run, 스윕, 프로젝트 또는 리포트를 반환합니다.

예시:

project = api.from_path("my_project")
team_project = api.from_path("my_team/my_project")
run = api.from_path("my_team/my_project/runs/id")
sweep = api.from_path("my_team/my_project/sweeps/id")
report = api.from_path("my_team/my_project/reports/My-Report-Vm11dsdf")

job

소스 보기

job(
    name: Optional[str],
    path: Optional[str] = None
) -> "public.Job"

지정된 파라미터에서 Job을 반환합니다.

list_jobs

소스 보기

list_jobs(
    entity: str,
    project: str
) -> List[Dict[str, Any]]

지정된 entity 및 프로젝트에 대한 작업 목록(있는 경우)을 반환합니다.

project

소스 보기

project(
    name: str,
    entity: Optional[str] = None
) -> "public.Project"

지정된 이름(및 지정된 경우 entity)으로 Project를 반환합니다.

projects

소스 보기

projects(
    entity: Optional[str] = None,
    per_page: Optional[int] = 200
) -> "public.Projects"

지정된 entity에 대한 프로젝트를 가져옵니다.

queued_run

소스 보기

queued_run(
    entity, project, queue_name, run_queue_item_id, project_queue=None,
    priority=None
)

경로를 기반으로 단일 대기열에 있는 run을 반환합니다.

entity/project/queue_id/run_queue_item_id 형식의 경로를 파싱합니다.

registries

소스 보기

registries(
    organization: Optional[str] = None,
    filter: Optional[Dict[str, Any]] = None
) -> Registries

Registry 반복자를 반환합니다.

반복자를 사용하여 조직의 Registry에서 레지스트리, 컬렉션 또는 아티팩트 버전을 검색하고 필터링합니다.

예시:

이름에 “model"이 포함된 모든 레지스트리 찾기

import wandb

api = wandb.Api()  # entity가 여러 조직에 속한 경우 조직을 지정합니다.
api.registries(filter={"name": {"$regex": "model"}})

이름이 “my_collection"이고 태그가 “my_tag"인 레지스트리의 모든 컬렉션 찾기

api.registries().collections(filter={"name": "my_collection", "tag": "my_tag"})

“my_collection"이 포함된 컬렉션 이름과 “best” 에일리어스가 있는 버전을 사용하여 레지스트리의 모든 아티팩트 버전 찾기

api.registries().collections(
    filter={"name": {"$regex": "my_collection"}}
).versions(filter={"alias": "best"})

“model"을 포함하고 태그 “prod” 또는 에일리어스 “best"가 있는 레지스트리의 모든 아티팩트 버전 찾기

api.registries(filter={"name": {"$regex": "model"}}).versions(
    filter={"$or": [{"tag": "prod"}, {"alias": "best"}]}
)

reports

소스 보기

reports(
    path: str = "",
    name: Optional[str] = None,
    per_page: Optional[int] = 50
) -> "public.Reports"

지정된 프로젝트 경로에 대한 리포트를 가져옵니다.

경고: 이 API는 베타 버전이며 향후 릴리스에서 변경될 수 있습니다.

run

소스 보기

run(
    path=""
)

entity/project/run_id 형식으로 경로를 파싱하여 단일 run을 반환합니다.

run_queue

소스 보기

run_queue(
    entity, name
)

entity에 대해 이름이 지정된 RunQueue를 반환합니다.

새 RunQueue를 만들려면 wandb.Api().create_run_queue(...)를 사용하세요.

runs

소스 보기

runs(
    path: Optional[str] = None,
    filters: Optional[Dict[str, Any]] = None,
    order: str = "+created_at",
    per_page: int = 50,
    include_sweeps: bool = (True)
)

제공된 필터와 일치하는 프로젝트에서 run 집합을 반환합니다.

필터링할 수 있는 필드는 다음과 같습니다.

• 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을 시작한 사용자의 사용자 이름입니다.

또한 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 찾기

api.runs(
    path="my_entity/my_project",
    filters={"config.experiment_name": "foo"},
)

config.experiment_name이 “foo” 또는 “bar"로 설정된 my_project에서 run 찾기

api.runs(
    path="my_entity/my_project",
    filters={
        "$or": [
            {"config.experiment_name": "foo"},
            {"config.experiment_name": "bar"},
        ]
    },
)

config.experiment_name이 정규식과 일치하는 my_project에서 run 찾기(앵커는 지원되지 않음)

api.runs(
    path="my_entity/my_project",
    filters={"config.experiment_name": {"$regex": "b.*"}},
)

run 이름이 정규식과 일치하는 my_project에서 run 찾기(앵커는 지원되지 않음)

api.runs(
    path="my_entity/my_project",
    filters={"display_name": {"$regex": "^foo.*"}},
)

config.experiment에 값 “testing"이 있는 중첩 필드 “category"가 포함된 my_project에서 run 찾기

api.runs(
    path="my_entity/my_project",
    filters={"config.experiment.category": "testing"},
)

요약 메트릭에서 model1 아래의 사전에 중첩된 손실 값이 0.5인 my_project에서 run 찾기

api.runs(
    path="my_entity/my_project",
    filters={"summary_metrics.model1.loss": 0.5},
)

오름차순 손실로 정렬된 my_project에서 run 찾기

api.runs(path="my_entity/my_project", order="+summary_metrics.loss")

sweep

소스 보기

sweep(
    path=""
)

entity/project/sweep_id 형식으로 경로를 파싱하여 스윕을 반환합니다.

sync_tensorboard

소스 보기

sync_tensorboard(
    root_dir, run_id=None, project=None, entity=None
)

tfevent 파일이 포함된 로컬 디렉토리를 wandb와 동기화합니다.

team

소스 보기

team(
    team: str
) -> "public.Team"

지정된 이름으로 일치하는 Team을 반환합니다.

upsert_run_queue

소스 보기

upsert_run_queue(
    name: str,
    resource_config: dict,
    resource_type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    template_variables: Optional[dict] = None,
    external_links: Optional[dict] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None
)

run 대기열(Launch)을 upsert합니다.

user

소스 보기

user(
    username_or_email: str
) -> Optional['public.User']

사용자 이름 또는 이메일 주소에서 사용자를 반환합니다.

참고: 이 함수는 로컬 관리자만 사용할 수 있습니다. 자신의 사용자 오브젝트를 가져오려면 api.viewer를 사용하세요.

users

소스 보기

users(
    username_or_email: str
) -> List['public.User']

부분 사용자 이름 또는 이메일 주소 쿼리에서 모든 사용자를 반환합니다.

참고: 이 함수는 로컬 관리자만 사용할 수 있습니다. 자신의 사용자 오브젝트를 가져오려면 api.viewer를 사용하세요.

2 - File

File은 wandb에 의해 저장된 파일과 연결된 클래스입니다.

File(
    client, attrs, run=None
)

메소드

delete

View source

delete()

display

View source

display(
    height=420, hidden=(False)
) -> bool

Jupyter에서 이 오브젝트를 표시합니다.

download

View source

download(
    root: str = ".",
    replace: bool = (False),
    exist_ok: bool = (False),
    api: Optional[Api] = None
) -> io.TextIOWrapper

wandb 서버에서 run에 의해 이전에 저장된 파일을 다운로드합니다.

snake_to_camel

View source

snake_to_camel(
    string
)

to_html

View source

to_html(
    *args, **kwargs
)

3 - Files

File 오브젝트의 반복 가능한 컬렉션입니다.

Files(
    client, run, names=None, per_page=50, upload=(False)
)

메소드

convert_objects

소스 보기

convert_objects()

next

소스 보기

next()

update_variables

소스 보기

update_variables()

__getitem__

소스 보기

__getitem__(
    index
)

__iter__

소스 보기

__iter__()

__len__

소스 보기

__len__()

4 - Job

Job(
    api: "Api",
    name,
    path: Optional[str] = None
) -> None

메소드

call

소스 보기

call(
    config, project=None, entity=None, queue=None, resource="local-container",
    resource_args=None, template_variables=None, project_queue=None, priority=None
)

set_entrypoint

소스 보기

set_entrypoint(
    entrypoint: List[str]
)

5 - Project

project는 runs를 위한 네임스페이스입니다.

Project(
    client, entity, project, attrs
)

Methods

artifacts_types

소스 보기

artifacts_types(
    per_page=50
)

display

소스 보기

display(
    height=420, hidden=(False)
) -> bool

Jupyter에서 이 오브젝트를 표시합니다.

snake_to_camel

소스 보기

snake_to_camel(
    string
)

sweeps

소스 보기

sweeps()

to_html

소스 보기

to_html(
    height=420, hidden=(False)
)

이 project를 표시하는 iframe을 포함하는 HTML을 생성합니다.

6 - Projects

Project 오브젝트의 반복 가능한 컬렉션입니다.

Projects(
    client, entity, per_page=50
)

메소드

convert_objects

소스 보기

convert_objects()

next

소스 보기

next()

update_variables

소스 보기

update_variables()

__getitem__

소스 보기

__getitem__(
    index
)

__iter__

소스 보기

__iter__()

__len__

소스 보기

__len__()

7 - QueuedRun

엔티티 및 프로젝트와 연결된 단일 대기열 run입니다. run = queued_run.wait_until_running() 또는 run = queued_run.wait_until_finished()를 호출하여 run에 액세스합니다.

QueuedRun(
    client, entity, project, queue_name, run_queue_item_id,
    project_queue=LAUNCH_DEFAULT_PROJECT, priority=None
)

메소드

delete

소스 보기

delete(
    delete_artifacts=(False)
)

wandb 백엔드에서 지정된 대기열 run을 삭제합니다.

wait_until_finished

소스 보기

wait_until_finished()

wait_until_running

소스 보기

wait_until_running()

8 - Run

엔티티 및 프로젝트와 연결된 단일 run입니다.

Run(
    client: "RetryingClient",
    entity: str,
    project: str,
    run_id: str,
    attrs: Optional[Mapping] = None,
    include_sweeps: bool = (True)
)

메소드

create

소스 보기

@classmethod
create(
    api, run_id=None, project=None, entity=None
)

지정된 프로젝트에 대한 run을 생성합니다.

delete

소스 보기

delete(
    delete_artifacts=(False)
)

wandb 백엔드에서 지정된 run을 삭제합니다.

display

소스 보기

display(
    height=420, hidden=(False)
) -> bool

이 오브젝트를 jupyter에 표시합니다.

file

소스 보기

file(
    name
)

아티팩트에서 지정된 이름을 가진 파일의 경로를 반환합니다.

files

소스 보기

files(
    names=None, per_page=50
)

이름이 지정된 각 파일에 대한 파일 경로를 반환합니다.

history

소스 보기

history(
    samples=500, keys=None, x_axis="_step", pandas=(True), stream="default"
)

run에 대한 샘플링된 히스토리 메트릭을 반환합니다.

히스토리 레코드가 샘플링되어도 괜찮다면 더 간단하고 빠릅니다.

load

소스 보기

load(
    force=(False)
)

log_artifact

소스 보기

log_artifact(
    artifact: "wandb.Artifact",
    aliases: Optional[Collection[str]] = None,
    tags: Optional[Collection[str]] = None
)

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

logged_artifacts

소스 보기

logged_artifacts(
    per_page: int = 100
) -> public.RunArtifacts

이 run에서 로그된 모든 아티팩트를 가져옵니다.

run 중에 로그된 모든 출력 아티팩트를 검색합니다. 반복하거나 단일 목록으로 수집할 수 있는 페이지 매김된 결과를 반환합니다.

예시:

>>> import wandb
>>> import tempfile
>>> with tempfile.NamedTemporaryFile(
...     mode="w", delete=False, suffix=".txt"
... ) as tmp:
...     tmp.write("This is a test artifact")
...     tmp_path = tmp.name
>>> run = wandb.init(project="artifact-example")
>>> artifact = wandb.Artifact("test_artifact", type="dataset")
>>> artifact.add_file(tmp_path)
>>> run.log_artifact(artifact)
>>> run.finish()
>>> api = wandb.Api()
>>> finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
>>> for logged_artifact in finished_run.logged_artifacts():
...     print(logged_artifact.name)
test_artifact

save

소스 보기

save()

scan_history

소스 보기

scan_history(
    keys=None, page_size=1000, min_step=None, max_step=None
)

run에 대한 모든 히스토리 레코드의 반복 가능한 컬렉션을 반환합니다.

예시:

예제 run에 대한 모든 손실 값을 내보냅니다.

run = api.run("l2k2/examples-numpy-boston/i0wt6xua")
history = run.scan_history(keys=["Loss"])
losses = [row["Loss"] for row in history]

snake_to_camel

소스 보기

snake_to_camel(
    string
)

to_html

소스 보기

to_html(
    height=420, hidden=(False)
)

이 run을 표시하는 iframe을 포함하는 HTML을 생성합니다.

update

소스 보기

update()

wandb 백엔드에 대한 run 오브젝트의 변경 사항을 유지합니다.

upload_file

소스 보기

upload_file(
    path, root="."
)

파일을 업로드합니다.

use_artifact

소스 보기

use_artifact(
    artifact, use_as=None
)

아티팩트를 run에 대한 입력으로 선언합니다.

used_artifacts

소스 보기

used_artifacts(
    per_page: int = 100
) -> public.RunArtifacts

이 run에서 명시적으로 사용된 아티팩트를 가져옵니다.

일반적으로 run.use_artifact()를 통해 run 중에 사용된 것으로 명시적으로 선언된 입력 아티팩트만 검색합니다. 반복하거나 단일 목록으로 수집할 수 있는 페이지 매김된 결과를 반환합니다.

예시:

>>> import wandb
>>> run = wandb.init(project="artifact-example")
>>> run.use_artifact("test_artifact:latest")
>>> run.finish()
>>> api = wandb.Api()
>>> finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
>>> for used_artifact in finished_run.used_artifacts():
...     print(used_artifact.name)
test_artifact

wait_until_finished

소스 보기

wait_until_finished()

9 - RunQueue

RunQueue(
    client: "RetryingClient",
    name: str,
    entity: str,
    prioritization_mode: Optional[RunQueuePrioritizationMode] = None,
    _access: Optional[RunQueueAccessType] = None,
    _default_resource_config_id: Optional[int] = None,
    _default_resource_config: Optional[dict] = None
) -> None

Methods

create

View source

@classmethod
create(
    name: str,
    resource: "RunQueueResourceType",
    entity: Optional[str] = None,
    prioritization_mode: Optional['RunQueuePrioritizationMode'] = None,
    config: Optional[dict] = None,
    template_variables: Optional[dict] = None
) -> "RunQueue"

delete

View source

delete()

wandb 백엔드에서 run 대기열을 삭제합니다.

10 - Runs

프로젝트 및 선택적 필터와 연결된 runs의 반복 가능한 컬렉션입니다.

Runs(
    client: "RetryingClient",
    entity: str,
    project: str,
    filters: Optional[Dict[str, Any]] = None,
    order: Optional[str] = None,
    per_page: int = 50,
    include_sweeps: bool = (True)
)

일반적으로 Api.runs 메소드를 통해 간접적으로 사용됩니다.

메소드

convert_objects

소스 보기

convert_objects()

histories

소스 보기

histories(
    samples: int = 500,
    keys: Optional[List[str]] = None,
    x_axis: str = "_step",
    format: Literal['default', 'pandas', 'polars'] = "default",
    stream: Literal['default', 'system'] = "default"
)

필터 조건에 맞는 모든 runs에 대해 샘플링된 히스토리 메트릭을 반환합니다.

next

소스 보기

next()

update_variables

소스 보기

update_variables()

__getitem__

소스 보기

__getitem__(
    index
)

__iter__

소스 보기

__iter__()

__len__

소스 보기

__len__()

11 - Sweep

스윕과 관련된 run들의 집합입니다.

Sweep(
    client, entity, project, sweep_id, attrs=None
)

예시:

다음과 같이 인스턴스화합니다:

api = wandb.Api()
sweep = api.sweep(path / to / sweep)

메소드

best_run

소스 보기

best_run(
    order=None
)

구성에서 정의된 메트릭 또는 전달된 순서에 따라 정렬된 최상의 run을 반환합니다.

display

소스 보기

display(
    height=420, hidden=(False)
) -> bool

이 오브젝트를 jupyter에 표시합니다.

get

소스 보기

@classmethod
get(
    client, entity=None, project=None, sid=None, order=None, query=None, **kwargs
)

클라우드 백엔드에 대해 쿼리를 실행합니다.

load

소스 보기

load(
    force: bool = (False)
)

snake_to_camel

소스 보기

snake_to_camel(
    string
)

to_html

소스 보기

to_html(
    height=420, hidden=(False)
)

이 스윕을 표시하는 iframe을 포함하는 HTML을 생성합니다.