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

`class` `Artifact`

データセットおよびモデルのバージョニングのための、柔軟で軽量な構成要素です。空の W&B アーティファクトを作成します。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

引数:

name (str): アーティファクトの人間が読める名前。W&B App の UI またはプログラムから特定のアーティファクトを識別するためにこの名前を使用します。use_artifact Public API を使って、対話的にアーティファクトを参照できます。名前には英数字、アンダースコア、ハイフン、ドットを含めることができます。名前はプロジェクト全体で一意である必要があります。
type (str): アーティファクトの種類。アーティファクトの種類を使って、アーティファクトを整理および区別します。英数字、アンダースコア、ハイフン、ドットを含む任意の文字列を使用できます。一般的な種類には dataset や model があります。アーティファクトを W&B Model Registry にリンクしたい場合は、種類の文字列に model を含めてください。一部の種類は内部使用のために予約されており、ユーザーが設定することはできません。そのような種類には job や、wandb- で始まる種類が含まれます。
description (str | None) = None: アーティファクトの説明。Model または Dataset アーティファクトの場合、チームで標準化したモデルカードまたはデータセットカードのドキュメントを追加します。プログラムからは 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: 非推奨。

戻り値: Artifact オブジェクト。

`property` Artifact.aliases

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

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

`property` Artifact.collection

このアーティファクトが取得されるコレクションです。コレクションとは、順序付きのアーティファクトバージョンのグループです。このアーティファクトがリンクされているコレクションから取得される場合は、そのコレクションを返します。それ以外の場合は、そのアーティファクトバージョンの元になっているコレクションを返します。アーティファクトの元になっているコレクションは、ソースシーケンス (source sequence) と呼ばれます。 戻り値:

ArtifactCollection: collection プロパティの値。

`property` Artifact.commit_hash

このアーティファクトをコミットしたときのハッシュ値。 戻り値:

str: commit_hash プロパティの値。

`property` Artifact.created_at

アーティファクトが作成された時刻のタイムスタンプ。 戻り値:

str: created_at プロパティの値。

`property` Artifact.description

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

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

`property` Artifact.digest

アーティファクトの論理的なダイジェストです。ダイジェストはアーティファクト内容のチェックサムです。あるアーティファクトが現在の latest バージョンと同じダイジェストを持つ場合、log_artifact は何も処理を行いません (no-op)。 戻り値:

str: digest プロパティの値。

`property` Artifact.entity

アーティファクトコレクションが属するエンティティの名前。アーティファクトがリンクの場合、この値はリンク先アーティファクトのエンティティになる。 戻り値:

str: entity プロパティの値。

`property` Artifact.file_count

ファイル数（参照を含む）。 戻り値:

int: file_count プロパティの値。

`property` Artifact.history_step

このアーティファクトのソース run において履歴メトリクスがログされた、最も近いステップ。例:

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"],
     )

戻り値:

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

`property` Artifact.id

アーティファクトのID。 戻り値:

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

`property` Artifact.is_link

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

bool: is_link プロパティの値。

`property` Artifact.linked_artifacts

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

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

`property` Artifact.manifest

アーティファクトのマニフェスト。マニフェストにはアーティファクト内のすべての内容が含まれており、アーティファクトがログに記録された後は変更できません。 戻り値:

ArtifactManifest: manifest プロパティの値。

`property` Artifact.metadata

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

dict: metadata プロパティの値。

`property` Artifact.name

アーティファクトの名前とバージョン。 {collection}:{alias} という形式の文字列。アーティファクトがログ／保存される前に取得すると、名前には alias が含まれない。アーティファクトがリンクアーティファクトである場合、名前はリンク先アーティファクトの名前になる。 戻り値:

str: name プロパティの値。

`property` Artifact.project

このアーティファクトコレクションが属しているプロジェクトの名前。アーティファクトがリンクの場合、project はリンク先アーティファクトのプロジェクトになります。 戻り値:

str: project プロパティの値。

`property` Artifact.qualified_name

アーティファクトの entity/project/name。アーティファクトがリンクの場合、qualified_name はリンク先アーティファクトパスの qualified_name になります。 Returns:

str: qualified_name プロパティの値。

`property` Artifact.size

アーティファクトの合計サイズ（バイト数）。このアーティファクトが追跡するすべての参照を含みます。 戻り値:

int: size プロパティの値。

`property` Artifact.source_artifact

元のログ済みアーティファクトであるソースアーティファクトを返します。このアーティファクトがソースアーティファクト（artifact.is_link == False）である場合は、自身を返します。 Returns:

Artifact: source_artifact プロパティの値。

`property` Artifact.source_collection

アーティファクトのソースコレクション。ソースコレクションは、そのアーティファクトがログされた元のコレクションです。 戻り値:

ArtifactCollection: source_collection プロパティの値。

`property` Artifact.source_entity

元となるアーティファクトのエンティティ名。 戻り値:

str: source_entity プロパティの値。

`property` Artifact.source_name

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

str: source_name プロパティの値。

`property` Artifact.source_project

元のアーティファクトのプロジェクト名。 戻り値:

str: source_project プロパティの値。

`property` Artifact.source_qualified_name

ソースアーティファクトの source_entity/source_project/source_name を示します。 戻り値:

str: source_qualified_name プロパティの値。

`property` Artifact.source_version

元となるアーティファクトのバージョン。 v{number} 形式の文字列。 戻り値:

str: source_version プロパティの値。

`property` Artifact.state

アーティファクトの状態。"PENDING"、"COMMITTED"、"DELETED" のいずれかです。 戻り値:

str: state プロパティの値。

`property` Artifact.tags

このアーティファクトバージョンに割り当てられている 1 つ以上のタグのリスト。 戻り値:

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 があります。 戻り値:

str: type プロパティの値。

`property` Artifact.updated_at

アーティファクトが最後に更新された時刻です。 戻り値:

str: updated_at プロパティの値。

`property` Artifact.url

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

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

戻り値:

str: url プロパティの値。

`property` Artifact.use_as

非推奨です。 戻り値:

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

`property` Artifact.version

アーティファクトのバージョン。 v{number} という形式の文字列です。リンクアーティファクトである場合は、バージョンはリンク先コレクションのものになります。 戻り値:

str: version プロパティの値。

`メソッド` `Artifact.add`

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

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

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

戻り値: 追加されたマニフェストエントリ 例外:

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

`メソッド` `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

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

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

送出される例外:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定済みのため、変更できません。代わりに新しいアーティファクトバージョンをログしてください。
ValueError: policy は “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

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

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

戻り値: 追加されたマニフェストエントリ。 例外:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定済みのため変更できません。代わりに新しいアーティファクトバージョンをログしてください。
ValueError: policy は “mutable” または “immutable” でなければなりません

`メソッド` `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 にアップロードされません。詳細は、外部ファイルの追跡を参照してください。デフォルトで、以下のスキームがサポートされています:

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: 現在のアーティファクトバージョンは確定済みのため、変更を加えることはできません。代わりに新しいアーティファクトバージョンをログしてください。

`メソッド` `Artifact.checkout`

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

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

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

戻り値: チェックアウトした内容へのパス。 例外:

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

`メソッド` `Artifact.delete`

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

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

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

送出される例外:

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

`メソッド` `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 を明示的に削除してください。 引数:

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

戻り値: ダウンロードした内容へのパス。 例外:

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

`method` `Artifact.file`

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

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

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

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

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

`メソッド` `Artifact.files`

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

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

names: 一覧表示したいファイルのパス。アーティファクトのルートからの相対パス。
per_page: リクエストごとに返すファイル数。

戻り値: File オブジェクトを含むイテレータ。 例外:

ArtifactNotLoggedError: アーティファクトがログされていない場合に送出されます。

`メソッド` `Artifact.finalize`

finalize() → None

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

`メソッド` `Artifact.get`

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

アーティファクト内で相対パス name にある WBValue オブジェクトを取得します。 引数:

name: 取得するアーティファクト内での相対パス名。

戻り値: run.log() でログに記録でき、W&B UI で可視化できる W&B オブジェクト。 例外:

ArtifactNotLoggedError: アーティファクトがログされていない場合、または run がオフラインの場合にスローされます。

`method` `Artifact.get_added_local_path_name`

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

ローカルファイルシステム上のパスから追加されたファイルのアーティファクト相対名を取得します。 引数:

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

戻り値: アーティファクト相対名。

`メソッド` `Artifact.get_entry`

get_entry(name: 'StrPath') → ArtifactManifestEntry

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

name: 取得するエントリの、アーティファクト内での相対パス名

戻り値: W&B オブジェクト。 送出される例外:

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

`メソッド` `Artifact.get_path`

get_path(name: 'StrPath') → ArtifactManifestEntry

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

`メソッド` `Artifact.is_draft`

is_draft() → bool

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

`メソッド` `Artifact.json_encode`

json_encode() → dict[str, Any]

アーティファクトを JSON 形式にエンコードして返します。 戻り値: アーティファクトの属性を表す、string をキーに持つ dict。

`method` `Artifact.link`

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

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

target_path: コレクションのパス。wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME} という形式で、接頭辞 "wandb-registry-" にレジストリ名とコレクション名を組み合わせたものです。
aliases: リンクされたアーティファクトに 1 つ以上のエイリアスを追加します。"latest" エイリアスは、リンクした最新のアーティファクトに自動的に適用されます。

発生しうる例外:

ArtifactNotLoggedError: アーティファクトがログされていない場合に送出されます。

戻り値: リンクされたアーティファクト。

`method` `Artifact.logged_by`

logged_by() → Run | None

最初にこのアーティファクトをログした W&B run を取得します。 戻り値: 最初にこのアーティファクトをログした W&B run の名前を返します。 例外:

ArtifactNotLoggedError: アーティファクトがログされていない場合に送出されます。

`メソッド` `Artifact.new_draft`

new_draft() → Artifact

このコミット済みアーティファクトと同じ内容を持つ新しいドラフトアーティファクトを作成します。既存のアーティファクトを変更すると、“インクリメンタルアーティファクト” と呼ばれる新しいバージョンが作成されます。返されるアーティファクトは拡張または変更し、新しいバージョンとしてログできます。 戻り値: Artifact オブジェクト。 例外:

ArtifactNotLoggedError: アーティファクトがログされていない場合に送出されます。

`メソッド` `Artifact.new_file`

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

新しい一時ファイルを開き、アーティファクトに追加します。 引数:

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

戻り値: 書き込み可能な新しいファイルオブジェクト。クローズ時に、そのファイルは自動的にアーティファクトに追加されます。 送出される例外:

ArtifactFinalizedError: 現在のアーティファクトバージョンは finalize 済みのため変更できません。代わりに新しいアーティファクトバージョンをログしてください。

`メソッド` `Artifact.remove`

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

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

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

スローされる例外:

ArtifactFinalizedError: 現在のアーティファクトバージョンは確定済みのため、変更できません。代わりに新しいアーティファクトバージョンをログしてください。
FileNotFoundError: item がアーティファクト内に存在しない場合。

`メソッド` `Artifact.save`

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

アーティファクトに対して行われた変更を永続化します。現在 run のコンテキスト内にいる場合、その run がこのアーティファクトをログします。run のコンテキスト内にいない場合は、このアーティファクトを追跡するために type が “auto” の run が作成されます。 Args:

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

`method` `Artifact.unlink`

unlink() → None

このアーティファクトがアーティファクトコレクションにリンクされている場合、そのリンクを解除します。 例外:

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

`method` `Artifact.used_by`

used_by() → list[Run]

このアーティファクトと、それにリンクされているアーティファクトを使用した run の一覧を取得します。 戻り値: Run オブジェクトのリスト。 例外:

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

`method` `Artifact.verify`

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

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

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

送出される例外:

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

`method` `Artifact.wait`

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

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

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

戻り値: Artifact オブジェクト。

ガイド

インテグレーション

リファレンス

​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

​メソッド Artifact.add

​メソッド Artifact.add_dir

​method Artifact.add_file

​メソッド Artifact.add_reference

​メソッド Artifact.checkout

​メソッド Artifact.delete

​メソッド Artifact.download

​method Artifact.file

​メソッド Artifact.files

​メソッド Artifact.finalize

​メソッド Artifact.get

​method Artifact.get_added_local_path_name

​メソッド Artifact.get_entry

​メソッド Artifact.get_path

​メソッド Artifact.is_draft

​メソッド Artifact.json_encode

​method Artifact.link

​method Artifact.logged_by

​メソッド Artifact.new_draft

​メソッド Artifact.new_file

​メソッド Artifact.remove

​メソッド 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

`メソッド` `Artifact.add`

`メソッド` `Artifact.add_dir`

`method` `Artifact.add_file`

`メソッド` `Artifact.add_reference`

`メソッド` `Artifact.checkout`

`メソッド` `Artifact.delete`

`メソッド` `Artifact.download`

`method` `Artifact.file`

`メソッド` `Artifact.files`

`メソッド` `Artifact.finalize`

`メソッド` `Artifact.get`

`method` `Artifact.get_added_local_path_name`

`メソッド` `Artifact.get_entry`

`メソッド` `Artifact.get_path`

`メソッド` `Artifact.is_draft`

`メソッド` `Artifact.json_encode`

`method` `Artifact.link`

`method` `Artifact.logged_by`

`メソッド` `Artifact.new_draft`

`メソッド` `Artifact.new_file`

`メソッド` `Artifact.remove`

`メソッド` `Artifact.save`

`method` `Artifact.unlink`

`method` `Artifact.used_by`

`method` `Artifact.verify`

`method` `Artifact.wait`