アーティファクト

データセットとモデルのバージョン管理のための柔軟で軽量なビルディングブロック。

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 で始まるメソッドを用いて追加してください。すべてのファイルがそろったら wandb.log_artifact() を呼び出してログ化します。

メソッド

add

ソースを表示

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

wandb.WBValue obj をアーティファクトに追加します。

add_dir

ソースを表示

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

ローカルディレクトリーをアーティファクトに追加します。

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

ローカルファイルをアーティファクトに追加します。

add_reference

ソースを表示

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

URI によって示される参照をアーティファクトに追加します。

アーティファクトにファイルやディレクトリを追加する場合と異なり、参照は W&B にアップロードされません。詳細は、Track external files を参照してください。

デフォルトでは、以下のスキームがサポートされています:

• http(s): ファイルのサイズとダイジェストはサーバーから返された Content-Length と ETag レスポンスヘッダによって推測されます。
• s3: チェックサムとサイズはオブジェクトメタデータから取得されます。バケットバージョン管理が有効な場合、バージョン ID も追跡されます。
• gs: チェックサムとサイズはオブジェクトメタデータから取得されます。バケットバージョン管理が有効な場合、バージョン ID も追跡されます。
• https, *.blob.core.windows.net (Azure) ドメイン: チェックサムとサイズはブロブメタデータから取得されます。ストレージアカウントのバージョン管理が有効な場合、バージョン ID も追跡されます。
• file: チェックサムとサイズはファイルシステムから取得されます。このスキームは、アップロードする必要はないが追跡したいファイルを含む NFS シェアや他の外部マウントボリュームを持っている場合に便利です。

その他のスキームについては、ダイジェストは URI のハッシュとして生成され、サイズは空欄のままです。

checkout

ソースを表示

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

指定されたルートディレクトリをアーティファクトの内容に置き換えます。

警告: root に含まれているがアーティファクトに含まれていないすべてのファイルは削除されます。

delete

ソースを表示

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

アーティファクトおよびそのファイルを削除します。

リンクされたアーティファクト（すなわち、ポートフォリオコレクションのメンバー）に対して呼び出された場合、リンクのみが削除され、元のアーティファクトには影響を与えません。

download

ソースを表示

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

アーティファクトの内容を指定されたルートディレクトリにダウンロードします。

root 内の既存ファイルは変更されません。 root の内容をアーティファクトと完全に一致させたい場合は、download を呼び出す前に root を明示的に削除してください。

file

ソースを表示

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

指定した root のディレクトリに単一のファイルアーティファクトをダウンロードします。

files

ソースを表示

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

このアーティファクトに保存されているすべてのファイルを反復処理します。

finalize

ソースを表示

finalize() -> None

アーティファクトバージョンを確定します。

一度確定されたアーティファクトバージョンは、特定のアーティファクトバージョンとしてログされるため、変更できません。新しいデータをアーティファクトに記録するには、新しいアーティファクトバージョンを作成してください。アーティファクトは、log_artifact を使用してログ化すると自動的に確定されます。

get

ソースを表示

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

アーティファクト相対 name に配置されている WBValue オブジェクトを取得します。

get_added_local_path_name

ソースを表示

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

ローカルファイルシステムパスによって追加されたファイルのアーティファクト相対名を取得します。

get_entry

ソースを表示

get_entry(
    name: StrPath
) -> ArtifactManifestEntry

指定した名前のエントリを取得します。

get_path

ソースを表示

get_path(
    name: StrPath
) -> ArtifactManifestEntry

非推奨。get_entry(name) を使用してください。

is_draft

ソースを表示

is_draft() -> bool

アーティファクトが保存されていないかをチェックします。

Returns: Boolean. False はアーティファクトが保存された場合。True はアーティファクトが保存されていない場合。

json_encode

ソースを表示

json_encode() -> dict[str, Any]

アーティファクトを JSON 形式にエンコードして返します。

link

ソースを表示

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

このアーティファクトをポートフォリオ（プロモートされたアーティファクトのコレクション）にリンクします。

logged_by

ソースを表示

logged_by() -> (Run | None)

元々アーティファクトをログした W&B run を取得します。

new_draft

ソースを表示

new_draft() -> Artifact

このコミット済みのアーティファクトと同じ内容の新しいドラフトアーティファクトを作成します。

既存のアーティファクトを修正すると、新しいアーティファクトバージョンである「インクリメンタルアーティファクト」が作成されます。返されたアーティファクトは拡張または修正され、新しいバージョンとしてログに記録できます。

new_file

ソースを表示

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

新しい一時ファイルを開いてアーティファクトに追加します。

remove

ソースを表示

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

アイテムをアーティファクトから削除します。

save

ソースを表示

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

アーティファクトに加えた変更を永続化します。

現在 run にいる場合、その run はこのアーティファクトをログに記録します。run にいない場合、アーティファクトを追跡するために “auto” タイプの run が作成されます。

unlink

ソースを表示

unlink() -> None

このアーティファクトが現在ポートフォリオのメンバーである場合、それを解除します（プロモートされたアーティファクトのコレクション）。

used_by

ソースを表示

used_by() -> list[Run]

このアーティファクトを使用した run のリストを取得します。

verify

ソースを表示

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

アーティファクトの内容がマニフェストと一致するかを確認します。

ディレクトリ内のすべてのファイルはチェックサムが計算され、チェックサムはアーティファクトのマニフェストと照合されます。参照は確認されません。

wait

ソースを表示

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

必要であれば、このアーティファクトがログの終了を待ちます。

__getitem__

ソースを表示

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

アーティファクト相対 name に配置されている WBValue オブジェクトを取得します。

__setitem__

ソースを表示

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

item をアーティファクトの name パスに追加します。