コマンドライン インターフェース
使用法
wandb [OPTIONS] COMMAND [ARGS]...
オプション
| オプション |
説明 |
--version |
バージョンを表示して終了します。 |
コマンド
| コマンド |
説明 |
| agent |
W&B エージェントを実行します |
| artifact |
アーティファクトと対話するためのコマンド |
| beta |
wandb CLI コマンドのベータバージョン。 |
| controller |
W&B ローカルsweepコントローラを実行します |
| disabled |
W&B を無効にします。 |
| docker |
コードをdockerコンテナで実行します。 |
| docker-run |
docker run をラップし、WANDB_API_KEY と WANDB_DOCKER を追加します… |
| enabled |
W&B を有効にします。 |
| init |
Weights & Biasesでディレクトリーを設定します |
| job |
W&B ジョブを管理および表示するためのコマンド |
| launch |
W&B Jobを起動またはキューに入れます。 |
| launch-agent |
W&B ローンンチ エージェントを実行します。 |
| launch-sweep |
W&B ローンンチ スウィープを実行します（実験的）。 |
| login |
Weights & Biases にログインします |
| offline |
W&B 同期を無効にします |
| online |
W&B 同期を有効にします |
| pull |
Weights & Biases からファイルを取得します |
| restore |
runのコード、設定、およびdocker状態を復元します |
| scheduler |
W&B ローンンチ スウィープ スケジューラを実行します（実験的） |
| server |
ローカル W&B サーバーを操作するためのコマンド |
| status |
設定情報を表示します |
| sweep |
ハイパーパラメーター探索を初期化します。 |
| sync |
オフライントレーニングディレクトリーを W&B にアップロードします |
| verify |
ローカルインスタンスを検証します |
1 - wandb disabled
使用方法
wandb disabled [OPTIONS]
概要
W&B を無効化します。
オプション
| オプション |
説明 |
--service |
W&B サービスを無効化します [デフォルト: True] |
2 - wandb docker
Usage
wandb docker [OPTIONS] [DOCKER_RUN_ARGS]... [DOCKER_IMAGE]
Summary
docker コンテナ内でコードを実行します。
W&B docker を使用すると、コードを docker イメージ内で実行し、wandb が適切に設定されていることを確認します。WANDB_DOCKER と WANDB_API_KEY の環境変数をコンテナに追加し、既定では現在のディレクトリーを /app にマウントします。docker run の画像名が宣言される前に追加されるその他の args を渡すことができます。指定されない場合は、デフォルトのイメージを選択します：
sh wandb docker -v /mnt/dataset:/app/data wandb docker gcr.io/kubeflow-
images-public/tensorflow-1.12.0-notebook-cpu:v0.4.0 –jupyter wandb docker
wandb/deepo:keras-gpu –no-tty –cmd “python train.py –epochs=5”
デフォルトでは、wandb の存在を確認し、存在しない場合はインストールするために entrypoint をオーバーライドします。–jupyter フラグを渡すと、jupyter がインストールされ、ポート 8888 で jupyter lab が開始されます。システム上で nvidia-docker を検出した場合、nvidia ランタイムを使用します。既存の docker run コマンドに環境変数を設定するだけでよければ、wandb docker-run コマンドを参照してください。
Options
| Option |
Description |
--nvidia / --no-nvidia |
nvidia ランタイムを使用します。nvidia-docker が存在する場合、デフォルトで nvidia が使用されます |
--digest |
イメージのダイジェストを出力して終了します |
--jupyter / --no-jupyter |
コンテナ内で jupyter lab を実行します |
--dir |
コンテナ内にコードをマウントするディレクトリー |
--no-dir |
現在のディレクトリーをマウントしません |
--shell |
コンテナを開始するシェル |
--port |
jupyter をバインドするホストポート |
--cmd |
コンテナ内で実行するコマンド |
--no-tty |
コマンドを tty なしで実行します |
3 - wandb docker-run
使用方法
wandb docker-run [OPTIONS] [DOCKER_RUN_ARGS]...
概要
docker run をラップし、WANDB_API_KEY と WANDB_DOCKER 環境変数を追加します。
nvidia-docker 実行ファイルがシステム上に存在し、–runtime が設定されていない場合は、ランタイムを nvidia に設定します。
詳細については、docker run --help を参照してください。
オプション
4 - wandb init
使用法
wandb init [OPTIONS]
概要
Weights & Biases でディレクトリーを設定
オプション
| オプション |
説明 |
-p, --project |
使用するプロジェクト。 |
-e, --entity |
プロジェクトを範囲指定するためのエンティティ。 |
--reset |
設定をリセット |
-m, --mode |
“online”、“offline” または “disabled” を指定可能。デフォルトは online。 |
5 - wandb offline
使用方法
wandb offline [OPTIONS]
概要
W&B の同期を無効にする
オプション
6 - wandb pull
使用方法
wandb pull [OPTIONS] RUN
概要
Weights & Biases からファイルを取得します
オプション
| オプション |
説明 |
-p, --project |
ダウンロードしたいプロジェクトです。 |
-e, --entity |
リストを絞り込むためのエンティティです。 |
7 - wandb restore
使い方
wandb restore [OPTIONS] RUN
概要
run のコード、config、docker 状態を復元します
オプション
| オプション |
説明 |
--no-git |
git 状態を復元しない |
--branch / --no-branch |
ブランチを作成するか、デタッチされた状態にチェックアウトするか |
-p, --project |
アップロードしたいプロジェクト。 |
-e, --entity |
リストを特定のエンティティに絞り込むためのエンティティ。 |
8 - wandb sweep
使用法
wandb sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID
概要
ハイパーパラメーター探索を初期化します。機械学習モデルのコスト関数を最適化するために、さまざまな組み合わせをテストしてハイパーパラメーターを検索します。
オプション
| オプション |
説明 |
-p, --project |
sweep から作成された W&B によって送信されるプロジェクトの名前です。プロジェクトが指定されない場合、run は Uncategorized というラベルのプロジェクトに送信されます。 |
-e, --entity |
sweep によって作成された W&B run を送信したいユーザー名またはチーム名です。指定した entity が既に存在することを確認してください。entity を指定しない場合、run は通常は自分のユーザー名であるデフォルトの entity に送信されます。 |
--controller |
ローカルコントローラを実行します |
--verbose |
詳細情報を表示します |
--name |
sweep の名前です。名前が指定されていない場合は、sweep ID が使用されます。 |
--program |
sweep プログラムを設定します |
--update |
保留中の sweep を更新します |
--stop |
新しい run の実行を停止して、現在実行中の run が終了するように sweep を終了します。 |
--cancel |
実行中のすべての run を停止し、新しい run の実行を停止するために sweep をキャンセルします。 |
--pause |
新しい run の実行を一時的に停止するために sweep を一時停止します。 |
--resume |
新しい run の実行を再開するために sweep を再開します。 |
--prior_run |
この sweep に追加する既存の run の ID |
9 - wandb sync
使用方法
wandb sync [OPTIONS] [PATH]...
概要
オフライン トレーニング ディレクトリーを W&B にアップロードします
オプション
| オプション |
説明 |
--id |
アップロードしたい run。 |
-p, --project |
アップロードしたいプロジェクト。 |
-e, --entity |
スコープにするエンティティ。 |
--job_type |
関連する runs をまとめる run のタイプを指定します。 |
--sync-tensorboard / --no-sync-tensorboard |
tfevent ファイルを wandb にストリームします。 |
--include-globs |
含めるグロブのカンマ区切りのリスト。 |
--exclude-globs |
除外するグロブのカンマ区切りのリスト。 |
--include-online / --no-include-online |
オンライン runs を含める |
--include-offline / --no-include-offline |
オフライン runs を含める |
--include-synced / --no-include-synced |
同期済み runs を含める |
--mark-synced / --no-mark-synced |
runs を同期済みとしてマークする |
--sync-all |
全ての runs を同期する |
--clean |
同期済み runs を削除する |
--clean-old-hours |
指定した時間より前に作成された runs を削除します。–clean フラグと一緒に使用します。 |
--clean-force |
確認プロンプトなしでクリーンする。 |
--show |
表示する runs の数 |
--append |
run を追加する |
--skip-console |
コンソールログをスキップする |
10 - wandb verify
使用方法
wandb verify [OPTIONS]
概要
ローカルインスタンスを検証する
オプション
| オプション |
説明 |
--host |
W&B の特定のインスタンスをテストします |
11 - wandb アーティファクト
使用方法
wandb artifact [OPTIONS] COMMAND [ARGS]...
概要
アーティファクトと対話するためのコマンド
オプション
コマンド
| コマンド |
説明 |
| cache |
アーティファクトキャッシュと対話するためのコマンド |
| get |
wandb からアーティファクトをダウンロード |
| ls |
wandb プロジェクト内のすべてのアーティファクトをリスト表示 |
| put |
wandb にアーティファクトをアップロード |
11.1 - wandb アーティファクト cache
使用法
wandb artifact cache [OPTIONS] COMMAND [ARGS]...
概要
アーティファクトキャッシュと対話するためのコマンド
オプション
コマンド
| コマンド |
説明 |
| cleanup |
アーティファクトキャッシュからあまり頻繁に使用されないファイルをクリーンアップする |
11.1.1 - wandb アーティファクト cache cleanup
使用方法
wandb artifact cache cleanup [OPTIONS] TARGET_SIZE
概要
Artifactsのキャッシュから、使用頻度の低いファイルをクリーンアップします
オプション
| オプション |
説明 |
--remove-temp / --no-remove-temp |
一時ファイルを削除します |
11.2 - wandb アーティファクト get
使用方法
wandb artifact get [OPTIONS] PATH
概要
wandb からアーティファクトをダウンロードします
オプション
| オプション |
説明 |
--root |
アーティファクトをダウンロードしたいディレクトリー |
--type |
ダウンロードするアーティファクトのタイプ |
11.3 - wandb アーティファクト ls
使用方法
wandb artifact ls [OPTIONS] PATH
概要
wandb プロジェクト内のすべてのアーティファクトを一覧表示します
オプション
| オプション |
説明 |
-t, --type |
一覧表示するアーティファクトのタイプ |
11.4 - wandb アーティファクト put
使用方法
wandb artifact put [OPTIONS] PATH
概要
アーティファクトを wandb にアップロードします
オプション
| オプション |
説明 |
-n, --name |
プッシュするアーティファクトの名前: project/artifact_name |
-d, --description |
このアーティファクトの説明 |
-t, --type |
アーティファクトのタイプ |
-a, --alias |
このアーティファクトに適用するエイリアス |
--id |
アップロードしたい run を指定します。 |
--resume |
現在のディレクトリーから前回の run を再開します。 |
--skip_cache |
アーティファクトファイルのアップロード中にキャッシュをスキップします。 |
--policy [mutable|immutable] |
アーティファクトファイルをアップロードする際のストレージポリシーを設定します。 |
12 - wandb サーバー
使用方法
wandb server [OPTIONS] COMMAND [ARGS]...
概要
ローカル W&B サーバーを操作するためのコマンド
オプション
コマンド
| コマンド |
説明 |
| start |
ローカル W&B サーバーを開始する |
| stop |
ローカル W&B サーバーを停止する |
12.1 - wandb サーバー start
使用方法
wandb server start [OPTIONS]
概要
ローカル W&B サーバーを開始します
オプション
| オプション |
説明 |
-p, --port |
バインドする W&B サーバーのホストポート |
-e, --env |
wandb/local に渡す環境変数 |
--daemon / --no-daemon |
デーモンモードで run またはデーモンモードで run しない |
12.2 - wandb サーバー stop
使用方法
wandb server stop [OPTIONS]
概要
ローカルの W&B サーバーを停止する
オプション
13 - wandb エージェント
使用方法
wandb agent [OPTIONS] SWEEP_ID
概要
W&B エージェントを実行します
オプション
| オプション |
説明 |
-p, --project |
sweep から作成された W&B runs が送信されるプロジェクトの名前。プロジェクトが指定されていない場合、run は「Uncategorized」というラベルのプロジェクトに送信されます。 |
-e, --entity |
sweep によって作成された W&B runs を送信したいユーザー名またはチーム名。指定した entity が既に存在することを確認してください。entity を指定しない場合、run は通常ユーザー名であるデフォルトの entity に送信されます。 |
--count |
このエージェントの最大 run 数。 |
14 - wandb ベータ版
使い方
wandb beta [OPTIONS] COMMAND [ARGS]...
概要
wandb CLI コマンドのベータ版です。wandb-core が必要です。
オプション
コマンド
| コマンド |
説明 |
| sync |
トレーニング run を W&B にアップロードします |
14.1 - wandb ベータ 同期
使用法
wandb beta sync [OPTIONS] WANDB_DIR
概要
トレーニング run を W&B にアップロードします
オプション
| オプション |
説明 |
--id |
アップロードしたい run です。 |
-p, --project |
アップロードしたい project です。 |
-e, --entity |
スコープにする entity です。 |
--skip-console |
コンソールログをスキップします |
--append |
run を追加します |
-i, --include |
含めるためのグロブ。複数回使用可能です。 |
-e, --exclude |
除外するためのグロブ。複数回使用可能です。 |
--mark-synced / --no-mark-synced |
run を同期済みとしてマークします |
--skip-synced / --no-skip-synced |
同期済みの run をスキップします |
--dry-run |
何もアップロードせずにドライ run を実行します。 |
15 - wandb ローンンチ
Usage
wandb launch [OPTIONS]
Summary
W&B ジョブ をローンンチまたはキューに追加します。詳細は https://wandb.me/launch を参照してください。
Options
| Option |
Description |
-u, --uri (str) |
ローカルパスまたはローンンチする git リポジトリ uri 。指定された場合、このコマンドは指定された uri からジョブを作成します。 |
-j, --job (str) |
ローンンチするジョブの名前。指定されると、ローンンチには uri が不要です。 |
--entry-point |
プロジェクト内のエントリーポイント。[デフォルト: main]。エントリーポイントが見つからない場合、指定された名前のプロジェクトファイルをスクリプトとして実行しようとします。’.py’ ファイルは ‘python’ を使用し、’.sh’ ファイルは環境変数 $SHELL によって指定されたデフォルトのシェルを使用して実行します。指定された場合、設定ファイルを使用して渡されたエントリーポイントの値を上書きします。 |
--build-context (str) |
ソースコード内のビルドコンテキストのパス。デフォルトはソースコードのルート。-u と互換性があります。 |
--name |
run を実行する際に使用する run の名前。指定されない場合、ランダムな run 名が割り当てられます。指定された場合、設定ファイルを使用して渡された名前を上書きします。 |
-e, --entity (str) |
新しい run が送信されるターゲットエンティティの名前。デフォルトは、ローカルの wandb/settings フォルダで設定されたエンティティを使用します。指定された場合、設定ファイルを使用して渡されたエンティティの値を上書きします。 |
-p, --project (str) |
新しい run が送信されるターゲットプロジェクトの名前。デフォルトは、ソース uri または Github run の場合、git リポジトリ名を使用します。指定された場合、設定ファイルを使用して渡されたプロジェクトの値を上書きします。 |
-r, --resource |
run に使用する実行リソース。サポートされている値: ’local-process’, ’local-container’, ‘kubernetes’, ‘sagemaker’, ‘gcp-vertex’。リソース設定のないキューにプッシュする場合、これは必須のパラメータです。指定された場合、設定ファイルを使用して渡されたリソースの値を上書きします。 |
-d, --docker-image |
使用したい特定の Docker イメージ。形式は name:tag 。指定された場合、設定ファイルを使用して渡された Docker イメージの値を上書きします。 |
--base-image |
ジョブコードを実行する Docker イメージ。–docker-image と互換性がありません。 |
-c, --config |
JSON ファイル（’.json’ で終わる必要があります）または JSON 文字列のパス。ローンンチ設定として渡されます。launch run がどのように設定されるかの指示。 |
-v, --set-var |
許可リストが有効になっているキューのために、キーと値のペアとしてテンプレート変数の値を設定します。例: --set-var key1=value1 --set-var key2=value2 |
-q, --queue |
プッシュする run キューの名前。指定されない場合、単一の run を直接ローンンチします。引数なしで指定された場合 (--queue)、キュー ‘default’ がデフォルトとなります。それ以外の場合、指定された名前が引数として供給されたプロジェクトとエンティティの下に存在する必要があります。 |
--async |
ジョブを非同期に実行するためのフラグ。デフォルトは false です。つまり、–async が設定されていない限り、wandb launch はジョブの終了を待ちます。このオプションは –queue と互換性がありません。エージェントを使用して非同期オプションを実行する場合は、wandb launch-agent で設定する必要があります。 |
--resource-args |
JSON ファイル（’.json’ で終わる必要があります）または計算リソースに引数として渡される JSON 文字列のパス。提供されるべき正確な内容は実行バックエンドごとに異なります。このファイルのレイアウトについてはドキュメントを参照してください。 |
--dockerfile |
ジョブをビルドするために使用される Dockerfile のパス。ジョブのルートに対する相対パス。 |
| `–priority [critical |
high |
16 - wandb ローンンチ-sweep
使用方法
wandb launch-sweep [OPTIONS] [CONFIG]
概要
W&B Launch Sweep を実行します (実験的機能)。
オプション
| オプション |
説明 |
-q, --queue |
sweep をプッシュするキューの名前 |
-p, --project |
エージェントが監視するプロジェクトの名前。指定した場合、設定ファイルで渡されたプロジェクトの値を上書きします |
-e, --entity |
使用するエンティティ。デフォルトは現在ログインしているユーザーです |
-r, --resume_id |
8文字のsweep IDを渡してlaunch sweep を再開します。キューが必要です |
--prior_run |
このsweep に追加する既存のrun のID |
17 - wandb ローンンチ-エージェント
使用方法
wandb launch-agent [OPTIONS]
概要
W&B ローンンチ エージェントを実行します。
オプション
| オプション |
説明 |
-q, --queue |
エージェントが監視するキューの名前。複数の -q フラグをサポート。 |
-e, --entity |
使用するエンティティ。デフォルトでは現在ログイン中のユーザーが使用されます。 |
-l, --log-file |
内部エージェント ログの出力先。stdout の場合は - を使用。 デフォルトでは、すべてのエージェントログは wandb/ サブディレクトリーまたは WANDB_DIR に設定されている場合は debug.log に保存されます。 |
-j, --max-jobs |
このエージェントが並行して実行できる最大のローンンチジョブ数。デフォルトは 1。上限なしの場合は -1 に設定します。 |
-c, --config |
使用するエージェントコンフィグ yaml へのパス |
-v, --verbose |
詳細出力を表示 |
18 - wandb オンライン
使い方
wandb online [OPTIONS]
概要
W&B 同期を有効にする
オプション
19 - wandb コントローラ
使用法
wandb コントローラ [OPTIONS] SWEEP_ID
概要
W&B ローカル sweep コントローラを実行します
オプション
| オプション |
説明 |
--verbose |
詳細な出力を表示する |
20 - wandb ジョブ
使用法
wandb job [OPTIONS] COMMAND [ARGS]...
概要
W&B ジョブを管理および表示するためのコマンド
オプション
コマンド
| コマンド |
説明 |
| create |
wandb run なしでソースからジョブを作成します。 |
| describe |
ローンンチジョブについて説明します。 |
| list |
プロジェクト内のジョブを一覧表示します。 |
20.1 - wandb job create
使用方法
wandb job create [OPTIONS] {git|code|image} PATH
概要
wandb run を使用せずにソースからジョブを作成します。
ジョブには、git、code、または image の3種類があります。
git: パス内またはメインの Python 実行可能ファイルを指すエントリポイントを明示的に指定した git ソースです。code: requirements.txt ファイルを含むコードパスです。image: Docker イメージです。
オプション
| オプション |
説明 |
-p, --project |
ジョブをリストするプロジェクトを指定します。 |
-e, --entity |
ジョブが属するエンティティ |
-n, --name |
ジョブの名前 |
-d, --description |
ジョブの説明 |
-a, --alias |
ジョブのエイリアス |
--entry-point |
スクリプトのエントリポイントで、実行可能ファイルとエントリポイントファイルを含みます。code または repo ジョブでは必須です。–build-context が提供されている場合、エントリポイントコマンド内のパスはビルドコンテキストに対して相対的なものになります。 |
-g, --git-hash |
git ジョブのソースとして使用するコミット参照 |
-r, --runtime |
ジョブを実行する Python ランタイム |
-b, --build-context |
ジョブのソースコードのルートからビルドコンテキストへのパスです。提供されている場合、これが Dockerfile とエントリポイントのベースパスとして使用されます。 |
--base-image |
ジョブに使用するベースイメージ。image ジョブとは互換性がありません。 |
--dockerfile |
ジョブの Dockerfile へのパス。–build-context が提供されている場合、Dockerfile のパスはビルドコンテキストに対して相対的になります。 |
20.2 - wandb job describe
使用方法
wandb job describe [OPTIONS] JOB
概要
ローンンチ ジョブについて説明します。次の形式でローンンチ ジョブを指定してください。
entity/project/job-name:alias-or-version
オプション
20.3 - wandb job list
使用法
wandb job list [OPTIONS]
概要
プロジェクト内のジョブを一覧表示
オプション
| オプション |
説明 |
-p, --project |
ジョブを一覧表示したいプロジェクト。 |
-e, --entity |
ジョブが所属するエンティティ |
21 - wandb ステータス
使用方法
wandb status [OPTIONS]
概要
設定の表示
オプション
| オプション |
説明 |
--settings / --no-settings |
現在の設定を表示 |
22 - wandb スケジューラー
使用方法
wandb scheduler [OPTIONS] SWEEP_ID
概要
W&B ローンンチ sweep スケジューラーを実行する（実験的）
オプション
23 - wandb ログイン
使用方法
wandb login [OPTIONS] [KEY]...
概要
Weights & Biases へログイン
オプション
| オプション |
説明 |
--cloud |
ローカルではなくクラウドにログイン |
--host, --base-url |
W&B の特定のインスタンスにログイン |
--relogin |
すでにログインしている場合でも再ログインを強制 |
--anonymously |
匿名でログイン |
--verify / --no-verify |
ログイン資格情報を確認 |
24 - wandb 有効
使用方法
wandb enabled [OPTIONS]
概要
W&B を有効にします。
オプション
| オプション |
説明 |
--service |
W&B サービスを有効にする [デフォルト: True] |