メインコンテンツへスキップ
W&B Python SDK を使用して、W&B Runs から artifact を作成できます。ファイル、ディレクトリ、URI、並列 run のファイルを artifact に追加できます。artifact にファイルを追加したら、その artifact を W&B Server または独自のプライベートサーバーに保存します。各 artifact は run に関連付けられています。 Amazon S3 に保存されたファイルなどの外部ファイルをトラッキングする方法については、外部ファイルをトラッキングするページを参照してください。

アーティファクト を作成する

W&B Artifact は、次の 3 つの step で作成します。
  1. wandb.Artifact() を使って アーティファクト の Python オブジェクトを作成する
  2. アーティファクト に 1 つ以上のファイルを追加する
  3. アーティファクト を W&B Server に保存する

wandb.Artifact() を使って アーティファクト Python オブジェクトを作成する

アーティファクト オブジェクトを作成するには、wandb.Artifact() クラスを初期化します。次のパラメーターを指定します。
  • Name: アーティファクト の名前です。名前は一意で、内容がわかりやすく、覚えやすいものにしてください。
  • Type: アーティファクト のタイプです。タイプはシンプルでわかりやすく、機械学習パイプライン内の単一の step に対応している必要があります。一般的な アーティファクト タイプには 'dataset''model' があります。
W&B は、指定した “name” と “type” を使用して、W&B App に有向非巡回グラフを作成します。詳細は、アーティファクト グラフの探索とたどり方を参照してください。
Artifacts には、タイプに関係なく同じ名前を付けることはできません。つまり、dataset タイプの cats という名前の アーティファクト と、model タイプの同じ名前の アーティファクト を別に作成することはできません。
アーティファクト オブジェクトを初期化する際に、必要に応じて説明やメタデータを指定することもできます。使用可能な属性とパラメーターの詳細については、Python SDK Reference Guide の wandb.Artifact クラス定義を参照してください。 次の コードスニペット をコピー&ペーストして アーティファクト オブジェクトを作成します。<name><type> のプレースホルダーを自分の値に置き換えてください。

アーティファクト に 1 つ以上のファイルを追加する

アーティファクト オブジェクトには、ファイル、ディレクトリ、外部 URI reference (Amazon S3 など) などを追加できます。 単一のファイルを追加するには、アーティファクト オブジェクトの Artifact.add_file() method を使用します。
ディレクトリを追加するには、Artifact.add_dir() methodを使用します。
アーティファクト に種類の異なるファイルを追加する方法について詳しくは、次のセクション「アーティファクト へのファイルの追加」を参照してください。

アーティファクトをW&B Serverに保存する

アーティファクトをW&B Serverに保存します。アーティファクトを保存するには、run オブジェクトの wandb.Run.log_artifact() method を使用します。
wandb.Run.log_artifact()Artifact.save() の使い分け
  • 新しいアーティファクトを作成し、特定の run に関連付ける場合は wandb.Run.log_artifact() を使用します。
  • 新しい run を作成せずに既存のアーティファクトを更新する場合は Artifact.save() を使用します。
以上を踏まえると、次のコードスニペットは、データセットアーティファクトを作成し、そのアーティファクトにファイルを追加して、W&B に保存する方法を示しています。
同じ名とタイプで アーティファクト をログするたびに、W&B はその アーティファクト の新しいバージョンを作成します。詳細は、新しい アーティファクト バージョンを作成を参照してください。
W&B では、アップロード性能を高めるために wandb.Run.log_artifact() を非同期で実行します。そのため、ループ内で アーティファクト をログすると、想定外の動作が発生することがあります。例:
アーティファクト は任意の順序でログされる可能性があるため、アーティファクト のバージョン v0 のメタデータに含まれる index が 0 でない場合があります。

アーティファクト にファイルを追加する

以下のセクションでは、アーティファクト にさまざまなタイプのオブジェクトを追加する方法を示します。以降の例を読むにあたって、次のような構造のディレクトリがあるものとします。

単一ファイルを追加

アーティファクトにローカルの単一ファイルを追加するには、wandb.Artifact.add_file() を使用します。ファイルのローカルパスを local_path パラメーターに指定します。
たとえば、ローカルの作業ディレクトリに 'hello.txt' というファイルがあるとします。
アーティファクト には現在、以下の内容が含まれています。
必要に応じて、name パラメーターに別の名前を渡すと、アーティファクト オブジェクト内でのファイル名を変更できます。前の例の続きは次のとおりです。
アーティファクトは次のように保存されます:
次の表は、異なる API 呼び出しによって アーティファクト に格納される内容がどのように変わるかを示しています。
API 呼び出し生成される アーティファクト
artifact.new_file('hello.txt')hello.txt
artifact.add_file('model.h5')model.h5
artifact.add_file('checkpoints/model.h5')model.h5
artifact.add_file('model.h5', name='models/mymodel.h5')models/mymodel.h5

複数のファイルを追加する

ローカルディレクトリからアーティファクトに複数のファイルを追加するには、wandb.Artifact.add_dir() methodを使用します。local_path パラメーターには、対象ディレクトリのローカルパスを指定します。
次の表は、異なるAPI callによって生成されるアーティファクトの内容がどのように異なるかを示しています。
API 呼び出し生成されるアーティファクト
artifact.add_dir('images')

cat.png

dog.png

artifact.add_dir('images', name='images')

images/cat.png

images/dog.png

URI referenceを追加する

URI に W&B ライブラリがサポートしているスキームが含まれている場合、アーティファクト は再現性のためにチェックサムやその他の情報をトラッキングします。 wandb.Artifact.add_reference() method を使用して、アーティファクト に外部 URI reference を追加します。'uri' 文字列はご自身の URI に置き換えてください。必要に応じて、name パラメーターに アーティファクト 内の任意のパスを指定できます。
アーティファクト は次の URI スキームをサポートしています。
  • http(s)://: HTTP 経由でアクセスできるファイルへのパスです。HTTP サーバーが ETag および Content-Length レスポンスヘッダーをサポートしている場合、アーティファクト は ETag とサイズのメタデータの形式でチェックサムをトラッキングします。
  • s3://: S3 内のオブジェクトまたはオブジェクトプレフィックスへのパスです。アーティファクト は、参照先オブジェクトのチェックサムとバージョン管理情報 (バケットでオブジェクトのバージョン管理が有効になっている場合) をトラッキングします。オブジェクトプレフィックスは、そのプレフィックス配下のオブジェクトを含むように展開され、最大 10,000 オブジェクトまで含まれます。
  • gs://: GCS 内のオブジェクトまたはオブジェクトプレフィックスへのパスです。アーティファクト は、参照先オブジェクトのチェックサムとバージョン管理情報 (バケットでオブジェクトのバージョン管理が有効になっている場合) をトラッキングします。オブジェクトプレフィックスは、そのプレフィックス配下のオブジェクトを含むように展開され、最大 10,000 オブジェクトまで含まれます。
次の表は、API 呼び出しによって アーティファクト の内容がどのように変わるかを示しています。
API 呼び出し生成される アーティファクト の内容
artifact.add_reference('s3://my-bucket/model.h5')model.h5
artifact.add_reference('s3://my-bucket/checkpoints/model.h5')model.h5
artifact.add_reference('s3://my-bucket/model.h5', name='models/mymodel.h5')models/mymodel.h5
artifact.add_reference('s3://my-bucket/images')

cat.png

dog.png

artifact.add_reference('s3://my-bucket/images', name='images')

images/cat.png

images/dog.png

並列 run からアーティファクトにファイルを追加する

大規模なデータセットや分散トレーニングでは、複数の並列 run が 1 つのアーティファクトにファイルを追加する必要がある場合があります。

ログ済みの アーティファクト やその他のメタデータのパスを検索する

次のコードスニペットは、W&B Public API を使用して、名前と URL を含む run 内のファイルを一覧表示する方法を示しています。<entity/project/run-id> プレースホルダーは実際の値に置き換えてください。
利用可能な属性とmethodの詳細については、File クラスを参照してください。