クラス wandb.Settings
W&B SDK の設定。 このクラスは W&B SDK の設定を管理し、すべての設定の型安全性と検証を保証します。設定は属性としてアクセス可能で、プログラムから、環境変数 (WANDB_ prefix) および設定ファイルを通じて初期化できます。
設定は 3 つのカテゴリに分類されます。
- Public settings: ユーザーが安全に変更して、特定のニーズに合わせて W&B の動作をカスタマイズできるコア設定オプション。
- Internal settings: 低レベルの SDK 動作を扱う「x_」接頭辞付きの設定。これらの設定は主に内部使用およびデバッグ用です。変更は可能ですが、Public API の一部とは見なされず、今後のバージョンで予告なく変更される可能性があります。
- Computed settings: 他の設定または環境から自動的に導出される読み取り専用設定。
- この
Settingsモデルで定義されたデフォルト値。 - 設定ファイル (
~/.config/wandb/settings、またはWANDB_CONFIG_DIR環境変数で指定されたディレクトリ内のsettingsファイル) 。 - 環境変数 (
WANDB_接頭辞付きのもの。例:WANDB_MODE) 。 - ホスト名、実行中のプログラム/スクリプトのパス、Python 実行ファイル、Docker イメージ、Jupyter ノートブックの詳細など、ランタイム環境から検出された値。
- Amazon SageMaker 環境で実行している場合の SageMaker 設定。
wandb.setup()のsettingsパラメーター。wandb.init()のsettingsパラメーター。- 一部の
wandb.init()パラメーター (例:mode=はmode設定を上書きします) 。
引数
bool
メディアファイルを 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_url は通常 base_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 の書き込みメソッドを上書きします。システムの状態に 基づいて “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_multipart が True の場合にのみ有効です。
console_chunk_max_seconds と組み合わせることができ、先に達した制限によって
ロールオーバーが実行されます。値を 0 にすると、
サイズに基づく制限が無効になります。int
マルチパートのコンソールログの、時間に基づくロールオーバーのしきい値です。単位は秒です。現在のパートの開始から指定した秒数が経過すると、
新しいコンソールログファイルを開始します。
console_multipart が
True である必要があります。 console_chunk_max_bytes と併用でき、先に制限に
達するとパートが閉じられます。値を 0 にすると、時間に基づく
制限が無効になります。dict[str, str] | None
Python ロガーの名前で、run の Logs タブに取得するもの。ロガー名から最小ログレベルへのマッピング。設定すると、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 entity。
str | None
W&B 組織。
bool
force フラグを wandb.login() に渡すかどうか。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
files_dir からの相対的な Unix glob パターンで、アップロードから除外するファイルを指定します。float
wandb.init 呼び出しがタイムアウトするまでに完了するのを待つ時間 (秒)。float
run の終了時にデータをアップロードするまで待機する時間 (秒単位) 。これを設定すると、run の終了時に W&B へのアップロードが遅いことによるコストを制限できますが、run がクラッシュしたとマークされ、一部のデータが欠落する可能性があります。デフォルトでは、
run.finish() はすべてのデータのアップロードが完了するまでブロックします。これを 0 より大きい数値に設定すると、W&B は run の終了時にこの秒数経過後に run のデータのアップロードを諦め、スクリプトのブロックを解除します。しばらくすると、run は UI 上で Crashed または Failed になります。アップロードされなかったデータはディスク上に保存されたままなので、wandb sync でアップロードできます。finish_timeout_raises 設定を使用すると、警告メッセージの表示に加えてエラーを送出できます。wandb.teardown() (スクリプトの終了時に atexit フックで自動的に実行される) によってシャットダウンされる run もこの設定を尊重します。bool
finish_timeout が期限切れになった場合に TimeoutError を送出するかどうか。これを
finish_timeout 設定と併用すると、run.finish() はタイムアウト後にメッセージを表示するだけでなく TimeoutError を送出します。run.finish() は Run をコンテキストマネージャーとして使用する際に暗黙的に呼び出される点に注意してください。with wandb.init() as run:
… # run.finish() は with ブロックの終了時に実行されますこれは wandb.teardown() がエラーを送出する原因にはなりません (スクリプトの終了時に実行されるため) 。bool
SSL 検証を安全ではない方法で無効にするかどうか。
str | None
スクリプトを実行している Launch job の名。
Optional
Launch のソースタイプ。
bool
自動ラベル付け機能を無効にするかどうか。
str | None
Launch 設定ファイルへのパス。
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”: すべての実行中の run を終了してから新しい run を返します。
- “create_new”: 他の実行中の run を変更せずに新しい run を作成します。
wandb.runやwandb.logなどのトップレベル関数は更新されません。そのため、グローバル run に依存する古いインテグレーションの一部は動作しません。
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
関連する run のグループ識別子です。UI で run をグループ化するために使用します。
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 を送信します。
別のシグナルを使用したい場合や、中断前に別の action を実行したい場合など、
この動作を上書きするには、このコールバックを設定します。コールバックは別のスレッドで実行されます。停止がリクエストされてから
間もなく実行されますが、即座には実行されません。
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 のパラメーター設定へのパスです。
bool
シンボリックリンクを使用するかどうかを指定します (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
履歴からサマリーを自動計算する処理をサーバーに委譲するフラグ。ユーザーによるサマリーの更新は無効になりません。
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 です。これは
base_url (https://api.wandb.ai など) とは異なり、W&B API にプログラムでアクセスするために使用されます。str | None
Colab で実行している場合、Colab ノートブックの URL です。
Literal['local', 'cloud']
説明は提供されていません。
str
run のファイルが保存されるローカルディレクトリの絶対パスです。
bool
説明は提供されていません。
str
ログファイルを保存するディレクトリです。
str
内部ログに使用するファイルへのパスです。
str
最新の run の内部ログファイルへのシンボリックリンクへのパスです。
str
最新の run のユーザープロセスログファイルへのシンボリックリンクへのパスです。
str
ユーザープロセスログに使用するファイルへのパスです。
str
project を表示できる W&B の URL です。
str
再開ファイルへのパスです。
Literal['run', 'offline-run']
run のモードです。“run” または “offline-run” のいずれかです。
str
run を表示できる W&B の URL です。
str
ワークスペース設定ファイルへのパスです。
str
sweep を表示できる W&B の URL です。
str
run のファイルを保存するディレクトリです。
str
追記専用のバイナリトランザクションログファイルへのパスです。
str
最新の run のトランザクションログファイルへのシンボリックリンクへのパスです。
str
run の時間指定です。
str
wandb ディレクトリへのフルパスです。
メソッド
メソッド Settings.validate_anonymous()
object
説明はありません。
メソッド Settings.validate_x_extra_http_headers()
_empty
説明はありません。
メソッド Settings.validate_x_stats_coreweave_metadata_base_url()
_empty
説明はありません。