Artifact

데이터셋 및 모델 버전 관리를 위한 유연하고 가벼운 빌딩 블록입니다.

Artifact(
    name: str,
    type: str,
    description: (str | None) = None,
    metadata: (dict[str, Any] | None) = None,
    incremental: bool = (False),
    use_as: (str | None) = None
) -> None

빈 W&B Artifact를 생성합니다. add 로 시작하는 메서드로 Artifact 내용을 채웁니다. Artifact에 원하는 파일이 모두 있으면 wandb.log_artifact() 를 호출하여 기록할 수 있습니다.

Methods

add

소스 보기

add(
    obj: WBValue,
    name: StrPath,
    overwrite: bool = (False)
) -> ArtifactManifestEntry

wandb.WBValue obj 를 Artifact에 추가합니다.

add_dir

소스 보기

add_dir(
    local_path: str,
    name: (str | None) = None,
    skip_cache: (bool | None) = (False),
    policy: (Literal['mutable', 'immutable'] | None) = "mutable"
) -> None

로컬 디렉토리를 Artifact에 추가합니다.

add_file

소스 보기

add_file(
    local_path: str,
    name: (str | None) = None,
    is_tmp: (bool | None) = (False),
    skip_cache: (bool | None) = (False),
    policy: (Literal['mutable', 'immutable'] | None) = "mutable",
    overwrite: bool = (False)
) -> ArtifactManifestEntry

로컬 파일을 Artifact에 추가합니다.

add_reference

소스 보기

add_reference(
    uri: (ArtifactManifestEntry | str),
    name: (StrPath | None) = None,
    checksum: bool = (True),
    max_objects: (int | None) = None
) -> Sequence[ArtifactManifestEntry]

URI로 표시된 참조를 Artifact에 추가합니다.

Artifact에 추가하는 파일 또는 디렉토리와 달리 참조는 W&B에 업로드되지 않습니다. 자세한 내용은 외부 파일 추적을 참조하십시오.

기본적으로 다음 스키마가 지원됩니다.

• http(s): 파일 크기 및 다이제스트는 서버에서 반환된 Content-Length 및 ETag 응답 헤더에 의해 추론됩니다.
• s3: 체크섬 및 크기는 오브젝트 메타데이터에서 가져옵니다. 버킷 버전 관리가 활성화된 경우 버전 ID도 추적됩니다.
• gs: 체크섬 및 크기는 오브젝트 메타데이터에서 가져옵니다. 버킷 버전 관리가 활성화된 경우 버전 ID도 추적됩니다.
• https, 도메인 일치 *.blob.core.windows.net (Azure): 체크섬 및 크기는 Blob 메타데이터에서 가져옵니다. 스토리지 계정 버전 관리가 활성화된 경우 버전 ID도 추적됩니다.
• file: 체크섬 및 크기는 파일 시스템에서 가져옵니다. 이 스키마는 추적하고 싶지만 반드시 업로드할 필요는 없는 파일이 포함된 NFS 공유 또는 기타 외부 탑재 볼륨이 있는 경우에 유용합니다.

다른 스키마의 경우 다이제스트는 URI의 해시일 뿐이고 크기는 비어 있습니다.

checkout

소스 보기

checkout(
    root: (str | None) = None
) -> str

지정된 루트 디렉토리를 Artifact 내용으로 바꿉니다.

경고: 이렇게 하면 Artifact에 포함되지 않은 root 의 모든 파일이 삭제됩니다.

delete

소스 보기

delete(
    delete_aliases: bool = (False)
) -> None

Artifact 및 해당 파일을 삭제합니다.

링크된 Artifact (즉, 포트폴리오 컬렉션의 멤버) 에서 호출된 경우 링크만 삭제되고 소스 Artifact는 영향을 받지 않습니다.

download

소스 보기

download(
    root: (StrPath | None) = None,
    allow_missing_references: bool = (False),
    skip_cache: (bool | None) = None,
    path_prefix: (StrPath | None) = None
) -> FilePathStr

Artifact 내용을 지정된 루트 디렉토리에 다운로드합니다.

root 내에 있는 기존 파일은 수정되지 않습니다. root 의 내용을 Artifact와 정확히 일치시키려면 download 를 호출하기 전에 명시적으로 root 를 삭제하십시오.

file

소스 보기

file(
    root: (str | None) = None
) -> StrPath

단일 파일 Artifact를 root 로 지정한 디렉토리에 다운로드합니다.

files

소스 보기

files(
    names: (list[str] | None) = None,
    per_page: int = 50
) -> ArtifactFiles

이 Artifact에 저장된 모든 파일을 반복합니다.

finalize

소스 보기

finalize() -> None

Artifact 버전을 완료합니다.

Artifact가 특정 Artifact 버전으로 기록되므로 Artifact 버전이 완료되면 Artifact 버전을 수정할 수 없습니다. Artifact에 더 많은 데이터를 기록하려면 새 Artifact 버전을 만듭니다. log_artifact 로 Artifact를 기록하면 Artifact가 자동으로 완료됩니다.

get

소스 보기

get(
    name: str
) -> (WBValue | None)

Artifact 상대 name 에 있는 WBValue 오브젝트를 가져옵니다.

get_added_local_path_name

소스 보기

get_added_local_path_name(
    local_path: str
) -> (str | None)

로컬 파일 시스템 경로로 추가된 파일의 Artifact 상대 이름을 가져옵니다.

get_entry

소스 보기

get_entry(
    name: StrPath
) -> ArtifactManifestEntry

지정된 이름으로 항목을 가져옵니다.

get_path

소스 보기

get_path(
    name: StrPath
) -> ArtifactManifestEntry

더 이상 사용되지 않습니다. get_entry(name) 을 사용하십시오.

is_draft

소스 보기

is_draft() -> bool

Artifact가 저장되지 않았는지 확인합니다.

반환 값: Boolean. Artifact가 저장된 경우 False 입니다. Artifact가 저장되지 않은 경우 True 입니다.

json_encode

소스 보기

json_encode() -> dict[str, Any]

Artifact를 JSON 형식으로 인코딩하여 반환합니다.

link

소스 보기

link(
    target_path: str,
    aliases: (list[str] | None) = None
) -> None

이 Artifact를 포트폴리오 (승격된 Artifact 컬렉션) 에 연결합니다.

logged_by

소스 보기

logged_by() -> (Run | None)

Artifact를 원래 기록한 W&B run을 가져옵니다.

new_draft

소스 보기

new_draft() -> Artifact

커밋된 이 Artifact와 동일한 내용으로 새 초안 Artifact를 만듭니다.

기존 Artifact를 수정하면 “증분 Artifact"라고 하는 새 Artifact 버전이 생성됩니다. 반환된 Artifact는 새 버전으로 확장, 수정 및 기록할 수 있습니다.

new_file

소스 보기

@contextlib.contextmanager
new_file(
    name: str,
    mode: str = "x",
    encoding: (str | None) = None
) -> Iterator[IO]

새 임시 파일을 열고 Artifact에 추가합니다.

remove

소스 보기

remove(
    item: (StrPath | ArtifactManifestEntry)
) -> None

Artifact에서 항목을 제거합니다.

save

소스 보기

save(
    project: (str | None) = None,
    settings: (wandb.Settings | None) = None
) -> None

Artifact에 대한 모든 변경 사항을 유지합니다.

현재 run에 있는 경우 해당 run은 이 Artifact를 기록합니다. 현재 run에 없는 경우 이 Artifact를 추적하기 위해 “auto” 유형의 run이 생성됩니다.

unlink

소스 보기

unlink() -> None

이 Artifact가 현재 포트폴리오 (승격된 Artifact 컬렉션) 의 멤버인 경우 연결을 해제합니다.

used_by

소스 보기

used_by() -> list[Run]

이 Artifact를 사용한 run 목록을 가져옵니다.

verify

소스 보기

verify(
    root: (str | None) = None
) -> None

Artifact 내용이 manifest와 일치하는지 확인합니다.

디렉토리의 모든 파일은 체크섬이 계산되고 체크섬은 Artifact의 manifest와 상호 참조됩니다. 참조는 확인되지 않습니다.

wait

소스 보기

wait(
    timeout: (int | None) = None
) -> Artifact

필요한 경우 이 Artifact가 기록을 완료할 때까지 기다립니다.

__getitem__

소스 보기

__getitem__(
    name: str
) -> (WBValue | None)

Artifact 상대 name 에 있는 WBValue 오브젝트를 가져옵니다.

__setitem__

소스 보기

__setitem__(
    name: str,
    item: WBValue
) -> ArtifactManifestEntry

경로 name 에서 Artifact에 item 을 추가합니다.