Artifact

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

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

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

引数
`name`	アーティファクトの人間が読める名前。W&BアプリのUIまたはプログラムを使用して特定のアーティファクトを識別するために使用します。Public APIの`use_artifact`を使ってアーティファクトを参照できます。名前には文字、数字、アンダースコア、ハイフン、およびドットを含めることができます。名前はプロジェクト全体で一意である必要があります。
`type`	アーティファクトのタイプ。アーティファクトのタイプを使用してアーティファクトを整理し、区別します。文字、数字、アンダースコア、ハイフン、およびドットを含む任意の文字列を使用できます。一般的なタイプには`dataset`や`model`が含まれます。アーティファクトをW&Bモデルレジストリにリンクしたい場合は、タイプ文字列に`model`を含めてください。
`description`	アーティファクトの説明。モデルまたはデータセットのArtifactsの場合、標準化されたチームモデルまたはデータセットカードのドキュメントを追加します。アーティファクトの説明をプログラムによっては`Artifact.description`属性で、またはW&BアプリのUIからプログラム的に確認できます。W&Bはアプリ内で説明をMarkdownとしてレンダリングします。
`metadata`	アーティファクトに関する追加情報。メタデータをキーと値のペアで辞書として指定します。キーの総数は100個以内で指定してください。

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

属性
`aliases`	アーティファクトバージョンに割り当てられた、意味的に親しみやすい参照や識別用の「ニックネーム」のリスト。エイリアスはプログラムによって参照できる可変参照です。エイリアスはW&BアプリのUIまたはプログラムによって変更可能です。詳細については、新しいアーティファクトバージョンの作成を参照してください。
`collection`	このアーティファクトが取得されたコレクション。コレクションはアーティファクトバージョンの順序付けられたグループです。
`commit_hash`	このアーティファクトがコミットされた時に返されるハッシュ。
`created_at`	アーティファクトが作成されたタイムスタンプ。
`description`	アーティファクトの説明。
`digest`	アーティファクトの論理的ダイジェスト。
`entity`	二次（ポートフォリオ）アーティファクトコレクションのエンティティの名前。
`file_count`	ファイルの数（参照を含む）。
`id`	アーティファクトのID。
`manifest`	アーティファクトのマニフェスト。マニフェストはアーティファクトのすべての内容を一覧表示し、一度ログに記録された後は変更できません。
`metadata`	ユーザー定義のアーティファクトメタデータ。アーティファクトに関連する構造化データ。
`name`	二次（ポートフォリオ）コレクションのアーティファクト名とバージョン。形式は{collection}:{alias}。名前だけが含まれます。
`project`	二次（ポートフォリオ）アーティファクトコレクションのプロジェクト名。
`qualified_name`	二次（ポートフォリオ）コレクションのentity/project/name。
`size`	アーティファクトの総サイズ（バイト単位）。
`source_collection`	アーティファクトの一次（シーケンス）コレクション。
`source_entity`	一次（シーケンス）アーティファクトコレクションのエンティティの名前。
`source_name`	一次（シーケンス）コレクションのアーティファクト名とバージョン。形式は {collection}:{alias} です。名前だけが含まれます。
`source_project`	一次（シーケンス）アーティファクトコレクションのプロジェクト名。
`source_qualified_name`	一次（シーケンス）コレクションのentity/project/name。
`source_version`	一次（シーケンス）コレクションのアーティファクトのバージョン。形式は "v{number}"。
`state`	アーティファクトの状態。 "PENDING", "COMMITTED", または "DELETED" のいずれか。
`ttl`	アーティファクトのタイム・トゥ・リブ (TTL) ポリシー。
`type`	アーティファクトのタイプ。一般的なタイプには`dataset`や`model`が含まれます。
`updated_at`	アーティファクトが最後に更新された時刻。
`version`	二次（ポートフォリオ）コレクションのアーティファクトのバージョン。

引数
`obj`	追加するオブジェクト。現在サポートされているのは、Bokeh, JoinedTable, PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D, Audio, Image, Video, Html, Object3Dです。
`name`	アーティファクト内でオブジェクトを追加するパス。

引数
`local_path`	ローカルディレクトリのパス。
`name`	アーティファクト内のサブディレクトリ名。この名前はW&BアプリのUIでアーティファクトの`type`によってネストされて表示されます。デフォルトはアーティファクトのルートです。
`skip_cache`	`True`に設定されている場合、アップロード中にファイルをキャッシュにコピー/移動しません。
`policy`	"mutable" または "immutable"。デフォルトは"mutable"。「mutable」：アップロード中のファイルの破損を防ぐため、一時コピーを作成します。「immutable」：保護を無効にし、ファイルを削除または変更しないようユーザーに依存します。

例外
`ArtifactFinalizedError`	現在のアーティファクトバージョンに変更を加えることはできません。代わりに新しいアーティファクトバージョンをログに記録してください。
`ValueError`	ポリシーは "mutable" または "immutable" でなければなりません。

引数
`local_path`	追加するファイルのパス。
`name`	追加するファイルが使用されるアーティファクト内のパス。デフォルトはファイルのベース名です。
`is_tmp`	trueの場合、ファイルは衝突を避けるため決定論的に名前が変更されます。
`skip_cache`	`True`に設定されている場合、アップロード後にファイルをキャッシュにコピーしません。
`policy`	"mutable" または "immutable"。デフォルトは"mutable"。「mutable」：アップロード中のファイルの破損を防ぐため、一時コピーを作成します。「immutable」：保護を無効にし、ファイルを削除または変更しないようユーザーに依存します。

引数
`uri`	追加する参照のURIパス。URIパスは、他のアーティファクトのエントリへの参照を保存するために`Artifact.get_entry`から返されるオブジェクトである可能性があります。
`name`	この参照の内容を配置するアーティファクト内のパス。
`checksum`	参照URIにあるリソースのチェックサムを行うかどうか。チェックサミングは強く推奨されます。
`max_objects`	ディレクトリまたはバケットストアプレフィックスを指す参照を追加する際に考慮するオブジェクトの最大数。デフォルトでは、Amazon S3, GCS, Azure, およびローカルファイルの最大数は10,000,000です。他のURIスキーマには最大値がありません。

引数
`root`	W&Bがアーティファクトのファイルを保存するディレクトリ。
`allow_missing_references`	`True`に設定すると、無効な参照パスがあっても無視され、参照ファイルのダウンロードは行われません。
`skip_cache`	`True`に設定されている場合、アーティファクトキャッシュをスキップし、各ファイルをデフォルトのルートまたは指定されたダウンロードディレクトリに直接ダウンロードします。

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

引数
`names`	リストしたいアーティファクトのルート相対パスのファイル名。
`per_page`	リクエストごとに返されるファイル数。

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

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

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

引数
`project`	runが既にコンテキストにない場合にアーティファクトに使用するプロジェクト。
`settings`	自動runを初期化するときに使用する設定オブジェクト。主にテスト環境で使用されます。

引数
`name`	オブジェクトを追加するアーティファクト内のパス。
`item`	追加するオブジェクト。

Artifact

Methods​

add​

add_dir​

add_file​

add_reference​

checkout​

delete​

download​

file​

files​

finalize​

get​

get_added_local_path_name​

get_entry​

get_path​

is_draft​

json_encode​

link​

logged_by​

new_draft​

new_file​

path_contains_dir_prefix​

remove​

save​

should_download_entry​

unlink​

used_by​

verify​

wait​

__getitem__​

__setitem__​

Methods

`add`

`add_dir`

`add_file`

`add_reference`

`checkout`

`delete`

`download`

`file`

`files`

`finalize`

`get`

`get_added_local_path_name`

`get_entry`

`get_path`

`is_draft`

`json_encode`

`link`

`logged_by`

`new_draft`

`new_file`

`path_contains_dir_prefix`

`remove`

`save`

`should_download_entry`

`unlink`

`used_by`

`verify`

`wait`

`getitem`

`setitem`