アーティファクト - Weights & Biases Documentation

`class` `Artifact`

データセットやモデルのバージョン管理のための、柔軟で軽量なビルディングブロックです。空の W&B Artifact を構築します。 add で始まるメソッドを使用して、アーティファクトのコンテンツを追加します。アーティファクトに必要なすべてのファイルが含まれたら、 run.log_artifact() を呼び出してログを記録できます。

`method` `Artifact.init`

__init__(
    name: 'str',
    type: 'str',
    description: 'str | None' = None,
    metadata: 'dict[str, Any] | None' = None,
    incremental: 'bool' = False,
    use_as: 'str | None' = None,
    storage_region: 'str | None' = None
) → None

Args:

name (str): アーティファクトの人間が読みやすい名前。W&B App UI またはプログラムで特定のアーティファクトを識別するためにこの名前を使用します。 use_artifact Public API を使用して、インタラクティブにアーティファクトを参照できます。名前には、英数字、アンダースコア、ハイフン、ドットを含めることができます。名前はプロジェクト内で一意である必要があります。
type (str): アーティファクトのタイプ。アーティファクトの整理と識別の両方にタイプを使用します。英数字、アンダースコア、ハイフン、ドットを含む任意の文字列を使用できます。一般的なタイプには dataset や model があります。アーティファクトを W&B モデルレジストリにリンクしたい場合は、タイプ文字列に model を含めてください。一部のタイプは内部使用のために予約されており、ユーザーが設定することはできません（job や wandb- で始まるタイプなど）。
description (str | None) = None: アーティファクトの説明。モデルまたはデータセットの Artifacts の場合、チームの標準化されたモデルまたはデータセットカードのドキュメントを追加します。アーティファクトの説明は、 Artifact.description 属性、または W&B App UI から確認できます。W&B は W&B App 内で説明を markdown としてレンダリングします。
metadata (dict[str, Any] | None) = None: アーティファクトに関する追加情報。メタデータはキーと値のペアの辞書として指定します。合計で最大 100 個のキーを指定できます。
incremental: 既存のアーティファクトを修正するには、代わりに Artifact.new_draft() メソッドを使用してください。
use_as: 非推奨です。

Returns: Artifact オブジェクト。

`property` Artifact.aliases

アーティファクトバージョンに割り当てられた、1 つ以上のセマンティックな参照、または識別用の「ニックネーム」のリストです。エイリアスは、プログラムで参照可能な可変の参照です。アーティファクトのエイリアスは、W&B App UI またはプログラムで変更できます。詳細については、 Create new artifact versions を参照してください。 Returns:

list[str]: aliases プロパティの値。

`property` Artifact.collection

このアーティファクトが取得されたコレクションです。コレクションは、アーティファクトバージョンの順序付けられたグループです。このアーティファクトがリンクされているコレクションから取得された場合は、そのコレクションを返します。それ以外の場合は、アーティファクトバージョンの発生元のコレクションを返します。アーティファクトの発生元のコレクションは、ソースシーケンスとして知られています。 Returns:

ArtifactCollection: collection プロパティの値。

`property` Artifact.commit_hash

このアーティファクトがコミットされたときに返されたハッシュです。 Returns:

str: commit_hash プロパティの値。

`property` Artifact.created_at

アーティファクトが作成されたタイムスタンプです。 Returns:

str: created_at プロパティの値。

`property` Artifact.description

アーティファクトの説明です。 Returns:

str | None: description プロパティの値。

`property` Artifact.digest

アーティファクトの論理ダイジェストです。ダイジェストは、アーティファクトのコンテンツのチェックサムです。アーティファクトが現在の latest バージョンと同じダイジェストを持っている場合、 log_artifact は何も実行しません。 Returns:

str: digest プロパティの値。

`property` Artifact.entity

アーティファクトコレクションが属する Entity の名前です。アーティファクトがリンクである場合、Entity はリンク先アーティファクトの Entity になります。 Returns:

str: entity プロパティの値。

`property` Artifact.file_count

ファイルの数（参照を含む）です。 Returns:

int: file_count プロパティの値。

`property` Artifact.history_step

このアーティファクトのソース run の履歴メトリクスを記録した最も近いステップです。 Examples:

run = artifact.logged_by()
if run and (artifact.history_step is not None):
    history = run.sample_history(
        min_step=artifact.history_step,
        max_step=artifact.history_step + 1,
        keys=["my_metric"],
    )

Returns:

int | None: history_step プロパティの値。

`property` Artifact.id

アーティファクトの ID です。 Returns:

str | None: id プロパティの値。

`property` Artifact.is_link

アーティファクトがリンクアーティファクトかどうかを示すブールフラグです。 True: アーティファクトはソースアーティファクトへのリンクアーティファクトです。False: アーティファクトはソースアーティファクトです。 Returns:

bool: is_link プロパティの値。

`property` Artifact.linked_artifacts

ソースアーティファクトのすべてのリンクアーティファクトのリストを返します。このアーティファクトがリンクアーティファクトである場合（artifact.is_link == True）、空のリストを返します。 500 件の結果に制限されています。 Returns:

list[Artifact]: linked_artifacts プロパティの値。

`property` Artifact.manifest

アーティファクトのマニフェストです。マニフェストはそのすべてのコンテンツをリストし、アーティファクトがログに記録された後は変更できません。 Returns:

ArtifactManifest: manifest プロパティの値。

`property` Artifact.metadata

ユーザー定義のアーティファクトメタデータです。アーティファクトに関連付けられた構造化データです。 Returns:

dict: metadata プロパティの値。

`property` Artifact.name

アーティファクト名とアーティファクトのバージョンです。 {collection}:{alias} 形式の文字列です。アーティファクトがログ /保存される前に取得された場合、名前にはエイリアスが含まれません。アーティファクトがリンクである場合、名前はリンク先アーティファクトの名前になります。 Returns:

str: name プロパティの値。

`property` Artifact.project

アーティファクトコレクションが属するプロジェクトの名前です。アーティファクトがリンクである場合、プロジェクトはリンク先アーティファクトのプロジェクトになります。 Returns:

str: project プロパティの値。

`property` Artifact.qualified_name

アーティファクトの Entity/ プロジェクト /名前です。アーティファクトがリンクである場合、qualified name はリンクされたアーティファクトパスの qualified name になります。 Returns:

str: qualified_name プロパティの値。

`property` Artifact.size

アーティファクトの合計サイズ（バイト単位）です。このアーティファクトによって追跡されるすべての参照が含まれます。 Returns:

int: size プロパティの値。

`property` Artifact.source_artifact

最初にログに記録されたアーティファクトであるソースアーティファクトを返します。このアーティファクトがソースアーティファクトである場合（artifact.is_link == False）、それ自体を返します。 Returns:

Artifact: source_artifact プロパティの値。

`property` Artifact.source_collection

アーティファクトのソースコレクションです。ソースコレクションは、アーティファクトがログに記録された元のコレクションです。 Returns:

ArtifactCollection: source_collection プロパティの値。

`property` Artifact.source_entity

ソースアーティファクトの Entity の名前です。 Returns:

str: source_entity プロパティの値。

`property` Artifact.source_name

ソースアーティファクトのアーティファクト名とバージョンです。 {source_collection}:{alias} 形式の文字列です。アーティファクトが保存される前は、バージョンがまだ不明なため、名前のみが含まれます。 Returns:

str: source_name プロパティの値。

`property` Artifact.source_project

ソースアーティファクトのプロジェクトの名前です。 Returns:

str: source_project プロパティの値。

`property` Artifact.source_qualified_name

ソースアーティファクトの source_entity/source_project/source_name です。 Returns:

str: source_qualified_name プロパティの値。

`property` Artifact.source_version

ソースアーティファクトのバージョンです。 v{number} 形式の文字列です。 Returns:

str: source_version プロパティの値。

`property` Artifact.state

アーティファクトのステータスです。“PENDING”、“COMMITTED”、または “DELETED” のいずれかです。 Returns:

str: state プロパティの値。

`property` Artifact.tags

このアーティファクトバージョンに割り当てられた 1 つ以上のタグのリストです。 Returns:

list[str]: tags プロパティの値。

`property` Artifact.ttl

アーティファクトの time-to-live (TTL) ポリシーです。アーティファクトは、TTL ポリシーの期間が経過した後、まもなく削除されます。 None に設定すると、アーティファクトは TTL ポリシーを無効化し、チームのデフォルト TTL があっても削除がスケジュールされません。チーム管理者がデフォルト TTL を定義しており、アーティファクトにカスタムポリシーが設定されていない場合、アーティファクトはチームのデフォルトから TTL ポリシーを継承します。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録または保存されていない場合、継承された TTL を取得できません。

Returns:

timedelta | None: ttl プロパティの値。

`property` Artifact.type

アーティファクトのタイプです。一般的なタイプには dataset や model があります。 Returns:

str: type プロパティの値。

`property` Artifact.updated_at

アーティファクトが最後に更新された時間です。 Returns:

str: updated_at プロパティの値。

`property` Artifact.url

アーティファクトの URL を構築します。 Returns:

str: アーティファクトの URL。

Returns:

str: url プロパティの値。

`property` Artifact.use_as

非推奨です。 Returns:

str | None: use_as プロパティの値。

`property` Artifact.version

アーティファクトのバージョンです。 v{number} 形式の文字列です。これがリンクアーティファクトの場合、バージョンはリンクされたコレクションからのものになります。 Returns:

str: version プロパティの値。

`method` `Artifact.add`

add(
    obj: 'WBValue',
    name: 'StrPath',
    overwrite: 'bool' = False
) → ArtifactManifestEntry

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

obj: 追加するオブジェクト。現在は Bokeh, JoinedTable, PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D, Audio, Image, Video, Html, Object3D のいずれかをサポートしています。
name: オブジェクトを追加するアーティファクト内のパス。
overwrite: True の場合、該当する場合に同じファイルパスを持つ既存のオブジェクトを上書きします。

Returns: 追加されたマニフェストエントリ。 Raises:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定されているため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。

`method` `Artifact.add_dir`

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

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

local_path: ローカルディレクトリーのパス。
name: アーティファクト内のサブディレクトリー名。指定した名前は W&B App UI でアーティファクトの type ごとにネストされて表示されます。デフォルトはアーティファクトのルートです。
skip_cache: True に設定すると、アップロード中にファイルをキャッシュにコピー/移動しません。
policy: デフォルトは “mutable” です。
- mutable: アップロード中の破損を防ぐために、ファイルのテンポラリコピーを作成します。
- immutable: 保護を無効にし、ユーザーがファイルを削除または変更しないことに依存します。
merge: False（デフォルト）の場合、以前の add_dir 呼び出しで既に追加されたファイルの内容が変更されていると ValueError をスローします。 True の場合、変更された内容で既存のファイルを上書きします。常に新しいファイルを追加し、ファイルを削除することはありません。ディレクトリー全体を置き換えるには、 add_dir(local_path, name=my_prefix) を使用してディレクトリーを追加するときに名前を渡し、 remove(my_prefix) を呼び出してディレクトリーを削除してから、再度追加してください。

Raises:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定されているため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。
ValueError: ポリシーは “mutable” または “immutable” である必要があります。

`method` `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

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

local_path: 追加するファイルへのパス。
name: 追加されるファイルに使用するアーティファクト内のパス。デフォルトはファイルのベース名です。
is_tmp: True の場合、衝突を避けるためにファイル名が決定論的に変更されます。
skip_cache: True の場合、アップロード後にファイルをキャッシュにコピーしません。
policy: デフォルトで “mutable” に設定されます。 “mutable” に設定されている場合、アップロード中の破損を防ぐためにファイルのテンポラリコピーを作成します。 “immutable” に設定されている場合、保護を無効にし、ユーザーがファイルを削除または変更しないことに依存します。
overwrite: True の場合、ファイルが既に存在すれば上書きします。

Returns: 追加されたマニフェストエントリ。 Raises:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定されているため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。
ValueError: ポリシーは “mutable” または “immutable” である必要があります。

`method` `Artifact.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: チェックサムとサイズは blob メタデータから取得されます。ストレージアカウントのバージョン管理が有効な場合、バージョン ID も追跡されます。
file: チェックサムとサイズはファイルシステムから取得されます。このスキームは、追跡したいが必ずしもアップロードしたくないファイルを含む NFS 共有やその他の外部マウントボリュームがある場合に便利です。

その他のスキームの場合、ダイジェストは URI のハッシュになり、サイズは空白のままになります。 Args:

uri: 追加する参照の URI パス。URI パスには、別のアーティファクトのエントリへの参照を保存するために Artifact.get_entry から返されたオブジェクトを指定できます。
name: この参照のコンテンツを配置するアーティファクト内のパス。
checksum: 参照 URI にあるリソースのチェックサムを実行するかどうか。完全性の自動検証が可能になるため、チェックサムの実行を強くお勧めします。チェックサムを無効にするとアーティファクトの作成速度は上がりますが、参照ディレクトリーが反復処理されないため、ディレクトリー内のオブジェクトはアーティファクトに保存されません。参照オブジェクトを追加する際は checksum=False に設定することをお勧めします。その場合、参照 URI が変更された場合にのみ新しいバージョンが作成されます。
max_objects: ディレクトリーまたはバケットストアのプレフィックスを指す参照を追加するときに考慮するオブジェクトの最大数。デフォルトでは、Amazon S3、GCS、Azure、およびローカルファイルの最大許容オブジェクト数は 10,000,000 です。他の URI スキーマに最大数はありません。

Returns: 追加されたマニフェストエントリ。 Raises:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定されているため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。

`method` `Artifact.checkout`

checkout(root: 'str | None' = None) → str

指定したルートディレクトリーをアーティファクトの内容で置き換えます。警告：これにより、アーティファクトに含まれていない root 内のすべてのファイルが削除されます。 Args:

root: このアーティファクトのファイルで置き換えるディレクトリー。

Returns: チェックアウトされたコンテンツのパス。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.delete`

delete(delete_aliases: 'bool' = False) → None

アーティファクトとそのファイルを削除します。リンクされたアーティファクトに対して呼び出された場合、リンクのみが削除され、ソースアーティファクトは影響を受けません。ソースアーティファクトとコレクションの間のリンクを削除するには、 Artifact.delete() の代わりに Artifact.unlink() を使用してください。 Args:

delete_aliases: True に設定すると、アーティファクトに関連付けられたすべてのエイリアスを削除します。 False の場合、アーティファクトに既存のエイリアスがあると例外を発生させます。このパラメータは、アーティファクトがリンク先のコレクションから取得された場合は無視されます。

Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.download`

download(
    root: 'StrPath | None' = None,
    allow_missing_references: 'bool' = False,
    skip_cache: 'bool | None' = None,
    path_prefix: 'StrPath | None' = None,
    multipart: 'bool | None' = None
) → FilePathStr

アーティファクトの内容を指定したルートディレクトリーにダウンロードします。 root 内にある既存のファイルは変更されません。 root の内容をアーティファクトと完全に一致させたい場合は、 download を呼び出す前に root を明示的に削除してください。 Args:

root: W&B がアーティファクトのファイルを保存するディレクトリー。
allow_missing_references: True に設定すると、参照ファイルのダウンロード中に無効な参照パスを無視します。
skip_cache: True に設定すると、ダウンロード時にアーティファクトキャッシュをスキップし、W&B は各ファイルをデフォルトのルートまたは指定されたダウンロードディレクトリーにダウンロードします。
path_prefix: 指定した場合、指定されたプレフィックスで始まるパスを持つファイルのみがダウンロードされます。unix 形式（フォワードスラッシュ）を使用します。
multipart: None（デフォルト）に設定すると、個々のファイルサイズが 2GB を超える場合にマルチパートダウンロードを使用して並列にダウンロードされます。 True または False に設定すると、ファイルサイズに関係なく並列またはシリアルにダウンロードされます。

Returns: ダウンロードされたコンテンツへのパス。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.file`

file(root: 'str | None' = None) → StrPath

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

root: ファイルを保存するルートディレクトリー。デフォルトは ./artifacts/self.name/ です。

Returns: ダウンロードされたファイルのフルパス。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。
ValueError: アーティファクトに複数のファイルが含まれている場合。

`method` `Artifact.files`

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

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

names: リストしたいアーティファクトのルートからの相対ファイル名パス。
per_page: 1 回のリクエストで返すファイルの数。

Returns: File オブジェクトを含むイテレータ。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.finalize`

finalize() → None

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

`method` `Artifact.get`

get(name: 'str') → WBValue | None

アーティファクト相対の name にある WBValue オブジェクトを取得します。 Args:

name: 取得するアーティファクト相対名。

Returns: run.log() でログ記録でき、W&B UI で視覚化できる W&B オブジェクト。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていないか、 run がオフラインの場合。

`method` `Artifact.get_added_local_path_name`

get_added_local_path_name(local_path: 'str') → str | None

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

local_path: アーティファクト相対名に解決するローカルパス。

Returns: アーティファクト相対名。

`method` `Artifact.get_entry`

get_entry(name: 'StrPath') → ArtifactManifestEntry

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

name: 取得するアーティファクト相対名。

Returns: W&B オブジェクト。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていないか、 run がオフラインの場合。
KeyError: アーティファクトに指定された名前のエントリが含まれていない場合。

`method` `Artifact.get_path`

get_path(name: 'StrPath') → ArtifactManifestEntry

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

`method` `Artifact.is_draft`

is_draft() → bool

アーティファクトが保存されていないかどうかを確認します。 Returns: ブール値。アーティファクトが保存されている場合は False、保存されていない場合は True。

`method` `Artifact.json_encode`

json_encode() → dict[str, Any]

JSON 形式にエンコードされたアーティファクトを返します。 Returns: アーティファクトの属性を表す string キーを持つ dict。

`method` `Artifact.link`

link(target_path: 'str', aliases: 'Iterable[str] | None' = None) → Artifact

このアーティファクトをコレクションにリンクします。 Args:

target_path: コレクションのパス。パスは、プレフィックス “wandb-registry-” とレジストリ名、およびコレクション名 wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME} で構成されます。
aliases: リンクされたアーティファクトに 1 つ以上のエイリアスを追加します。 “latest” エイリアスは、リンクした最新のアーティファクトに自動的に適用されます。

Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

Returns: リンクされたアーティファクト。

`method` `Artifact.logged_by`

logged_by() → Run | None

最初にアーティファクトをログ記録した W&B run を取得します。 Returns: 最初にアーティファクトをログ記録した W&B run の名前。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.new_draft`

new_draft() → Artifact

このコミット済みアーティファクトと同じコンテンツを持つ新しいドラフトアーティファクトを作成します。既存のアーティファクトを修正すると、「増分アーティファクト」として知られる新しいアーティファクトバージョンが作成されます。返されたアーティファクトは拡張または修正して、新しいバージョンとしてログ記録できます。 Returns: Artifact オブジェクト。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.new_file`

new_file(
    name: 'str',
    mode: 'str' = 'x',
    encoding: 'str | None' = None
) → Iterator[IO]

新しいテンポラリファイルを開き、それをアーティファクトに追加します。 Args:

name: アーティファクトに追加する新しいファイルの名前。
mode: 新しいファイルを開くために使用するファイルアクセスモード。
encoding: 新しいファイルを開くために使用するエンコーディング。

Returns: 書き込み可能な新しいファイルオブジェクト。閉じると、ファイルは自動的にアーティファクトに追加されます。 Raises:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定されているため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。

`method` `Artifact.remove`

remove(item: 'StrPath | ArtifactManifestEntry') → None

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

item: 削除するアイテム。特定のマニフェストエントリ、またはアーティファクト相対パスの名前を指定できます。アイテムがディレクトリーに一致する場合、そのディレクトリー内のすべてのアイテムが削除されます。

Raises:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定されているため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。
FileNotFoundError: アイテムがアーティファクト内で見つからない場合。

`method` `Artifact.save`

save(
    project: 'str | None' = None,
    settings: 'wandb.Settings | None' = None
) → None

アーティファクトに加えられた変更を永続化します。現在 run 内にいる場合、その run がこのアーティファクトをログ記録します。現在 run 内にいない場合、このアーティファクトを追跡するためにタイプ “auto” の run が作成されます。 Args:

project: run がまだコンテキストにない場合に、アーティファクトに使用するプロジェクト。
settings: 自動 run を初期化するときに使用する設定オブジェクト。テストハーネスで最も一般的に使用されます。

`method` `Artifact.unlink`

unlink() → None

このアーティファクトがアーティファクトコレクションのリンクされたメンバーである場合、リンクを解除します。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。
ValueError: アーティファクトがどのコレクションにもリンクされていない場合。

`method` `Artifact.used_by`

used_by() → list[Run]

このアーティファクトおよびそのリンクされたアーティファクトを使用した run のリストを取得します。 Returns: Run オブジェクトのリスト。 Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。

`method` `Artifact.verify`

verify(root: 'str | None' = None) → None

アーティファクトの内容がマニフェストと一致することを確認します。ディレクトリー内のすべてのファイルのチェックサムが計算され、そのチェックサムがアーティファクトのマニフェストと照合されます。参照は検証されません。 Args:

root: 検証するディレクトリー。None の場合、アーティファクトは ’./artifacts/self.name/’ にダウンロードされます。

Raises:

ArtifactNotLoggedError: アーティファクトがログに記録されていない場合。
ValueError: 検証に失敗した場合。

`method` `Artifact.wait`

wait(timeout: 'int | None' = None) → Artifact

必要に応じて、このアーティファクトのログ記録が完了するまで待機します。 Args:

timeout: 待機する時間（秒単位）。

Returns: Artifact オブジェクト。

Guides

Integrations

Tutorials

Reference

​class Artifact

​method Artifact.__init__

​property Artifact.aliases

​property Artifact.collection

​property Artifact.commit_hash

​property Artifact.created_at

​property Artifact.description

​property Artifact.digest

​property Artifact.entity

​property Artifact.file_count

​property Artifact.history_step

​property Artifact.id

​property Artifact.is_link

​property Artifact.linked_artifacts

​property Artifact.manifest

​property Artifact.metadata

​property Artifact.name

​property Artifact.project

​property Artifact.qualified_name

​property Artifact.size

​property Artifact.source_artifact

​property Artifact.source_collection

​property Artifact.source_entity

​property Artifact.source_name

​property Artifact.source_project

​property Artifact.source_qualified_name

​property Artifact.source_version

​property Artifact.state

​property Artifact.tags

​property Artifact.ttl

​property Artifact.type

​property Artifact.updated_at

​property Artifact.url

​property Artifact.use_as

​property Artifact.version

​method Artifact.add

​method Artifact.add_dir

​method Artifact.add_file

​method Artifact.add_reference

​method Artifact.checkout

​method Artifact.delete

​method Artifact.download

​method Artifact.file

​method Artifact.files

​method Artifact.finalize

​method Artifact.get

​method Artifact.get_added_local_path_name

​method Artifact.get_entry

​method Artifact.get_path

​method Artifact.is_draft

​method Artifact.json_encode

​method Artifact.link

​method Artifact.logged_by

​method Artifact.new_draft

​method Artifact.new_file

​method Artifact.remove

​method Artifact.save

​method Artifact.unlink

​method Artifact.used_by

​method Artifact.verify

​method Artifact.wait

`class` `Artifact`

`method` `Artifact.init`

`property` Artifact.aliases

`property` Artifact.collection

`property` Artifact.commit_hash

`property` Artifact.created_at

`property` Artifact.description

`property` Artifact.digest

`property` Artifact.entity

`property` Artifact.file_count

`property` Artifact.history_step

`property` Artifact.id

`property` Artifact.is_link

`property` Artifact.linked_artifacts

`property` Artifact.manifest

`property` Artifact.metadata

`property` Artifact.name

`property` Artifact.project

`property` Artifact.qualified_name

`property` Artifact.size

`property` Artifact.source_artifact

`property` Artifact.source_collection

`property` Artifact.source_entity

`property` Artifact.source_name

`property` Artifact.source_project

`property` Artifact.source_qualified_name

`property` Artifact.source_version

`property` Artifact.state

`property` Artifact.tags

`property` Artifact.ttl

`property` Artifact.type

`property` Artifact.updated_at

`property` Artifact.url

`property` Artifact.use_as

`property` Artifact.version

`method` `Artifact.add`

`method` `Artifact.add_dir`

`method` `Artifact.add_file`

`method` `Artifact.add_reference`

`method` `Artifact.checkout`

`method` `Artifact.delete`

`method` `Artifact.download`

`method` `Artifact.file`

`method` `Artifact.files`

`method` `Artifact.finalize`

`method` `Artifact.get`

`method` `Artifact.get_added_local_path_name`

`method` `Artifact.get_entry`

`method` `Artifact.get_path`

`method` `Artifact.is_draft`

`method` `Artifact.json_encode`

`method` `Artifact.link`

`method` `Artifact.logged_by`

`method` `Artifact.new_draft`

`method` `Artifact.new_file`

`method` `Artifact.remove`

`method` `Artifact.save`

`method` `Artifact.unlink`

`method` `Artifact.used_by`

`method` `Artifact.verify`

`method` `Artifact.wait`