これは、このセクションの複数ページの印刷可能なビューです。 印刷するには、ここをクリックしてください.

このページの通常のビューに戻る.

Command Line Interface

使用方法

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 ジョブ を ローンチ または キュー に入れます。
launch-agent W&B ローンチ エージェント を実行します。
launch-sweep W&B ローンチ sweep を実行します（試験的）。
login Weights & Biases にログインします。
offline W&B の同期を無効にします。
online W&B の同期を有効にします。
pull Weights & Biases から ファイル をプルします。
restore run の コード 、設定、および docker の状態を復元します。
scheduler W&B ローンチ sweep スケジューラ を実行します（試験的）。
server ローカル W&B サーバー を操作するための コマンド です。
status 設定 を表示します。
sweep ハイパーパラメーター探索 を初期化します。
sync オフライン の トレーニング ディレクトリー を W&B にアップロードします。
verify ローカル インスタンス を検証します。

1 - wandb agent

使用方法

wandb agent [OPTIONS] SWEEP_ID

概要

W&B エージェントを実行します。

オプション

オプション 説明
-p, --project sweep から作成された W&B の run を送信する プロジェクト の名前。 プロジェクト が指定されていない場合、run は「Uncategorized (未分類)」というラベルの プロジェクト に送信されます。
-e, --entity sweep によって作成された W&B の run を送信する ユーザー 名または チーム 名。 指定する entity が既に存在することを確認してください。 entity を指定しない場合、run はデフォルトの entity (通常は ユーザー 名) に送信されます。
--count この エージェント の run の最大数。

2 - wandb artifact

Usage

wandb artifact [OPTIONS] COMMAND [ARGS]...

Summary

Artifacts を操作するためのコマンド

Options

Option Description

Commands

Command Description
cache artifact キャッシュを操作するためのコマンド
get wandb から artifact をダウンロード
ls wandb の プロジェクト 内の全ての artifact をリスト表示
put wandb に artifact をアップロード

2.1 - wandb artifact cache

使用方法

wandb artifact cache [OPTIONS] COMMAND [ARGS]...

概要

Artifacts キャッシュを操作するためのコマンド

オプション

オプション 説明

コマンド

コマンド 説明
cleanup Artifacts キャッシュから使用頻度の低いファイルをクリーンアップします

2.1.1 - wandb artifact cache cleanup

使用方法

wandb artifact cache cleanup [OPTIONS] TARGET_SIZE

概要

Artifacts のキャッシュから、あまり使用されていないファイルをクリーンアップします。

オプション

オプション 説明
--remove-temp / --no-remove-temp 一時ファイルを削除します

2.2 - wandb artifact get

使用方法

wandb artifact get [OPTIONS] PATH

概要

wandb からアーティファクトをダウンロードします。

オプション

オプション 説明
--root アーティファクトをダウンロードするディレクトリー
--type ダウンロードするアーティファクトのタイプ

2.3 - wandb artifact ls

Usage

wandb artifact ls [OPTIONS] PATH

概要

wandb プロジェクト内のすべての Artifacts をリスト表示します。

オプション

オプション 説明
-t, --type リスト表示する Artifacts のタイプ

2.4 - wandb artifact 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] アーティファクト ファイルのアップロード中にストレージポリシーを設定します。

3 - wandb beta

使用方法

wandb beta [OPTIONS] COMMAND [ARGS]...

概要

wandb CLI コマンドのベータ版。wandb-core が必要です。

オプション

オプション 説明

コマンド

コマンド 説明
sync トレーニング run を W&B にアップロードします

3.1 - wandb beta sync

使用方法

wandb beta sync [OPTIONS] WANDB_DIR

概要

トレーニング run を W&B にアップロードします。

オプション

オプション 説明
--id アップロード先の run。
-p, --project アップロード先の project。
-e, --entity スコープする entity。
--skip-console コンソール ログをスキップします。
--append run を追加します。
-i, --include 含める glob。複数回使用できます。
-e, --exclude 除外する glob。複数回使用できます。
--mark-synced / --no-mark-synced run を同期済みとしてマークします。
--skip-synced / --no-skip-synced 同期済みの run をスキップします。
--dry-run 何もアップロードせずに dry run を実行します。

4 - wandb controller

使用法

wandb controller [OPTIONS] SWEEP_ID

概要

W&B ローカル sweep コントローラを実行します。

オプション

オプション 説明
--verbose 詳細な出力を表示します。

5 - wandb disabled

使用法

wandb disabled [OPTIONS]

概要

W&B を無効にします。

オプション

オプション 説明
--service W&B サービスを無効にします [デフォルト: True]

6 - wandb docker

使用方法

wandb docker [OPTIONS] [DOCKER_RUN_ARGS]... [DOCKER_IMAGE]

概要

dockerコンテナ内でコードを実行します。

W&B docker を使用すると、wandb が確実に構成されるように、docker イメージでコードを実行できます。WANDB_DOCKER と WANDB_API_KEY の 環境 変数をコンテナに追加し、デフォルトで現在の ディレクトリー を /app にマウントします。イメージ名が宣言される前に docker run に追加される追加の arg を渡すことができます。イメージが渡されない場合は、デフォルトのイメージを選択します。

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 の存在を確認し、存在しない場合はインストールするために、エントリポイントをオーバーライドします。--jupyter フラグを渡すと、jupyter がインストールされていることを確認し、ポート 8888 で jupyter lab を起動します。システムで nvidia-docker が検出された場合は、nvidia ランタイムを使用します。既存の docker run コマンドに 環境 変数を設定するために wandb のみが必要な場合は、wandb docker-run コマンドを参照してください。

**オプション**

| **オプション** | **説明** |
| :--- | :--- |
| `--nvidia / --no-nvidia` | nvidia ランタイムを使用します。nvidia-docker が存在する場合は、デフォルトで nvidia になります。 |
| `--digest` | イメージ ダイジェストを出力して終了します |
| `--jupyter / --no-jupyter` | コンテナ内で jupyter lab を実行します |
| `--dir` | コンテナ内のコードをマウントする ディレクトリー |
| `--no-dir` | 現在の ディレクトリー をマウントしません |
| `--shell` | コンテナの起動に使用するシェル |
| `--port` | jupyter をバインドするホスト ポート |
| `--cmd` | コンテナで実行する コマンド |
| `--no-tty` | tty なしで コマンド を実行します |

7 - wandb docker-run

使用方法

wandb docker-run [OPTIONS] [DOCKER_RUN_ARGS]...

概要

docker run をラップし、WANDB_API_KEY と WANDB_DOCKER 環境変数を追加します。

また、nvidia-docker 実行可能ファイルがシステムに存在し、–runtime が設定されていない場合、ランタイムを nvidia に設定します。

詳細については、docker run --help を参照してください。

オプション

オプション 説明

8 - wandb enabled

使用方法

wandb enabled [OPTIONS]

概要

W&B を有効にします。

オプション

オプション 説明
--service W&B サービスを有効にします [デフォルト: True]

9 - wandb init

使用方法

wandb init [OPTIONS]

概要

ディレクトリー を Weights & Biases で構成します。

オプション

オプション 説明
-p, --project 使用する project。
-e, --entity project のスコープとなる entity。
--reset 設定をリセットします。
-m, --mode “online”、“offline”、または “disabled” を指定できます。デフォルトは online です。

10 - wandb job

使用方法

wandb job [OPTIONS] COMMAND [ARGS]...

概要

W&B jobs を管理および表示するためのコマンド

オプション

オプション 説明

コマンド

コマンド 説明
create wandb run なしで、ソースから job を作成します。
describe Launch job を記述します。
list プロジェクト 内の jobs をリスト表示します

10.1 - wandb job create

使用法

wandb job create [OPTIONS] {git|code|image} PATH

概要

wandb の run なしで、ソースから Job を作成します。

Job には、git、code、または image の3つのタイプがあります。

git: git ソース。パス内または明示的に指定されたエントリポイントが、メインの Python 実行可能ファイルを指します。 code: requirements.txt ファイルを含むコードパス。 image: Docker イメージ。

オプション

オプション 説明
-p, --project Job をリストする Project。
-e, --entity Job が属する Entity。
-n, --name Job の名前。
-d, --description Job の説明。
-a, --alias Job のエイリアス。
--entry-point 実行可能ファイルとエントリポイントファイルを含む、スクリプトのエントリポイント。 code または repo Job に必要です。 –build-context が指定されている場合、エントリポイントコマンドのパスはビルドコンテキストからの相対パスになります。
-g, --git-hash git Job のソースとして使用するコミット参照。
-r, --runtime Job を実行する Python ランタイム。
-b, --build-context Job ソースコードのルートからのビルドコンテキストへのパス。 これが指定されている場合、Dockerfile とエントリポイントのベースパスとして使用されます。
--base-image Job に使用するベースイメージ。image Job と互換性がありません。
--dockerfile Job の Dockerfile へのパス。 –build-context が指定されている場合、Dockerfile のパスはビルドコンテキストからの相対パスになります。

10.2 - wandb job describe

使用方法

wandb job describe [OPTIONS] JOB

概要

Launch job について説明します。Launch job は、エンティティ/プロジェクト/job-name:エイリアス-or-バージョン の形式で指定してください。

オプション

オプション 説明

10.3 - wandb job list

使用法

wandb job list [OPTIONS]

概要

プロジェクト 内の job をリスト表示します。

オプション

オプション 説明
-p, --project job をリスト表示したい プロジェクト。
-e, --entity job が属する Entity。

11 - wandb launch

使用方法

wandb launch [OPTIONS]

概要

W&B Job を Launch またはキューに入れます。https://wandb.me/launch を参照してください。

オプション

オプション 説明
-u, --uri (str) Launch するローカルパスまたは git リポジトリ URI。これが指定されると、指定された URI からジョブが作成されます。
-j, --job (str) Launch するジョブの名前。これが渡されると、Launch は URI を必要としません。
--entry-point プロジェクト内のエントリポイント。[default: main]。エントリポイントが見つからない場合、指定された名前のプロジェクトファイルをスクリプトとして実行しようとします。.py ファイルを実行するには「python」を使用し、.sh ファイルを実行するにはデフォルトシェル（環境変数 $SHELL で指定）を使用します。これが渡されると、設定ファイルを使用して渡されたエントリポイントの値を上書きします。
--build-context (str) ソースコード内のビルドコンテキストへのパス。デフォルトはソースコードのルートです。-u とのみ互換性があります。
--name run を Launch する run の名前。指定しない場合、ランダムな run 名が run の Launch に使用されます。これが渡されると、設定ファイルを使用して渡された名前を上書きします。
-e, --entity (str) 新しい run の送信先となるターゲット Entity の名前。デフォルトでは、ローカルの wandb/settings フォルダで設定された Entity が使用されます。これが渡されると、設定ファイルを使用して渡された Entity の値を上書きします。
-p, --project (str) 新しい run の送信先となるターゲット Project の名前。デフォルトでは、ソース URI によって指定された Project 名、または github run の場合は git リポジトリ名が使用されます。これが渡されると、設定ファイルを使用して渡された Project の値を上書きします。
-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」で終わる必要があります）または Launch 設定として渡される JSON 文字列へのパス。Launch された run の構成方法を指示します。
-v, --set-var 許可リストが有効になっているキューのテンプレート変数の値を、キーと値のペアとして設定します。例：--set-var key1=value1 --set-var key2=value2
-q, --queue プッシュ先の run キューの名前。ない場合は、単一の run を直接 Launch します。引数なしで指定された場合（--queue）、デフォルトではキュー「default」になります。それ以外の場合、名前が指定されている場合は、指定された run キューが、指定された Project および Entity の下に存在する必要があります。
--async ジョブを非同期で実行するためのフラグ。デフォルトは false です。つまり、–async が設定されていない限り、wandb launch はジョブが完了するまで待機します。このオプションは –queue と互換性がありません。エージェント での実行時に非同期オプションは wandb launch-agent で設定する必要があります。
--resource-args コンピュートリソースにリソース引数として渡される JSON ファイル（「.json」で終わる必要があります）または JSON 文字列へのパス。提供する必要がある正確な内容は、実行バックエンドごとに異なります。このファイルのレイアウトについては、ドキュメントを参照してください。
--dockerfile ジョブの構築に使用される Dockerfile へのパス（ジョブルートからの相対パス）。
`–priority [critical high

12 - wandb launch-agent

使用方法

wandb launch-agent [OPTIONS]

概要

W&B Launch エージェント を実行します。

オプション

オプション 説明
-q, --queue エージェント が監視するキューの名前。複数の -q フラグがサポートされています。
-e, --entity 使用するエンティティ。デフォルトは現在ログインしている ユーザー
-l, --log-file 内部 エージェント ログの出力先。stdout には - を使用します。デフォルトでは、すべての エージェント ログは wandb/ サブディレクトリーまたは WANDB_DIR （設定されている場合）の debug.log に出力されます。
-j, --max-jobs この エージェント が並行して実行できる Launch jobs の最大数。デフォルトは 1 です。上限なしの場合は -1 に設定します。
-c, --config 使用する エージェント 設定 yaml へのパス
-v, --verbose 詳細な出力を表示

13 - wandb launch-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

14 - wandb login

利用方法

wandb login [OPTIONS] [KEY]...

概要

Weights & Biases にログインします。

オプション

オプション 説明
--cloud ローカルではなく クラウド にログインします。
--host, --base-url W&B の特定のインスタンスにログインします。
--relogin すでにログインしている場合に、強制的に再ログインします。
--anonymously 匿名でログインします。
--verify / --no-verify ログイン認証情報を確認します。

15 - wandb offline

使用法

wandb offline [OPTIONS]

概要

W&B の同期を無効にします。

オプション

オプション 説明

16 - wandb online

使用法

wandb online [OPTIONS]

概要

W&B の同期を有効にします。

オプション

オプション 説明

17 - wandb pull

Usage

wandb pull [OPTIONS] RUN

概要

Weights & Biases からファイルをpullします。

オプション

オプション 説明
-p, --project ダウンロードしたい project。
-e, --entity リストの範囲とする entity。

18 - wandb restore

使用法

wandb restore [OPTIONS] RUN

概要

run のコード、config、および Docker の状態を復元します。

オプション

オプション 説明
--no-git git の状態を復元しない
--branch / --no-branch ブランチを作成するか、デタッチしてチェックアウトするか
-p, --project アップロード先の project 。
-e, --entity リストのスコープとなる entity 。

19 - wandb scheduler

使い方

wandb scheduler [OPTIONS] SWEEP_ID

概要

W&B Launch sweep scheduler (実験的) を実行します。

オプション

オプション 説明

20 - wandb server

使用法

wandb server [OPTIONS] COMMAND [ARGS]...

概要

ローカルの W&B サーバーを操作するための コマンド です。

オプション

オプション 説明

コマンド

コマンド 説明
start ローカルの W&B サーバーを起動します。
stop ローカルの W&B サーバーを停止します。

20.1 - wandb server start

使用法

wandb server start [OPTIONS]

概要

ローカルの W&B サーバーを起動します。

オプション

オプション 説明
-p, --port W&B サーバーをバインドするホストポート
-e, --env wandb/local に渡す Env vars
--daemon / --no-daemon デーモンモードで実行するかどうか

20.2 - wandb server stop

使用法

wandb server stop [OPTIONS]

概要

ローカルの W&B サーバー を停止します。

オプション

オプション 説明

21 - wandb status

使用方法

wandb status [OPTIONS]

概要

設定 を表示

オプション

オプション 説明
--settings / --no-settings 現在の 設定 を表示

22 - wandb sweep

Usage

wandb sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID

Summary

ハイパーパラメータ ー探索を初期化します。様々な組み合わせをテストすることで、機械学習 モデルのコスト関数を最適化するハイパーパラメータ ーを探索します。

Options

Option Description
-p, --project sweep から作成された W&B の run が送信される project の名前。 project が指定されていない場合、run は「Uncategorized（未分類）」というラベルの付いた project に送信されます。
-e, --entity sweep によって作成された W&B の run を送信したい user 名または Team 名。指定する Entity がすでに存在することを確認してください。 Entity を指定しない場合、run はデフォルトの Entity（通常は user 名）に送信されます。
--controller ローカルのコントローラ を実行
--verbose 詳細な出力を表示
--name sweep の名前。名前が指定されていない場合は、sweep ID が使用されます。
--program sweep プログラムを設定
--update 保留中の sweep を更新
--stop sweep を終了して、新しい run の実行を停止し、現在実行中の run を完了させます。
--cancel sweep をキャンセルして、実行中のすべての run を強制終了し、新しい run の実行を停止します。
--pause sweep を一時停止して、新しい run の実行を一時的に停止します。
--resume sweep を再開して、新しい run の実行を継続します。
--prior_run この sweep に追加する既存の run の ID

23 - wandb sync

使用方法

wandb sync [OPTIONS] [PATH]...

概要

オフラインのトレーニング ディレクトリー を W&B にアップロードします。

オプション

オプション 説明
--id アップロード先の run を指定します。
-p, --project アップロード先の project を指定します。
-e, --entity スコープする entity を指定します。
--job_type 関連する run をグループ化するための run の種類を指定します。
--sync-tensorboard / --no-sync-tensorboard tfevent ファイルを wandb にストリームします。
--include-globs 含める glob のカンマ区切りリスト。
--exclude-globs 除外する glob のカンマ区切りリスト。
--include-online / --no-include-online オンライン run を含めます。
--include-offline / --no-include-offline オフライン run を含めます。
--include-synced / --no-include-synced 同期済みの run を含めます。
--mark-synced / --no-mark-synced run を同期済みとしてマークします。
--sync-all すべての run を同期します。
--clean 同期済みの run を削除します。
--clean-old-hours 指定した時間より前に作成された run を削除します。–clean フラグと組み合わせて使用​​します。
--clean-force 確認プロンプトなしでクリーンします。
--show 表示する run の数
--append run を追加します。
--skip-console コンソール ログをスキップします。

24 - wandb verify

使用方法

wandb verify [OPTIONS]

概要

ローカルインスタンスを検証します。

オプション

オプション 説明
--host W&B の特定のインスタンスをテストします。