Skip to main content

クラス wandb.Settings

W&B SDK の Settings クラスです。 このクラスは W&B SDK の設定を管理し、 すべての設定でタイプ安全性と検証が確保されるようにします。Settings には属性としてアクセスでき、 プログラムから、環境変数 (WANDB_ プレフィックス) 、および設定ファイルを通じて初期化できます。 設定は次の 3 つのカテゴリに分類されます。
  1. Public settings: ユーザーが安全に変更でき、特定のニーズに合わせて W&B の動作をカスタマイズするための中核的な設定オプションです。
  2. Internal settings: ‘x_’ で始まる Settings で、SDK の低レベルな動作を扱います。 これらの設定は主に内部利用とデバッグ用です。変更は可能ですが、 Public API の一部とは見なされず、将来の バージョンで予告なく変更される場合があります。
  3. Computed settings: 他の設定または 環境から自動的に導出される読み取り専用の Settings です。
Settings は複数のソースから読み込まれます。同じ設定が 複数のソースから指定された場合は、 後に記載されたソースが優先されます。優先順位の低いものから高いものの順に示します。
  1. この Settings モデルで定義されているデフォルト値。
  2. 設定ファイル (~/.config/wandb/settings、または WANDB_CONFIG_DIR 環境変数で指定されたディレクトリ内の settings ファイル)。
  3. 環境変数 (WANDB_ で始まるもの。例: WANDB_MODE)。
  4. ホスト名、 実行中のプログラムまたはスクリプトのパス、Python 実行ファイル、Docker image、 Jupyter ノートブックの詳細など、実行時環境から検出される値。
  5. Amazon SageMaker 環境で実行している場合の SageMaker 設定。
  6. wandb.setup()settings パラメーター。
  7. wandb.init()settings パラメーター。
  8. 一部の wandb.init() パラメーター (たとえば、mode=mode 設定を上書きします)。

引数

メディアファイルを run ディレクトリにシンボリックリンクするかどうか。true の場合、メディアファイルはコピーする代わりに、 run ディレクトリにシンボリックリンクまたはハードリンクされます。これにより、 ログすることが高速化され、ディスク使用量を削減できる場合があります。ただし、 W&B サーバーへのアップロード前に元のファイルを削除または変更すると、 その内容がアップロードデータに反映されます。
bool
オフラインモードで表のアーティファクトを同期できるようにするフラグ。以前の動作に戻すには、これを False に設定します。
bool
Config 値を設定後に変更できるようにするフラグ。
object
非推奨であり、削除される予定です。
str | None
W&B APIキー。
dict[str, str] | None
Azure インテグレーション用の、Azure アカウント URL と対応するアクセスキーのマッピング。
str | None
W&B UI の「app」URL のオーバーライド。通常、app_urlbase_url に基づいて算出されますが、これを使用して 明示的に設定できます。WANDB_APP_URL は対応する環境変数です。
str
データ同期に使用する W&B バックエンドの URL。
str | None
W&B でトラッキングするコードを含むディレクトリ。
collections.abc.Sequence[str] | None
Config オブジェクトに読み込む設定ファイルのパス。
Literal
適用するコンソール出力の取得方法。指定可能な値は次のとおりです。
  • “auto” - システム環境と設定に基づいて、コンソール出力の取得方法を 自動的に選択します。
  • “off” - コンソール出力の取得を無効にします。
  • “redirect” - 出力を取得するために低レベルのファイルディスクリプタをリダイレクトします。
  • “wrap” - sys.stdout/sys.stderr の write メソッドをオーバーライドします。システムの状態に基づいて、 “wrap_raw” または “wrap_emu” のいずれかにマッピングされます。
  • “wrap_raw” - “wrap” と同じですが、エミュレーターを介さずに生の出力を直接取得します。 wrap 設定から導出されるため、手動で設定しないでください。
  • “wrap_emu” - “wrap” と同じですが、エミュレーターを介して出力を取得します。 wrap 設定から導出されるため、手動で設定しないでください。
bool
マルチパートコンソールログを有効にします。True の場合、SDK はコンソール出力を単一の output.log ではなく、 logs/ ディレクトリ以下のタイムスタンプ付きファイルに書き込みます。各パートは閉じられるとすぐにアップロードされるため、run がアクティブな間、 ユーザーはログにリアルタイムでアクセスできます。ロールオーバーの頻度は console_chunk_max_bytes および/または console_chunk_max_seconds によって制御されます。 両方の制限が 0 の場合、すべてのログは run の終了時に一度だけアップロードされます。注: アップロードされたチャンクは不変です。以前の行を変更するターミナル制御シーケンス (例: キャリッジリターンを使用するプログレスバー) は、 現在のチャンクにのみ影響します。
int
マルチパートコンソールログのサイズベースのロールオーバーしきい値 (バイト単位) 。現在のパートがこのサイズに達すると、新しいコンソールログファイルを開始します。 console_multipartTrue の場合にのみ有効です。 console_chunk_max_seconds と組み合わせて使用できます。先に 到達した制限によってロールオーバーがトリガーされます。値を 0 にすると、 サイズベースの制限が無効になります。
int
マルチパートコンソールログの時間ベースのロールオーバーしきい値 (秒単位) 。現在のパートの開始からこの秒数が経過すると、新しいコンソールログファイルを開始します。 console_multipartTrue にする必要があります。console_chunk_max_bytes と 併用できます。先に到達した制限によってパートが閉じられます。値を 0 にすると、時間ベースの 制限が無効になります。
dict[str, str] | None
run の Logs タブに取得する Python ロガーの名前。ロガー名と最小ログレベルのマッピングです。設定すると、wandb は 指定した各ロガーに logging.Handler をインストールし、run の終了時に削除します。 これらのロガーから出力されたログレコードは、stdout/stderr の取得と同様に、 run のコンソール出力として公開されます。ログレコードは logging.basicConfig() と同じ形式でフォーマットされます。たとえば、 INFO:my_module:Some message. のようになります。現在、この形式はカスタマイズできません。すべてのログを取得するには、ルートロガー名である ‘root’ を渡します。これは console 設定とは独立しており、両方を同時に有効にできます。例:
str
一時的なアクセストークンを書き込むファイルへのパス。
bool
コードの取得を無効にするかどうか。
bool
Git の状態の取得を無効にするかどうか。
bool
リモートブランチからフォークポイントを推測する機能を無効にするかどうか。True に設定すると、アップストリームブランチが設定されている場合、SDK はそのブランチの 最新コミットを使用します。設定されていない場合は、差分パッチの生成をスキップします。False に設定すると、アップストリームブランチが設定されている場合、SDK はそのブランチの最新コミットの使用を試みます。 それ以外の場合は、すべてのリモートブランチから最も近いコミットを検索します。 アップストリームブランチが多数あるリポジトリでは、パフォーマンスに影響する可能性があります。
bool
W&B Launch 用のジョブ アーティファクトの作成を無効にするかどうか。
str | None
スクリプトの実行に使用する Docker イメージ。
str | None
ユーザーのメールアドレス。
str | None
ユーザーやチームなどの W&B エンティティ。
str | None
W&B 組織。
bool
wandb.login()force フラグを渡すかどうか。
wandb.sdk.lib.run_moment.RunMoment | None
フォーク元とする、以前の run 実行時点を指定します。この時点は、run ID、メトリクス、およびその値で定義されます。 現在、サポートされるメトリクスは ‘_step’ のみです。
str | None
run に関連付ける Git コミットハッシュ。
str
run に関連付ける Git リモート。
str | None
Git リモートリポジトリの URL。
str | None
Git リポジトリのルートディレクトリ。
str | None
スクリプトを実行するマシンのホスト名。
str | None
W&B への HTTP リクエストに使用するカスタムプロキシサーバー。
str | None
W&B への HTTPS リクエストに使用するカスタムプロキシサーバー。
str | None
認証用のアイデンティティトークン (JWT) を含むファイルへのパス。
Sequence
アップロードから除外する file を指定する、files_dir を基準とした Unix glob パターン。
float
タイムアウトまで wandb.init 呼び出しの完了を待機する時間 (秒) 。
float
run の終了時にデータのアップロードを待機する秒数です。この値を設定すると、run の終了時に W&B へのアップロードが遅いことで発生するコストを抑えられますが、その代わりに run は crashed としてマークされ、一部のデータが欠落する可能性があります。デフォルトでは、すべてのデータのアップロードが完了するまで run.finish() がブロックされます。これをゼロより大きい数値に設定すると、run の終了時にこの秒数が経過した後、W&B は run のデータのアップロードを中止し、スクリプトのブロックを解除します。しばらくすると、UI で run は Crashed または Failed と表示されます。アップロードされなかったデータは引き続きディスクに保存され、wandb sync でアップロードできます。警告メッセージの出力に加えてエラーを発生させるには、finish_timeout_raises 設定を使用します。wandb.teardown() によって終了される Runs (atexit フックでスクリプト終了時に自動的に実行されます) にも、この設定が適用されます。
bool
finish_timeout が期限切れになった場合に TimeoutError を発生させるかどうかです。これを finish_timeout 設定とともに使用すると、run.finish() はメッセージの出力に加えて、タイムアウト後に TimeoutError を発生させます。Run をコンテキストマネージャーとして使用する場合、run.finish() は暗黙的に呼び出されることに注意してください。with wandb.init() as run: … # with ブロックの終了時に run.finish() が実行されますこれは wandb.teardown() でエラーを発生させません (いずれにしてもスクリプトの終了時に実行されるためです) 。
bool
安全でない方法で SSL 検証を無効にするかどうかです。
str | None
スクリプトを実行している Launch ジョブの名前です。
Optional
Launch のソースタイプです。
bool
自動ラベリング機能を無効にするかどうかです。
str | None
Launch 設定 file へのパスです。
float | None
ログイン操作がタイムアウトするまで待機する秒数です。
Literal
W&B ログすることと同期の動作モードです。
str | None
Jupyter のような環境で実行している場合のノートブック名です。
str | None
利用可能な場合、run を作成したスクリプトへのパスです。
str | None
リポジトリのルートディレクトリから run を作成したスクリプトまでの絶対パスです。リポジトリのルートディレクトリは、存在する場合は .git ディレクトリを含むディレクトリとして定義されます。それ以外の場合は、現在の作業ディレクトリです。
str | None
run を作成したスクリプトへの相対パスです。
str | None
W&B のプロジェクト ID です。
bool
必須ではない出力を抑制するフラグです。
Union
run がアクティブな間に wandb.init() が呼び出された場合の動作です。オプション:
  • “default”: ノートブックでは “finish_previous” を使用し、それ以外では “return_previous” を使用します。
  • “return_previous”: まだ終了していない、最後に作成された run を返します。 これは wandb.run を更新しません。「create_new」オプションを参照してください。
  • “finish_previous”: すべてのアクティブな Runs を終了してから、新しい run を返します。
  • “create_new”: 他のアクティブな Runs を変更せずに新しい run を作成します。 wandb.run および wandb.log などのトップレベル関数は更新しません。 このため、グローバル run に依存する一部の古いインテグレーションは 動作しません。
ブール値を指定することもできますが、これは非推奨です。False は “return_previous” と同じで、True は “finish_previous” と同じです。
bool
新しいログイン試行を強制するフラグです。
Optional
run の再開時の動作を指定します。オプション:
  • “must”: 同じ ID を持つ既存の run から再開します。そのような run が存在しない場合は、 失敗します。
  • “allow”: 同じ ID を持つ既存の run からの再開を試みます。見つからない場合は、 新しい run が作成されます。
  • “never”: 常に新しい run を開始します。同じ ID を持つ run がすでに存在する場合は、 失敗します。
  • “auto”: 同じマシン上で直近に失敗した run から自動的に再開します。
wandb.sdk.lib.run_moment.RunMoment | None
run の以前の実行における再開元の時点を指定します。この時点は、run ID、メトリクス、およびその値で定義されます。 現在サポートされているメトリクスは ‘_step’ のみです。
str
すべての run 関連パスの基準となるルート ディレクトリです。特に、wandb ディレクトリと run ディレクトリの導出に使用されます。
str | None
関連する Runs のグループ識別子です。UI で Runs をグループ化するために使用します。
str | None
run の ID です。
str | None
実行するジョブのタイプ (例: トレーニング、評価) です。
str | None
run の人が読みやすい名前です。
str | None
run に関する追加のメモまたは説明です。
tuple[str, ...] | None
整理やフィルタリングのために run に関連付けるタグです。
bool
SageMaker 固有の機能を無効にするフラグです。
bool | None
run に関連付けられているコードを保存するかどうかです。
str | None
システム全体の設定ファイルへのパスです。
collections.abc.Callable[[], None] | None
run を停止するために実行するコールバックです。run は Web UI から、または致命的なエラー発生後に (設定で構成されている場合) 停止できます。デフォルトでは、run を停止するために W&B はメインスレッドに SIGINT を送信します。 別のシグナルを使用したり、中断前に別のアクションを実行したりするためにこの動作を オーバーライドするには、このコールバックを設定します。コールバックは別のスレッドで実行されます。停止が要求された後すぐに実行されますが、 即時には実行されません。
int
run の終了時に表示する履歴スパークラインの最大数です。
int
run の終了時に表示するサマリー メトリクスの最大数です。
bool
エラー メッセージを表示するかどうかです。
bool
情報メッセージを表示するかどうかです。
bool
警告メッセージを表示するかどうかです。
bool
すべての出力を抑制するフラグです。
bool
致命的なエラーの後に run を停止するかどうかです。W&B でデータのアップロード中に回復不能なエラーが発生すると、メッセージを出力して アップロードを停止しますが、引き続きデータをログできます。 通常、これは望ましい動作です。トレーニング メトリクスはディスクに保存されるため、 アップロードされていない場合でも wandb sync を使用して復元できます。トレーニング後にファイルが削除される場合、これは役に立ちません。 その場合、これを True に設定すると、Web UI で停止ボタンを押した場合と同様に、 致命的なエラーの後に run が停止します。
bool | None
検証およびエラー チェックの厳格モードを有効にするかどうかです。
int
タイムアウトまでサマリー操作を待機する時間 (秒) です。
str | None
この run が属する sweep の識別子です。
str | None
sweep パラメーター設定へのパスです。
シンボリックリンクを使用するかどうかです (Windows 以外ではデフォルトで True) 。
bool | None
TensorBoard ログを W&B と同期するかどうか。
bool
表の行数制限を超えた場合に例外を発生させるかどうか。
bool | None
run データに、非表示の .wandb ディレクトリと表示される wandb ディレクトリのどちらを使用するか。True の場合、SDK は .wandb を使用します。False の場合は wandb を使用します。 設定されていない場合、.wandb がすでに存在すれば .wandb を使用し、存在しない場合は wandb を使用します。
str | None
ユーザー名。
bool
システムメタデータの収集を無効にするフラグ。
bool
システムメトリクスの収集を無効にするフラグ。
dict[str, str] | None
すべての送信 HTTP リクエストに追加するヘッダー。
str | None
run 用に収集されるシステムメトリクスとコンソールログに割り当てるラベル。フロントエンドでデータをグループ化するために使用し、分散トレーニングジョブ内の 異なるプロセスからのデータを区別できます。
bool
内部 wandb ファイルとメタデータを保存するかどうかを決定します。分散環境では、プライマリプロセスが主なログすることを処理し、 システムメトリクスとログのみが必要な場合に、セカンダリプロセスによる ファイルの上書きを回避するのに役立ちます。
bool
requirements ファイルを保存するフラグ。
bool
history から summary を自動計算する処理をサーバーに委譲するフラグ。ユーザーが指定した summary の更新は無効になりません。
float
wandb-core の内部サービスの起動を待機する時間 (秒) 。
bool
run イベントをトランザクションログに保存しないかどうか。これはオンライン run にのみ該当します。ディスクに書き込まれる データ量を削減するために使用できます。復旧可能性に関する保証が失われるため、 注意して使用してください。
float
システムモニターのサンプリング間隔 (秒) 。
dict[str, str] | None
システムメトリクス用にモニターする OpenMetrics /metrics エンドポイント。
dict[str, dict[str, str]] | collections.abc.Sequence[str] | None
OpenMetrics /metrics エンドポイントから収集したメトリクスに適用するフィルター。次の 2 つの形式をサポートします。
  • {"metric regex pattern, including endpoint name as prefix": {"label": "label value regex pattern"}}
  • ("metric regex pattern 1", "metric regex pattern 2", ...)
dict[str, str] | None
OpenMetrics リクエストに追加する HTTP ヘッダー。
collections.abc.Sequence[str] | None
ディスク使用量をモニターするシステムパス。
int | None
システム CPU 数。設定した場合、run メタデータ内の自動検出された値を上書きします。
int | None
論理 CPU 数。設定した場合、run メタデータ内の自動検出された値を上書きします。
int | None
GPU デバイス数。設定した場合、run メタデータ内の自動検出された値を上書きします。
str | None
GPU デバイスタイプ。設定した場合、run メタデータ内の自動検出された値を上書きします。
collections.abc.Sequence[int] | None
モニターする GPU デバイスのインデックス。設定されていない場合、システムモニターはすべての GPU のメトリクスを取得します。 CUDA/ROCm のデバイス列挙に対応する 0 始まりのインデックスを前提とします。
bool
x_stats_pid を起点に、プロセスツリー全体のリソース使用量をモニターします。True の場合、システムモニターは、PID x_stats_pid を持つプロセスとそのすべての子孫プロセスの RSS、CPU%、スレッド数を集計します。 パフォーマンスのオーバーヘッドが発生する可能性があるため、デフォルトで無効です。
bool
システムメトリクスの割合に対する cgroup v2 の CPU およびメモリ制限を無効にします。
str
run のディレクトリ名 (sync_dir) に追加する接尾辞です。名前の競合を回避するために wandb.init() で設定します。 設定した場合、ダッシュでデフォルト名に連結されます。
bool
このプロセスがサーバー上の run の最終状態を更新できるかどうかを示すフラグです。メインプロセスのみが最終状態を決定する必要がある分散トレーニングでは、False に設定します。

プロパティ

str
W&B UI の URL。通常は https://wandb.ai です。W&B API にプログラムでアクセスするために使用する base_url (例: https://api.wandb.ai) とは異なります。
str | None
Colab で実行している場合の Colab ノートブックの URL。
Literal['local', 'cloud']
説明はありません。
str
run の file が保存されているローカルディレクトリの絶対パス。
bool
説明はありません。
str
ログ file を保存するディレクトリ。
str
内部ログに使用する file のパス。
最新の run の内部ログ file へのシンボリックリンクのパス。
最新の run のユーザープロセスログ file へのシンボリックリンクのパス。
str
ユーザープロセスログに使用する file のパス。
str
project を表示できる W&B URL。
str
再開用 file のパス。
Literal['run', 'offline-run']
run のモード。“run” または “offline-run” のいずれかです。
str
run を表示できる W&B URL。
str
Workspace settings file のパス。
str
sweep を表示できる W&B URL。
str
run の file を保存するディレクトリ。
str
追記専用のバイナリトランザクションログ file のパス。
最新の run のトランザクションログ file へのシンボリックリンクのパス。
str
run の時刻指定。
str
wandb ディレクトリの完全パス。

メソッド

method Settings.validate_anonymous()

引数
object
説明は提供されていません。

method Settings.validate_x_extra_http_headers()

引数
_empty
説明はありません。

method Settings.validate_x_stats_coreweave_metadata_base_url()

引数
_empty
説明はありません。