> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# アーティファクト

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/main/wandb/sdk/artifacts/artifact.py#L128" />

<h2 id="class-wandbartifact">
  <Badge color="yellow" size="lg" shape="rounded">クラス</Badge> wandb.Artifact
</h2>

データセットとモデルのバージョン管理のための柔軟で軽量な構成要素。

空の W\&B アーティファクトを作成します。`add` で始まるメソッドでアーティファクトの内容を追加します。アーティファクトに必要なファイルがすべて揃ったら、`run.log_artifact()` を呼び出してログします。

```python theme={"system"}
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,
digest_algorithm: "Literal['MD5', 'XXH128']" = 'MD5'
```

<h2 id="args">
  引数
</h2>

<ResponseField name="name" type="str">
  アーティファクトの人間が読みやすい名前。W\&B アプリ UI またはプログラムで特定のアーティファクトを識別するために名前を使用します。`use_artifact` Public API でアーティファクトをインタラクティブに参照できます。名前には文字、数字、アンダースコア、ハイフン、ドットを含めることができます。名前は project 全体で一意である必要があります。
</ResponseField>

<ResponseField name="type" type="str">
  アーティファクトのタイプ。アーティファクトのタイプを使用して、アーティファクトを整理および区別します。文字、数字、アンダースコア、ハイフン、ドットを含む任意の string を使用できます。一般的なタイプには `dataset` または `model` が含まれます。アーティファクトを W\&B Model Registry にリンクする場合は、タイプ string に `model` を含めます。一部のタイプは内部使用のために予約されており、ユーザーが設定できないことに注意してください。そのようなタイプには `job` および `wandb-` で始まるタイプが含まれます。
</ResponseField>

<ResponseField name="description" type="str | None">
  アーティファクトの説明。モデルまたはデータセットのアーティファクトの場合、標準化されたチームモデルまたはデータセットカードのドキュメントを追加します。アーティファクトの説明を `Artifact.description` 属性でプログラム的に、または W\&B アプリ UI でプログラム的に表示します。W\&B は W\&B アプリ で説明を Markdown としてレンダリングします。
</ResponseField>

<ResponseField name="metadata" type="dict[str, Any] | None">
  アーティファクトに関する追加情報。メタデータを key-value ペアの辞書として指定します。合計 100 個を超えるキーを指定することはできません。
</ResponseField>

<ResponseField name="incremental" type="bool">
  既存のアーティファクトを変更するには、代わりに `Artifact.new_draft()` メソッドを使用します。
</ResponseField>

<ResponseField name="use_as" type="str | None">
  非推奨。
</ResponseField>

<ResponseField name="storage_region" type="str | None">
  説明は提供されていません。
</ResponseField>

<ResponseField name="digest_algorithm" type="Literal['MD5', 'XXH128']">
  アーティファクトに使用するダイジェストアルゴリズム。デフォルトは MD5 です。XXH128 に設定した場合、アーティファクトはすでに MD5 を使用しているコレクションの一部でない限り、XXH128 アルゴリズムを使用してハッシュされます。0.29.0 より前の SDK バージョンでの `artifact.verify()` の呼び出しは、常に XXH128 アーティファクトで失敗します。
</ResponseField>

<h2 id="properties">
  プロパティ
</h2>

<ResponseField name="aliases" type="list[str]">
  アーティファクトのバージョンに割り当てられた、意味的にわかりやすい 1 つ以上の参照名、または

  識別用の「ニックネーム」のリストです。

  エイリアスは変更可能な参照で、プログラムから参照できます。
  アーティファクトのエイリアスは、W\&B アプリ UI またはプログラムから変更できます。
  詳細については、[新しいアーティファクトのバージョンを作成する](/ja/products/wandb/artifacts/create-a-new-artifact-version)
  を参照してください。
</ResponseField>

<ResponseField name="collection" type="ArtifactCollection">
  このアーティファクトの取得元のコレクションです。

  コレクションは、アーティファクトのバージョンを順序付けたグループです。
  このアーティファクトがリンク先のコレクションから取得された場合は、
  そのコレクションを返します。それ以外の場合は、アーティファクトのバージョンの
  作成元のコレクションを返します。

  アーティファクトの作成元のコレクションは、
  ソースシーケンスと呼ばれます。
</ResponseField>

<ResponseField name="commit_hash" type="str">
  このアーティファクトのコミット時に返されたハッシュです。
</ResponseField>

<ResponseField name="created_at" type="str">
  アーティファクトの作成日時を示すタイムスタンプです。
</ResponseField>

<ResponseField name="description" type="str | None">
  アーティファクトの説明です。
</ResponseField>

<ResponseField name="digest" type="str">
  アーティファクトの論理ダイジェストです。

  ダイジェストは、アーティファクトの内容のチェックサムです。アーティファクトのダイジェストが
  現在の `latest` バージョンと同じ場合、`log_artifact` は no-op になります。
</ResponseField>

<ResponseField name="digest_algorithm" type="ArtifactDigestAlgorithm">
  アーティファクトのダイジェストの計算に使用されるダイジェストアルゴリズムです。
</ResponseField>

<ResponseField name="entity" type="str">
  アーティファクト コレクションが属する entity の名前です。

  アーティファクトがリンクの場合、リンクされたアーティファクトの entity になります。
</ResponseField>

<ResponseField name="file_count" type="int">
  ファイル数 (参照を含む) です。
</ResponseField>

<ResponseField name="history_step" type="int | None">
  このアーティファクトのソース run で履歴メトリクスがログされた、最も近いステップです。
</ResponseField>

<ResponseField name="id" type="str | None">
  アーティファクトの ID です。
</ResponseField>

<ResponseField name="is_link" type="bool">
  アーティファクトがリンクアーティファクトかどうかを示すブール値のフラグです。

  True: アーティファクトは、ソースアーティファクトへのリンクアーティファクトです。
  False: アーティファクトはソースアーティファクトです。
</ResponseField>

<ResponseField name="linked_artifacts" type="list[Artifact]">
  ソースアーティファクトにリンクされているすべてのアーティファクトのリストを返します。

  このアーティファクトがリンクアーティファクト (`artifact.is_link == True`) の場合は、
  空のリストを返します。

  結果は最大 500 件です。
</ResponseField>

<ResponseField name="linked_at" type="str | None">
  このアーティファクトが現在のコレクションにリンクされた時刻です。

  リンクされたアーティファクトでのみ有効で、それ以外の場合は `None` を返します。
</ResponseField>

<ResponseField name="manifest" type="ArtifactManifest">
  アーティファクトのマニフェストです。

  マニフェストにはアーティファクトのすべての内容が記載されており、アーティファクトがログされた後は
  変更できません。
</ResponseField>

<ResponseField name="metadata" type="dict">
  ユーザー定義のアーティファクトのメタデータです。

  アーティファクトに関連付けられた構造化データです。
</ResponseField>

<ResponseField name="name" type="str">
  アーティファクトの名前とバージョンです。

  `{collection}:{alias}` 形式の string です。アーティファクトがログまたは保存される前に
  取得した場合、名前にはエイリアスが含まれません。
  アーティファクトがリンクの場合は、リンクされたアーティファクトの名前になります。
</ResponseField>

<ResponseField name="project" type="str">
  アーティファクト コレクションが属する project の名前です。

  アーティファクトがリンクの場合、リンクされたアーティファクトの project になります。
</ResponseField>

<ResponseField name="qualified_name" type="str">
  アーティファクトの entity/project/name です。

  アーティファクトがリンクの場合、修飾名はリンクされたアーティファクト パスの
  修飾名になります。
</ResponseField>

<ResponseField name="size" type="int">
  アーティファクトの合計サイズ (バイト単位) です。

  このアーティファクトで追跡されるすべての参照を含みます。
</ResponseField>

<ResponseField name="source_artifact" type="Artifact">
  ソースアーティファクト (最初にログされた元のアーティファクト) を返します。

  このアーティファクトがソースアーティファクト (`artifact.is_link == False`) の場合は、
  自身を返します。
</ResponseField>

<ResponseField name="source_collection" type="ArtifactCollection">
  アーティファクトのソースコレクションです。

  ソースコレクションとは、アーティファクトのログ元のコレクションです。
</ResponseField>

<ResponseField name="source_entity" type="str">
  ソースアーティファクトの entity の名前です。
</ResponseField>

<ResponseField name="source_name" type="str">
  ソースアーティファクトの名前とバージョンです。

  `{source_collection}:{alias}` 形式の string です。アーティファクトが
  保存される前はバージョンが確定していないため、名前のみが含まれます。
</ResponseField>

<ResponseField name="source_project" type="str">
  ソースアーティファクトの project の名。
</ResponseField>

<ResponseField name="source_qualified_name" type="str">
  ソースアーティファクトの source\_entity/source\_project/source\_name。
</ResponseField>

<ResponseField name="source_version" type="str">
  ソースアーティファクトのバージョン。

  `v{number}` 形式の string。
</ResponseField>

<ResponseField name="state" type="str">
  アーティファクトの状態。"PENDING"、"COMMITTED"、"DELETED" のいずれか。
</ResponseField>

<ResponseField name="tags" type="list[str]">
  このアーティファクトのバージョンに割り当てられた 1 つ以上のタグのリスト。
</ResponseField>

<ResponseField name="ttl" type="timedelta | None">
  アーティファクトの TTL ポリシー。

  TTL ポリシーの期間が経過すると、アーティファクトはまもなく削除されます。
  `None` に設定すると、アーティファクトは TTL ポリシーを無効化し、チームのデフォルト TTL が存在する場合でも削除対象になりません。
  チーム管理者がデフォルト TTL を定義し、アーティファクトに custom ポリシーが設定されていない場合、アーティファクトはチームのデフォルトから TTL ポリシーを継承します。
</ResponseField>

<ResponseField name="type" type="str">
  アーティファクトのタイプ。一般的なタイプには `dataset` や `model` があります。
</ResponseField>

<ResponseField name="updated_at" type="str">
  アーティファクトが最後に更新された時刻。
</ResponseField>

<ResponseField name="url" type="The URL of the artifact.">
  アーティファクトの URL を構築します。
</ResponseField>

<ResponseField name="use_as" type="str | None">
  非推奨。
</ResponseField>

<ResponseField name="version" type="str">
  アーティファクトのバージョン。

  `v{number}` 形式の string。
  リンクアーティファクトの場合、バージョンはリンクされたコレクションのものになります。
</ResponseField>

<h2 id="methods">
  メソッド
</h2>

<h3 id="method-artifactadd">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.add()
</h3>

```python theme={"system"}
self,
obj: 'WBValue',
name: 'StrPath',
overwrite: 'bool' = False
```

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

<h5 id="arguments">
  引数
</h5>

<ResponseField name="obj" type="WBValue">
  追加するオブジェクト。現在、Bokeh、JoinedTable、PartitionedTable、Table、Classes、ImageMask、BoundingBoxes2D、Audio、Image、Video、Html、Object3D のいずれかをサポートしています
</ResponseField>

<ResponseField name="name" type="StrPath">
  アーティファクト内にオブジェクトを追加するパス。
</ResponseField>

<ResponseField name="overwrite" type="bool">
  True の場合、該当する場合は同じファイルパスを持つ既存のオブジェクトを上書きします。
</ResponseField>

<h5 id="raises">
  送出される例外
</h5>

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

<h3 id="method-artifactadd_dir">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.add\_dir()
</h3>

```python theme={"system"}
self,
local_path: 'str',
name: 'str | None' = None,
skip_cache: 'bool | None' = False,
policy: "Literal['mutable', 'immutable'] | None" = 'mutable',
merge: 'bool' = False
```

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

<h5 id="arguments-2">
  引数
</h5>

<ResponseField name="local_path" type="str">
  ローカルディレクトリのパス。
</ResponseField>

<ResponseField name="name" type="str | None">
  アーティファクト内のサブディレクトリ名。指定した名は、W\&B アプリ UI でアーティファクトの `type` によってネストされて表示されます。デフォルトはアーティファクトのルートです。
</ResponseField>

<ResponseField name="skip_cache" type="bool | None">
  `True` に設定した場合、W\&B はアップロード中にファイルをキャッシュにコピー/移動しません
</ResponseField>

<ResponseField name="policy" type="Literal['mutable', 'immutable'] | None">
  デフォルトは "mutable" です。

  * mutable: アップロード中の破損を防ぐため、ファイルの一時コピーを作成します。
  * immutable: 保護を無効にし、ユーザーがファイルを削除または変更しないことに依存します。
</ResponseField>

<ResponseField name="merge" type="bool">
  `False` (デフォルト) の場合、以前の add\_dir 呼び出しで既に追加されたファイルがあり、その内容が変更されていると ValueError をスローします。`True` の場合、変更された内容で既存のファイルを上書きします。常に新しいファイルを追加し、ファイルを削除することはありません。ディレクトリ全体を置き換えるには、`add_dir(local_path, name=my_prefix)` を使用してディレクトリを追加する際に名前を渡し、`remove(my_prefix)` を呼び出してディレクトリを削除してから、再度追加します。
</ResponseField>

<h5 id="raises-2">
  送出される例外
</h5>

* `ArtifactFinalizedError`: 現在のアーティファクトのバージョンは確定済みのため、変更できません。代わりに新しいアーティファクトのバージョンをログしてください。
* `ValueError`: ポリシーには "mutable" または "immutable" を指定する必要があります

<h3 id="method-artifactadd_file">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> アーティファクト.add\_file()
</h3>

```python theme={"system"}
self,
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
```

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

<h5 id="arguments-3">
  引数
</h5>

<ResponseField name="local_path" type="str">
  追加するファイルへのパスです。
</ResponseField>

<ResponseField name="name" type="str | None">
  追加するファイルに使用するアーティファクト内のパスです。デフォルトはファイルの basename です。
</ResponseField>

<ResponseField name="is_tmp" type="bool | None">
  true の場合、衝突を避けるためにファイルは決定論的にリネームされます。
</ResponseField>

<ResponseField name="skip_cache" type="bool | None">
  `True` の場合、アップロード後にファイルをキャッシュにコピーしません。
</ResponseField>

<ResponseField name="policy" type="Literal['mutable', 'immutable'] | None">
  デフォルトは "mutable" に設定されます。"mutable" に設定すると、アップロード中の破損を防ぐためにファイルの一時コピーを作成します。"immutable" に設定すると、保護を無効にし、ユーザーがファイルを削除または変更しないことに依存します。
</ResponseField>

<ResponseField name="overwrite" type="bool">
  `True` の場合、ファイルがすでに存在していれば上書きします。
</ResponseField>

<h5 id="raises-3">
  送出される例外
</h5>

* `ArtifactFinalizedError`: 現在のアーティファクトのバージョンは確定済みのため、変更できません。代わりに新しいアーティファクトのバージョンをログしてください。
* `ValueError`: ポリシーには "mutable" または "immutable" を指定する必要があります

<h3 id="method-artifactadd_reference">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.add\_reference()
</h3>

```python theme={"system"}
self,
uri: 'ArtifactManifestEntry | str',
name: 'StrPath | None' = None,
checksum: 'bool' = True,
max_objects: 'int | None' = None
```

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

アーティファクトに追加するファイルやディレクトリとは異なり、参照は W\&B にアップロードされません。詳細については、[外部ファイルをトラッキングする](/ja/products/wandb/artifacts/track-external-files) を参照してください。

デフォルトでは、次のスキームがサポートされます。

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

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

<h5 id="arguments-4">
  引数
</h5>

<ResponseField name="uri" type="ArtifactManifestEntry | str">
  追加する参照の URI パスです。URI パスは、別のアーティファクトのエントリへの参照を保存するために `Artifact.get_entry` から返されるオブジェクトにすることができます。
</ResponseField>

<ResponseField name="name" type="StrPath | None">
  この参照の内容を配置するアーティファクト内のパスです。
</ResponseField>

<ResponseField name="checksum" type="bool">
  参照 URI にあるリソースのチェックサムを計算するかどうかを指定します。チェックサム計算は、自動的な整合性検証を可能にするため、強く推奨されます。チェックサム計算を無効にするとアーティファクトの作成が高速化されますが、参照ディレクトリは反復処理されないため、ディレクトリ内のオブジェクトはアーティファクトに保存されません。参照オブジェクトを追加する場合は `checksum=False` を設定することを推奨します。この場合、参照 URI が変更された場合にのみ新しいバージョンが作成されます。
</ResponseField>

<ResponseField name="max_objects" type="int | None">
  ディレクトリまたはバケットストアの接頭辞を指す参照を追加する際に考慮するオブジェクトの最大数です。デフォルトでは、Amazon S3、GCS、Azure、およびローカルファイルで許可されるオブジェクトの最大数は 10,000,000 です。その他の URI スキーマには最大値はありません。
</ResponseField>

<h5 id="raises-4">
  送出される例外
</h5>

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

<h3 id="method-artifactcheckout">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.checkout()
</h3>

```python theme={"system"}
self,
root: 'str | None' = None
```

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

警告: これにより、アーティファクトに含まれていない `root` 内のすべてのファイルが削除されます。

<h5 id="arguments-5">
  引数
</h5>

<ResponseField name="root" type="str | None">
  このアーティファクトの file で置き換えるディレクトリ。
</ResponseField>

<h5 id="raises-5">
  送出される例外
</h5>

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

<h3 id="method-artifactdelete">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.delete()
</h3>

```python theme={"system"}
self,
delete_aliases: 'bool' = False
```

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

リンクされたアーティファクトに対して呼び出された場合、リンクのみが削除され、ソースアーティファクトは影響を受けません。

ソースアーティファクトとコレクション間のリンクを削除するには、`Artifact.delete()` の代わりに `Artifact.unlink()` を使用してください。

<h5 id="arguments-6">
  引数
</h5>

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

<h5 id="raises-6">
  送出される例外
</h5>

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

<h3 id="method-artifactdownload">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.download()
</h3>

```python theme={"system"}
self,
root: 'StrPath | None' = None,
allow_missing_references: 'bool' = False,
skip_cache: 'bool | None' = None,
path_prefix: 'StrPath | None' = None,
multipart: 'bool | None' = None
```

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

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

<h5 id="arguments-7">
  引数
</h5>

<ResponseField name="root" type="StrPath | None">
  W\&B がアーティファクトのファイルを保存するディレクトリ。
</ResponseField>

<ResponseField name="allow_missing_references" type="bool">
  `True` に設定すると、参照先のファイルをダウンロードする際に、無効な参照パスは無視されます。
</ResponseField>

<ResponseField name="skip_cache" type="bool | None">
  `True` に設定すると、ダウンロード時にアーティファクトのキャッシュを使用せず、W\&B は各ファイルをデフォルトのルートディレクトリまたは指定されたダウンロード先ディレクトリにダウンロードします。
</ResponseField>

<ResponseField name="path_prefix" type="StrPath | None">
  指定すると、パスが指定された接頭辞で始まるファイルのみをダウンロードします。Unix 形式 (スラッシュ区切り) を使用します。
</ResponseField>

<ResponseField name="multipart" type="bool | None">
  `None` (デフォルト) に設定すると、個々のファイルサイズが 2 GB を超える場合はマルチパートダウンロードを使用して、アーティファクトを並列にダウンロードします。`True` または `False` に設定すると、ファイルサイズに関係なく、アーティファクトをそれぞれ並列または逐次ダウンロードします。
</ResponseField>

<h5 id="raises-7">
  送出される例外
</h5>

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

<h3 id="method-artifactfile">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.file()
</h3>

```python theme={"system"}
self,
root: 'str | None' = None
```

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

<h5 id="arguments-8">
  引数
</h5>

<ResponseField name="root" type="str | None">
  ファイルを保存するルートディレクトリです。デフォルトは `./artifacts/self.name/` です。
</ResponseField>

<h5 id="raises-8">
  送出される例外
</h5>

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

<h3 id="method-artifactfiles">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.files()
</h3>

```python theme={"system"}
self,
names: 'list[str] | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None
```

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

<h5 id="arguments-9">
  引数
</h5>

<ResponseField name="names" type="list[str] | None">
  一覧表示するファイルの、アーティファクトのルートからの相対パス。
</ResponseField>

<ResponseField name="per_page" type="int">
  リクエストごとに返すファイル数。
</ResponseField>

<ResponseField name="start" type="str | None">
  過去のクエリを再開するためのページネーションカーソル。以前のページネーターの `.cursor` 属性から取得します。
</ResponseField>

<h5 id="raises-9">
  送出される例外
</h5>

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

<h3 id="method-artifactfinalize">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.finalize()
</h3>

```python theme={"system"}
self
```

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

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

<h3 id="method-artifactget">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.get()
</h3>

```python theme={"system"}
self,
name: 'str'
```

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

<h5 id="arguments-10">
  引数
</h5>

<ResponseField name="name" type="str">
  取得するアーティファクトの相対名。
</ResponseField>

<h5 id="raises-10">
  送出される例外
</h5>

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

<h3 id="method-artifactget_added_local_path_name">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.get\_added\_local\_path\_name()
</h3>

```python theme={"system"}
self,
local_path: 'str'
```

ローカルファイルシステムのパスで追加したファイルについて、アーティファクト内での相対名を取得します。

<h5 id="arguments-11">
  引数
</h5>

<ResponseField name="local_path" type="str">
  アーティファクト内の相対名に解決するローカルパス。
</ResponseField>

<h3 id="method-artifactget_entry">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.get\_entry()
</h3>

```python theme={"system"}
self,
name: 'StrPath'
```

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

<h5 id="arguments-12">
  引数
</h5>

<ResponseField name="name" type="StrPath">
  取得するアーティファクトの相対名
</ResponseField>

<h5 id="raises-11">
  送出される例外
</h5>

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

<h3 id="method-artifactget_path">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.get\_path()
</h3>

```python theme={"system"}
self,
name: 'StrPath'
```

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

<h5 id="arguments-13">
  引数
</h5>

<ResponseField name="name" type="StrPath">
  説明はありません。
</ResponseField>

<h3 id="method-artifactis_draft">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.is\_draft()
</h3>

```python theme={"system"}
self
```

アーティファクトが保存されていないかどうかを確認します。

<h3 id="method-artifactjson_encode">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.json\_encode()
</h3>

```python theme={"system"}
self
```

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

<h3 id="method-artifactlink">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.link()
</h3>

```python theme={"system"}
self,
target_path: 'str',
aliases: 'Iterable[str] | None' = None
```

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

<h5 id="arguments-14">
  引数
</h5>

<ResponseField name="target_path" type="str">
  コレクションのパスです。パスは、接頭辞 "wandb-registry-"、registry 名、コレクション名で構成されます (`wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}`)。
</ResponseField>

<ResponseField name="aliases" type="Iterable[str] | None">
  リンクされたアーティファクトに 1 つ以上のエイリアスを追加します。"latest" エイリアスは、最後にリンクしたアーティファクトに自動的に適用されます。
</ResponseField>

<h5 id="raises-12">
  送出される例外
</h5>

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

<h3 id="method-artifactlogged_by">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.logged\_by()
</h3>

```python theme={"system"}
self
```

アーティファクトを最初にログした W\&B run を取得します。

<h5 id="raises-13">
  送出される例外
</h5>

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

<h3 id="method-artifactnew_draft">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.new\_draft()
</h3>

```python theme={"system"}
self
```

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

既存のアーティファクトを変更すると、"段階的アーティファクト" と呼ばれる新しいアーティファクトのバージョン
が作成されます。返されたアーティファクトは、拡張または
変更したうえで、新しいバージョンとしてログできます。

<h5 id="raises-14">
  送出される例外
</h5>

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

<h3 id="method-artifactnew_file">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.new\_file()
</h3>

```python theme={"system"}
self,
name: 'str',
mode: 'str' = 'x',
encoding: 'str | None' = None,
policy: "Literal['mutable', 'immutable']" = 'mutable'
```

新しい一時 file を開き、アーティファクトに追加します。

<h5 id="arguments-15">
  引数
</h5>

<ResponseField name="name" type="str">
  アーティファクトに追加する新しいファイルの名。
</ResponseField>

<ResponseField name="mode" type="str">
  新しいファイルを開く際に使用するファイルアクセスモード。
</ResponseField>

<ResponseField name="encoding" type="str | None">
  新しいファイルを開く際に使用するエンコーディング。
</ResponseField>

<ResponseField name="policy" type="Literal['mutable', 'immutable']">
  デフォルトは "mutable" です。"mutable" に設定すると、アップロード中の破損を防ぐためにファイルの一時コピーを作成します。"immutable" に設定すると、保護を無効にし、ユーザーがファイルを削除または変更しないことを前提とします。
</ResponseField>

<h5 id="raises-15">
  送出される例外
</h5>

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

<h3 id="method-artifactremove">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.remove()
</h3>

```python theme={"system"}
self,
item: 'StrPath | ArtifactManifestEntry'
```

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

<h5 id="arguments-16">
  引数
</h5>

<ResponseField name="item" type="StrPath | ArtifactManifestEntry">
  削除する項目です。特定のマニフェストエントリ、またはアーティファクトからの相対パス名を指定できます。項目がディレクトリに一致する場合、そのディレクトリ内のすべての項目が削除されます。
</ResponseField>

<h5 id="raises-16">
  送出される例外
</h5>

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

<h3 id="method-artifactsave">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.save()
</h3>

```python theme={"system"}
self,
project: 'str | None' = None,
settings: 'wandb.Settings | None' = None
```

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

run の実行中であれば、その run がこのアーティファクトをログします。run の実行中でない場合は、
このアーティファクトをトラッキングするために、タイプが "auto" の run が作成されます。

<h5 id="arguments-17">
  引数
</h5>

<ResponseField name="project" type="str | None">
  コンテキストに run がまだない場合に、アーティファクトに使用する project です。
</ResponseField>

<ResponseField name="settings" type="wandb.Settings | None">
  自動 run の初期化時に使用する設定オブジェクトです。主にテストハーネスで使用します。
</ResponseField>

<h3 id="method-artifactunlink">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.unlink()
</h3>

```python theme={"system"}
self
```

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

<h5 id="raises-17">
  送出される例外
</h5>

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

<h3 id="method-artifactused_by">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.used\_by()
</h3>

```python theme={"system"}
self
```

このアーティファクトおよびリンクされたアーティファクトを使用した run の一覧を取得します。

<h5 id="raises-18">
  送出される例外
</h5>

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

<h3 id="method-artifactverify">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.verify()
</h3>

```python theme={"system"}
self,
root: 'str | None' = None
```

アーティファクトの内容がマニフェストと一致していることを検証します。

ディレクトリ内のすべてのファイルのチェックサムを計算し、アーティファクトのマニフェストと照合します。参照は検証の対象外です。

<h5 id="arguments-18">
  引数
</h5>

<ResponseField name="root" type="str | None">
  検証するディレクトリ。None の場合、アーティファクトは './artifacts/self.name/' にダウンロードされます。
</ResponseField>

<h5 id="raises-19">
  送出される例外
</h5>

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

<h3 id="method-artifactwait">
  <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Artifact.wait()
</h3>

```python theme={"system"}
self,
timeout: 'int | None' = None
```

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

<h5 id="arguments-19">
  引数
</h5>

<ResponseField name="timeout" type="int | None">
  待機時間 (秒) 。
</ResponseField>


## Related topics

- [アーティファクト](/ja/products/wandb/ref/query-panel/artifact.md)