メインコンテンツまでスキップ

クイックスタート

このクイックスタートでは、データセットのアーティファクトを作成、トラッキング、および使用する方法を示します。Weights & Biasesのアカウントをお持ちでない方は、始める前にお手続きください。

以下の手順は、アーティファクトの作成と使用方法を説明しています。 ステップ1と2は、W&B Artifactsに限らず一般的なものです。

  1. Weights & Biasesにログインします。
  2. Runを初期化します。
  3. アーティファクトオブジェクトを作成します。
  4. データセットをアーティファクトに追加します。
  5. データセットをログに記録します。
  6. アーティファクトをダウンロードして使用します。

Weights & Biasesにログイン​

Weights & Biasesライブラリをインポートし、W&Bにログインします。まだ登録していない場合は、無料のW&Bアカウントに登録する必要があります。

import wandb

wandb.login()

runの初期化​

wandb.init() APIを使って、バックグラウンドプロセスを生成し、W&B Runとしてデータを同期およびログに記録できます。プロジェクト名とジョブタイプを指定してください：

# W&B Runを作成します。ここでは、データセットアーティファクトの作成方法を示すため、
# ジョブタイプとして'dataset'を指定しています。
run = wandb.init(project="artifacts-example", job_type="upload-dataset")

アーティファクトオブジェクトの作成​

wandb.Artifact() APIを使ってアーティファクトオブジェクトを作成します。アーティファクトに名前を付け、ファイルタイプの説明をnameおよびtypeパラメータにそれぞれ指定してください。

例えば、以下のコードスニペットは、‘dataset’ラベルの‘bicycle-dataset’というアーティファクトを作成する方法を示しています：

artifact = wandb.Artifact(name="bicycle-dataset", type="dataset")

アーティファクトの構築方法についての詳細は、アーティファクトの構築を参照してください。

データセットをアーティファクトに追加​

アーティファクトにファイルを追加します。一般的なファイルタイプには、モデルやデータセットがあります。以下の例では、ローカルマシンに保存されているdataset.h5という名前のデータセットをアーティファクトに追加しています。

# アーティファクトの内容にファイルを追加
artifact.add_file(local_path="dataset.h5")

上記のコードスニペットのdataset.h5というファイル名を、アーティファクトに追加したいファイルへのパスに置き換えてください。

データセットをログする​

W&Bのrunオブジェクトのlog_artifact()メソッドを使って、アーティファクトのバージョンを保存し、そのアーティファクトをrunの出力として宣言します。

# アーティファクトのバージョンをW&Bに保存し、
# このrunの出力としてマークする
run.log_artifact(artifact)

アーティファクトをログすると、デフォルトで'latest'エイリアスが作成されます。アーティファクトのエイリアスとバージョンについての詳細は、それぞれカスタムエイリアスの作成と新しいアーティファクトバージョンの作成をご覧ください。

アーティファクトのダウンロードと使用​

以下のコード例は、ログしたアーティファクトをWeights & Biasesサーバーに保存し、それを使用するための手順を示しています。

  1. 最初に、wandb.init()で新しいrunオブジェクトを初期化します。
  2. 次に、runオブジェクトのuse_artifact()メソッドを使って、Weights & Biasesにどのアーティファクトを使用するか指示します。これによってアーティファクトオブジェクトが返されます。
  3. 最後に、アーティファクトのdownload()メソッドを使って、アーティファクトの内容をダウンロードします。
# W&B Runを作成します。ここでは'type'に'training'を指定しています
# なぜなら、このrunでトレーニングのトラッキングを行うためです。
run = wandb.init(project="artifacts-example", job_type="training")

# アーティファクトをW&Bから取得し、このrunの入力としてマークします
artifact = run.use_artifact("bicycle-dataset:latest")

# アーティファクトの内容をダウンロードします
artifact_dir = artifact.download()

代わりに、公開API（wandb.Api）を使用して、Weights & Biases外部のRun以外ですでに保存されているデータをエクスポート（または更新）することもできます。詳細については、外部ファイルのトラッキングを参照してください。

On this page
Was this page helpful?👍👎