Settings - Weights & Biases Documentation

`class` `Settings`

W&B SDK の Settings クラスです。このクラスは W&B SDK の設定を管理し、すべての設定でタイプ安全性と検証が確保されるようにします。Settings には属性としてアクセスでき、プログラムから、環境変数 (WANDB_ プレフィックス) 、および設定ファイルを通じて初期化できます。設定は次の 3 つのカテゴリに分類されます。

Public settings: ユーザーが安全に変更でき、特定のニーズに合わせて W&B の動作をカスタマイズするための中核的な設定オプションです。
Internal settings: ‘x_’ で始まる Settings で、SDK の低レベルな動作を扱います。これらの設定は主に内部利用とデバッグ用です。変更は可能ですが、 Public API の一部とは見なされず、将来のバージョンで予告なく変更される場合があります。
Computed settings: 他の設定または環境から自動的に導出される読み取り専用の Settings です。

`method` `Settings.init`

__init__(
    allow_media_symlink: 'bool' = False,
    allow_offline_artifacts: 'bool' = True,
    allow_val_change: 'bool' = False,
    anonymous: 'object' = <object object at 0x109b16dd0>,
    api_key: 'str | None' = None,
    azure_account_url_to_access_key: 'dict[str, str] | None' = None,
    app_url_override: 'str | None' = None,
    base_url: 'str' = 'https://api.wandb.ai',
    code_dir: 'str | None' = None,
    config_paths: 'collections.abc.Sequence[str] | None' = None,
    console: 'Literal['auto', 'off', 'wrap', 'redirect', 'wrap_raw', 'wrap_emu']' = 'auto',
    console_multipart: 'bool' = False,
    console_chunk_max_bytes: 'int' = 0,
    console_chunk_max_seconds: 'int' = 0,
    capture_loggers: 'dict[str, str] | None' = None,
    credentials_file: 'str' = None,
    disable_code: 'bool' = False,
    disable_git: 'bool' = False,
    disable_git_fork_point: 'bool' = True,
    disable_job_creation: 'bool' = True,
    docker: 'str | None' = None,
    email: 'str | None' = None,
    entity: 'str | None' = None,
    organization: 'str | None' = None,
    force: 'bool' = False,
    fork_from: 'wandb.sdk.lib.run_moment.RunMoment | None' = None,
    git_commit: 'str | None' = None,
    git_remote: 'str' = 'origin',
    git_remote_url: 'str | None' = None,
    git_root: 'str | None' = None,
    heartbeat_seconds: 'int' = 30,
    host: 'str | None' = None,
    http_proxy: 'str | None' = None,
    https_proxy: 'str | None' = None,
    identity_token_file: 'str | None' = None,
    ignore_globs: 'Sequence' = (),
    init_timeout: 'float' = 90.0,
    finish_timeout: 'float' = 0.0,
    finish_timeout_raises: 'bool' = False,
    insecure_disable_ssl: 'bool' = False,
    job_name: 'str | None' = None,
    job_source: 'Literal['repo', 'artifact', 'image'] | None' = None,
    label_disable: 'bool' = False,
    launch: 'bool' = False,
    launch_config_path: 'str | None' = None,
    login_timeout: 'float | None' = None,
    mode: 'Literal['online', 'offline', 'shared', 'disabled', 'dryrun', 'run']' = 'online',
    notebook_name: 'str | None' = None,
    program: 'str | None' = None,
    program_abspath: 'str | None' = None,
    program_relpath: 'str | None' = None,
    project: 'str | None' = None,
    quiet: 'bool' = False,
    reinit: 'Literal['default', 'return_previous', 'finish_previous', 'create_new'] | bool' = 'default',
    relogin: 'bool' = False,
    resume: 'Literal['allow', 'must', 'never', 'auto'] | None' = None,
    resume_from: 'wandb.sdk.lib.run_moment.RunMoment | None' = None,
    resumed: 'bool' = False,
    root_dir: 'str' = None,
    run_group: 'str | None' = None,
    run_id: 'str | None' = None,
    run_job_type: 'str | None' = None,
    run_name: 'str | None' = None,
    run_notes: 'str | None' = None,
    run_tags: 'tuple[str, ...] | None' = None,
    sagemaker_disable: 'bool' = False,
    save_code: 'bool | None' = None,
    settings_system: 'str | None' = None,
    stop_fn: 'collections.abc.Callable[[], None] | None' = None,
    max_end_of_run_history_metrics: 'int' = 10,
    max_end_of_run_summary_metrics: 'int' = 10,
    show_colors: 'bool | None' = None,
    show_emoji: 'bool | None' = None,
    show_errors: 'bool' = True,
    show_info: 'bool' = True,
    show_warnings: 'bool' = True,
    silent: 'bool' = False,
    start_method: 'str | None' = None,
    stop_on_fatal_error: 'bool' = False,
    strict: 'bool | None' = None,
    summary_timeout: 'int' = 60,
    summary_warnings: 'int' = 5,
    sweep_id: 'str | None' = None,
    sweep_param_path: 'str | None' = None,
    symlink: 'bool' = None,
    sync_tensorboard: 'bool | None' = None,
    table_raise_on_max_row_limit_exceeded: 'bool' = False,
    use_dot_wandb: 'bool | None' = None,
    username: 'str | None' = None,
    x_cli_only_mode: 'bool' = False,
    x_disable_meta: 'bool' = False,
    x_disable_stats: 'bool' = False,
    x_disable_viewer: 'bool' = False,
    x_disable_machine_info: 'bool' = False,
    x_executable: 'str | None' = None,
    x_extra_http_headers: 'dict[str, str] | None' = None,
    x_file_stream_max_bytes: 'int | None' = None,
    x_file_stream_max_line_bytes: 'int | None' = None,
    x_file_stream_transmit_interval: 'float | None' = None,
    x_file_stream_retry_max: 'int | None' = None,
    x_file_stream_retry_wait_min_seconds: 'float | None' = None,
    x_file_stream_retry_wait_max_seconds: 'float | None' = None,
    x_file_stream_timeout_seconds: 'float | None' = None,
    x_file_transfer_retry_max: 'int | None' = None,
    x_file_transfer_retry_wait_min_seconds: 'float | None' = None,
    x_file_transfer_retry_wait_max_seconds: 'float | None' = None,
    x_file_transfer_timeout_seconds: 'float | None' = None,
    x_files_dir: 'str | None' = None,
    x_flow_control_custom: 'bool | None' = None,
    x_flow_control_disabled: 'bool | None' = None,
    x_graphql_retry_max: 'int | None' = None,
    x_graphql_retry_wait_min_seconds: 'float | None' = None,
    x_graphql_retry_wait_max_seconds: 'float | None' = None,
    x_graphql_timeout_seconds: 'float | None' = None,
    x_internal_check_process: 'float' = 8.0,
    x_jupyter_name: 'str | None' = None,
    x_jupyter_path: 'str | None' = None,
    x_jupyter_root: 'str | None' = None,
    x_label: 'str | None' = None,
    x_live_policy_rate_limit: 'int | None' = None,
    x_live_policy_wait_time: 'int | None' = None,
    x_log_level: 'int' = 20,
    x_network_buffer: 'int | None' = None,
    x_primary: 'bool' = True,
    x_proxies: 'dict[str, str] | None' = None,
    x_runqueue_item_id: 'str | None' = None,
    x_save_requirements: 'bool' = True,
    x_server_side_derived_summary: 'bool' = False,
    x_server_side_expand_glob_metrics: 'bool' = True,
    x_service_transport: 'str | None' = None,
    x_service_wait: 'float' = 30.0,
    x_skip_transaction_log: 'bool' = False,
    x_start_time: 'float | None' = None,
    x_stats_pid: 'int' = 28097,
    x_stats_sampling_interval: 'float' = 15.0,
    x_stats_neuron_monitor_config_path: 'str | None' = None,
    x_stats_dcgm_exporter: 'str | None' = None,
    x_stats_open_metrics_endpoints: 'dict[str, str] | None' = None,
    x_stats_open_metrics_filters: 'dict[str, dict[str, str]] | collections.abc.Sequence[str] | None' = None,
    x_stats_open_metrics_http_headers: 'dict[str, str] | None' = None,
    x_stats_disk_paths: 'collections.abc.Sequence[str] | None' = ('/',),
    x_stats_cpu_count: 'int | None' = None,
    x_stats_cpu_logical_count: 'int | None' = None,
    x_stats_gpu_count: 'int | None' = None,
    x_stats_gpu_type: 'str | None' = None,
    x_stats_gpu_device_ids: 'collections.abc.Sequence[int] | None' = None,
    x_stats_buffer_size: 'int' = 0,
    x_stats_coreweave_metadata_base_url: 'str' = 'http://169.254.169.254',
    x_stats_coreweave_metadata_endpoint: 'str' = '/api/v2/cloud-init/meta-data',
    x_stats_track_process_tree: 'bool' = False,
    x_stats_no_cgroup: 'bool' = False,
    x_sync: 'bool' = False,
    x_sync_dir_suffix: 'str' = '',
    x_update_finish_state: 'bool' = True
) → None

引数:

allow_media_symlink (bool): メディアファイルを run ディレクトリにシンボリックリンクするかどうか。 True の場合、メディアファイルはコピーされる代わりに run ディレクトリにシンボリックリンクまたはハードリンクされます。これにより、ログがより高速になり、ディスク使用量を削減できる場合があります。ただし、 W&B サーバーにアップロードする前に元のファイルを削除または変更すると、その内容がアップロードされたデータに反映されます。
allow_offline_artifacts (bool): オフラインモードで表アーティファクトを同期できるようにするフラグです。以前の動作に戻すには、False に設定します。
allow_val_change (bool): 設定後に Config の値の変更を許可するフラグです。
anonymous (object): 非推奨で、今後削除される予定です。
api_key (str | None): W&B の APIキー。
azure_account_url_to_access_key (dict[str, str] | None): Azure インテグレーション用の、Azure アカウント URL とそれに対応するアクセスキーのマッピング。
app_url_override (str | None): W&B UI の ‘app’ URL を上書きするための値です。 app_url は通常 base_url に基づいて計算されますが、これを使用して明示的に設定することもできます。 WANDB_APP_URL は対応する環境変数です。
base_url (str): データを同期するための W&B バックエンドの URL です。
code_dir (str | None): W&Bでトラッキングするコードを含むディレクトリ。
config_paths (collections.abc.Sequence[str] | None): Config オブジェクトに読み込む設定ファイルのパス。
console (Literal[‘auto’, ‘off’, ‘wrap’, ‘redirect’, ‘wrap_raw’, ‘wrap_emu’]): 適用するコンソールの取得タイプです。指定可能な値は次のとおりです:
- “auto” - システム環境と設定に基づいて、コンソール出力の取得方法を自動的に選択します。
- “off” - コンソール出力の取得を無効にします。
- “redirect” - 出力を取得するために、低レベルのファイルディスクリプターをリダイレクトします。
- “wrap” - sys.stdout/sys.stderr の write メソッドをオーバーライドします。システムの状態に応じて、“wrap_raw” または “wrap_emu” のいずれかにマッピングされます。
- “wrap_raw” - “wrap” と同じですが、エミュレーターを介さずに生の出力を直接取得します。wrap 設定から派生するため、手動で設定しないでください。
- “wrap_emu” - “wrap” と同じですが、エミュレーターを介して出力を取得します。 wrap 設定から派生するため、手動で設定しないでください。
console_multipart (bool): マルチパートのコンソールログを有効にします。 When True, the SDK writes console output to timestamped files under the logs/ directory instead of a single output.log. Each part is uploaded as soon as it is closed, giving users live access to logs while the run is active. Rollover cadence is controlled by console_chunk_max_bytes and/or console_chunk_max_seconds. If both limits are 0, all logs are uploaded once at run finish. Note: Uploaded chunks are immutable; terminal control sequences that modify previous lines (e.g., progress bars using carriage returns) only affect the current chunk.
console_chunk_max_bytes (int): マルチパートのコンソールログにおける、バイト単位のサイズベースのロールオーバーしきい値です。現在のパートがこのサイズに達すると、新しいコンソールログファイルを開始します。console_multipart が True の場合にのみ有効です。 console_chunk_max_seconds と組み合わせることができ、どちらかの制限に先に達するとロールオーバーがトリガーされます。値を 0 にすると、サイズベースの制限は無効になります。
console_chunk_max_seconds (int): マルチパートのコンソールログに対する、秒単位の時間ベースのロールオーバーしきい値です。現在のパートの開始からこの秒数が経過すると、新しいコンソールログファイルを開始します。console_multipart は True である必要があります。console_chunk_max_bytes と併用でき、先に達したほうの制限でパートが閉じられます。値を 0 にすると、時間ベースの制限は無効になります。
capture_loggers (dict[str, str] | None): run の Logs タブに取得する Python logger の名。 logger 名から最小ログレベルへのマッピングです。設定すると、wandb は指定した各 logger に logging.Handler をインストールし、run の終了時に削除します。それらの logger から出力されたログレコードは、 stdout/stderr の取得と同様に、run のコンソール出力として公開されます。ログレコードは logging.basicConfig() と同じ形式で整形されます。たとえば、 INFO:my_module:Some message. のようになります。現時点ではこの形式はカスタマイズできません。すべてのログを取得するには、ルート logger の名である ‘root’ を渡します。これは console 設定とは独立しており、両方を同時に有効にできます。例:
```
wandb.init(
settings=wandb.Settings(
console="off",
capture_loggers={
"my_app": "INFO",
"my_app.training": "ERROR",
},
),
)
```
credentials_file (str): 一時的なアクセストークンを書き込むファイルのパスです。
disable_code (bool): コードの取得を無効にするかどうか。
disable_git (bool): Git の状態の取得を無効にするかどうか。
disable_git_fork_point (bool): リモートブランチから fork point を推定する処理を無効にするかどうか。 True に設定すると、設定されている場合、SDK は upstream ブランチの最新コミットを使用します。設定されていない場合は、diff パッチの生成をスキップします。 False に設定すると、SDK は、設定されている場合は upstream ブランチの最新コミットの使用を試みます。設定されていない場合は、すべてのリモートブランチから最も近いコミットを検索します。これは、upstream ブランチが多数あるリポジトリではパフォーマンスに影響する可能性があります。
disable_job_creation (bool): W&B Launch のジョブ artifact の作成を無効にするかどうか。
docker (str | None): スクリプトの実行に使用する Docker image。
email (str | None): ユーザーのメールアドレス。
entity (str | None): ユーザーまたはチームなどの W&B の entity。
organization (str | None): W&B の組織。
force (bool): wandb.login() に force フラグを渡すかどうかを指定します。
fork_from (wandb.sdk.lib.run_moment.RunMoment | None): 以前の run の実行において、フォーク元となる時点を指定します。その時点は、run ID、メトリクス、およびその値で定義されます。現在サポートされているメトリクスは ‘_step’ のみです。
git_commit (str | None): run に関連付ける Git コミットハッシュです。
git_remote (str): run に関連付ける Git リモートです。
git_remote_url (str | None): git のリモートリポジトリの URL。
git_root (str | None): Git リポジトリのルートディレクトリです。
host (str | None): スクリプトを実行しているマシンのホスト名です。
http_proxy (str | None): W&B への HTTP リクエストに使用するカスタムプロキシサーバー。
https_proxy (str | None): W&B への HTTPS リクエストに使用するカスタムプロキシサーバー。
identity_token_file (str | None): 認証用のアイデンティティトークン (JWT) が格納されたファイルへのパス。
ignore_globs (Sequence): アップロードから除外するファイルを指定する、files_dir からの相対パスの Unix glob パターン。
init_timeout (float): wandb.init の呼び出しが完了するまで待機する時間 (秒) 。この時間を超えるとタイムアウトします。
finish_timeout (float): run の終了時に、データのアップロードを待機する時間 (秒) です。これを設定すると、run の終了時に W&B へのアップロードが遅いことで発生するコストを抑えられますが、その代わりに run は crashed としてマークされ、一部のデータが欠落する可能性があります。デフォルトでは、run.finish() はすべてのデータのアップロードが完了するまでブロックします。これが 0 より大きい数値に設定されている場合、W&B は run の終了時にこの秒数が経過すると run のデータのアップロードをあきらめ、スクリプトの実行を再開します。しばらくすると、run は UI で Crashed または Failed になります。未アップロードのデータは引き続きディスクに保存され、wandb sync でアップロードできます。警告メッセージの表示に加えてエラーを送出するには、 finish_timeout_raises 設定を使用します。 wandb.teardown() によってシャットダウンされる Runs (atexit フックでスクリプトの終了時に自動的に実行されます) も、この設定に従います。
finish_timeout_raises (bool): finish_timeout が期限切れになった場合に TimeoutError を送出するかどうか。これを finish_timeout 設定と併用すると、run.finish() はメッセージを出力するだけでなく、タイムアウト時に TimeoutError も送出します。 Run をコンテキストマネージャーとして使用する場合、run.finish() は暗黙的に呼び出される点に注意してください: with wandb.init() as run: … # with ブロックの শেষে run.finish() が実行されますただし、これによって wandb.teardown() がエラーを送出することはありません (いずれにしてもスクリプトの最後で実行されるためです)。
insecure_disable_ssl (bool): 安全でない方法で SSL 検証を無効にするかどうか。
job_name (str | None): スクリプトを実行中のLaunchジョブの名。
job_source (Optional[Literal[‘repo’, ‘artifact’, ‘image’]]): Launch のソースのタイプ。
label_disable (bool): 自動ラベリング機能を無効にするかどうかを指定します。
launch_config_path (str | None): Launch 設定ファイルのパス。
login_timeout (float | None): ログイン処理がタイムアウトするまで待機する時間 (秒)。
mode (Literal[‘online’, ‘offline’, ‘shared’, ‘disabled’, ‘dryrun’, ‘run’]): W&B のログ記録と同期を行う際の動作モードです。
notebook_name (str | None): Jupyterのような環境で実行する場合のノートブック名。
program (str | None): 利用可能な場合、run を作成したスクリプトのパス。
program_abspath (str | None): run を作成したスクリプトへの、リポジトリのルートディレクトリからの絶対パスです。リポジトリのルートディレクトリは、.git ディレクトリが存在する場合はそれを含むディレクトリとして定義されます。存在しない場合は、現在の作業ディレクトリです。
program_relpath (str | None): run を作成したスクリプトの相対パスです。
project (str | None): W&B の project ID。
quiet (bool): 必要のない出力を抑制するフラグです。
reinit (Union[Literal[‘default’, ‘return_previous’, ‘finish_previous’, ‘create_new’], bool]): 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 に依存する一部の古いインテグレーションは動作しません。ブール値を指定することもできますが、これは非推奨です。False は “return_previous” と同じで、True は “finish_previous” と同じです。
relogin (bool): 再度ログインを試行するよう強制するフラグです。
resume (Optional[Literal[‘allow’, ‘must’, ‘never’, ‘auto’]]): run の再開動作を指定します。オプション:
- “must”: 同じ ID の既存の run から再開します。該当する run が存在しない場合は、失敗します。
- “allow”: 同じ ID の既存の run からの再開を試みます。見つからない場合は、新しい run が作成されます。
- “never”: 常に新しい run を開始します。同じ ID の run がすでに存在する場合は、失敗します。
- “auto”: 同じマシン上で直近に失敗した run から自動的に再開します。
resume_from (wandb.sdk.lib.run_moment.RunMoment | None): 以前の run の実行において、再開元となる時点を指定します。この時点は、run ID、メトリクス、およびその値で定義されます。現在サポートされているメトリクスは ‘_step’ のみです。
root_dir (str): すべてのrun関連パスの基準となるルートディレクトリです。特に、wandbディレクトリとrunディレクトリはこの値に基づいて決定されます。
run_group (str | None): 関連する run のグループ識別子。 UI で run をグループ化する際に使用します。
run_id (str | None): run の ID です。
run_job_type (str | None): 実行中のジョブのタイプ (例: トレーニング、評価) 。
run_name (str | None): runの人間が読みやすい名前。
run_notes (str | None): run に関する追加のメモまたは説明。
run_tags (tuple[str, …] | None): 組織化やフィルタリングのために run に関連付ける Tags。
sagemaker_disable (bool): SageMaker 固有の機能を無効にするフラグ。
save_code (bool | None): run に関連付けられたコードを保存するかどうか。
settings_system (str | None): システム全体で使用する設定ファイルのパス。
stop_fn (collections.abc.Callable[[], None] | None): run を停止するために実行されるコールバックです。 run は Web UI から、または致命的なエラーの発生後に (設定で有効になっている場合) 停止できます。デフォルトでは、run を停止するために、W&B はメインスレッドに SIGINT を送信します。このコールバックを設定すると、この動作をオーバーライドできます。たとえば、別のシグナルを使用したり、中断する前に別のアクションを実行したりできます。このコールバックは別スレッドで実行されます。停止が要求された後まもなく実行されますが、即座ではありません。
max_end_of_run_history_metrics (int): run の終了時に表示する履歴スパークラインの最大数。
max_end_of_run_summary_metrics (int): run終了時に表示されるsummaryメトリクスの最大数。
show_errors (bool): エラーメッセージを表示するかどうか。
show_info (bool): 情報メッセージを表示するかどうかを指定します。
show_warnings (bool): 警告メッセージを表示するかどうかを指定します。
silent (bool): すべての出力を抑制するフラグです。
stop_on_fatal_error (bool): 致命的なエラーが発生した後に run を停止するかどうか。 W&B がデータのアップロード中に回復不能なエラーに遭遇すると、メッセージを表示してアップロードを停止しますが、その後も追加のデータをログできます。通常、これは望ましい動作です。トレーニングメトリクスはディスクに保存されるため、アップロードされなかった場合でも wandb sync を使用して復旧できます。ただし、トレーニング後にファイルが削除される場合、これは有用ではありません。その場合、この値を True に設定すると、Web UI で停止ボタンが押されたときと同様に、致命的なエラーの発生後に run を停止します。
strict (bool | None): 検証とエラーチェックに対して厳格モードを有効にするかどうか。
summary_timeout (int): summary の処理がタイムアウトするまで待機する秒数。
sweep_id (str | None): この run が属する sweep の ID。
sweep_param_path (str | None): sweep パラメーターの設定へのパス。
symlink (bool): シンボリックリンクを使用するかどうか (Windows を除き、デフォルトは True) 。
sync_tensorboard (bool | None): TensorBoard のログを W&B に同期するかどうか。
table_raise_on_max_row_limit_exceeded (bool): 表の行数制限を超えた場合に例外を送出するかどうか。
use_dot_wandb (bool | None): run データに対して、非表示の.wandbディレクトリと表示されるwandbディレクトリのどちらを使用するかを指定します。 True の場合、SDK は .wandb を使用します。False の場合は wandb を使用します。設定しない場合は、すでに存在していれば .wandb、そうでなければ wandb がデフォルトで使用されます。
username (str | None): ユーザー名。
x_disable_meta (bool): システムメタデータのコレクションを無効にするフラグです。
x_disable_stats (bool): システムメトリクスの収集を無効にするフラグです。
x_extra_http_headers (dict[str, str] | None): すべての送信 HTTP リクエストに追加するヘッダーです。
x_label (str | None): run に対して収集されるシステムメトリクスおよびコンソールログに割り当てるラベルです。フロントエンドでデータをグループ化するために使用され、分散トレーニングジョブ内の異なるプロセスからのデータを区別するのにも使用できます。
x_primary (bool): 内部 wandb ファイルとメタデータを保存するかどうかを指定します。分散環境では、システムメトリクスとログのみが必要な場合、プライマリプロセスが主要なログ出力を担うため、セカンダリプロセスによるファイルの上書きを回避するのに役立ちます。
x_save_requirements (bool): requirements ファイルを保存するためのフラグです。
x_server_side_derived_summary (bool): history から summary を自動計算する処理をサーバー側に委譲するためのフラグです。この設定を有効にしても、ユーザーによる summary の更新は無効になりません。
x_service_wait (float): wandb-core の内部サービスの起動を待機する時間 (秒) 。
x_skip_transaction_log (bool): run イベントをトランザクションログに保存しないようにするかどうか。これは online run でのみ有効です。ディスクに書き込まれるデータ量を減らすために使用できます。ただし、復旧可能性に関する保証が失われるため、注意して使用してください。
x_stats_sampling_interval (float): システムモニターのサンプリング間隔 (秒単位) 。
x_stats_dcgm_exporter (str | None): Nvidia DCGM メトリクスの取得元となるエンドポイント。オプション:
- Prometheus の /api/v1/query エンドポイントへのクエリから、DCGM 関連のメトリクスを抽出します。 Prometheus を使用して、クラスター内の異なるノードで実行されている DCGM Exporter インスタンスから報告されるメトリクスを集約するのは一般的です。
- TODO: DCGM Exporter の /metrics エンドポイントからメトリクスを直接パースします。例:
- http://localhost:9400/api/v1/query?query=DCGM_FI_DEV_GPU_TEMP{node="l1337", cluster="globular"}.
x_stats_open_metrics_endpoints (dict[str, str] | None): システムメトリクスを監視するための OpenMetrics /metrics エンドポイント。
x_stats_open_metrics_filters (dict[str, dict[str, str]] | collections.abc.Sequence[str] | None): OpenMetrics の /metrics エンドポイントから収集されるメトリクスに適用するフィルターです。次の 2 つの形式をサポートします:
- {"エンドポイント名を接頭辞として含むメトリクスの正規表現パターン": {"label": "ラベル値の正規表現パターン"}}
- ("メトリクスの正規表現パターン 1", "メトリクスの正規表現パターン 2", ...)
x_stats_open_metrics_http_headers (dict[str, str] | None): OpenMetrics へのリクエストに追加する HTTP ヘッダー。
x_stats_disk_paths (collections.abc.Sequence[str] | None): ディスク使用量を監視する対象のシステムパス。
x_stats_cpu_count (int | None): システムの CPU 数。設定すると、run メタデータで自動検出された値を上書きします。
x_stats_cpu_logical_count (int | None): 論理 CPU 数。設定すると、run メタデータで自動検出された値を上書きします。
x_stats_gpu_count (int | None): GPU デバイス数。設定すると、run メタデータ内で自動検出された値を上書きします。
x_stats_gpu_type (str | None): GPU デバイスのタイプ。 If set, overrides the auto-detected value in the run metadata.
x_stats_gpu_device_ids (collections.abc.Sequence[int] | None): 監視する GPU デバイスのインデックスです。設定しない場合、システムモニターはすべての GPU のメトリクスを取得します。 CUDA/ROCm のデバイス列挙に対応する 0 始まりのインデックスであることを前提とします。
x_stats_track_process_tree (bool): x_stats_pid を起点として、プロセスツリー全体のリソース使用状況を監視します。 True の場合、システムモニターは PID x_stats_pid のプロセスとそのすべての子孫プロセスの RSS、CPU%、およびスレッド数を集計します。これはパフォーマンスのオーバーヘッドを伴う可能性があり、デフォルトで無効です。
x_stats_no_cgroup (bool): システムメトリクスの割合の計算において、cgroup v2 の CPU およびメモリの制限を無効にします。
x_sync_dir_suffix (str): run のディレクトリ名 (sync_dir) に追加するサフィックスです。これは、名前の競合を避けるために wandb.init() で設定します。設定すると、デフォルト名にダッシュ区切りで連結されます。
x_update_finish_state (bool): このプロセスがサーバー上で run の最終状態を更新できるかどうかを示すフラグです。分散トレーニングで、最終状態を決定するのがメインプロセスのみである必要がある場合は、False に設定します。

戻り値: Settings オブジェクト。

`プロパティ` `Settings.app_url`

W&B UI の URL です。通常は https://wandb.ai です。これは、プログラムから W&B API にアクセスするために使用する base_url (https://api.wandb.ai など) とは異なります。 戻り値:

str: app_url プロパティの値。

`プロパティ` `Settings.colab_url`

Colab で実行している場合の Colab ノートブックの URL です。 戻り値:

str | None: colab_url プロパティの値。

`プロパティ` `Settings.deployment`

`プロパティ` `Settings.files_dir`

run のファイルが保存されているローカルディレクトリの絶対パスです。 戻り値:

str: files_dir プロパティの値。

`プロパティ` `Settings.is_local`

`プロパティ` `Settings.log_dir`

ログファイルを保存するディレクトリです。 戻り値:

str: log_dir プロパティの値。

`プロパティ` `Settings.log_internal`

内部ログ用のファイルのパスです。 戻り値:

str: log_internal プロパティの値です。

`プロパティ` `Settings.log_symlink_internal`

最新の run の内部ログファイルへのシンボリックリンクのパスです。 戻り値:

str: log_symlink_internal プロパティの値です。

`プロパティ` `Settings.log_symlink_user`

最新の run におけるユーザープロセスのログファイルへのシンボリックリンクのパスです。 戻り値:

str: log_symlink_user プロパティの値です。

`プロパティ` `Settings.log_user`

ユーザープロセスのログを出力するファイルのパスです。 戻り値:

str: log_user プロパティの値。

`プロパティ` `Settings.project_url`

project を表示できる W&B の URL です。 戻り値:

str: project_url プロパティの値です。

`プロパティ` `Settings.resume_fname`

resume ファイルのパスです。 戻り値:

str: resume_fname プロパティの値です。

`プロパティ` `Settings.run_mode`

run のモードを示します。“run” または “offline-run” のいずれかです。 戻り値:

Literal['run', 'offline-run']: run_mode プロパティの値です。

`プロパティ` `Settings.run_url`

run を表示できる W&B の URL です。 戻り値:

str: run_url プロパティの値。

`プロパティ` `Settings.settings_workspace`

Workspace settings ファイルのパスです。 戻り値:

str: settings_workspace プロパティの値です。

`プロパティ` `Settings.sweep_url`

sweep を表示できる W&B の URL です。 戻り値:

str: sweep_url プロパティの値。

`プロパティ` `Settings.sync_dir`

run ファイルを保存するディレクトリです。 戻り値:

str: sync_dir プロパティの値です。

`プロパティ` `Settings.sync_file`

追記専用のバイナリトランザクションログファイルへのパスです。 戻り値:

str: sync_file プロパティの値です。

`プロパティ` `Settings.sync_symlink_latest`

最新の run のトランザクションログファイルを指すシンボリックリンクのパスです。 戻り値:

str: sync_symlink_latest プロパティの値。

`プロパティ` `Settings.timespec`

run の時刻指定を表します。 戻り値:

str: timespec プロパティの値。

`プロパティ` `Settings.wandb_dir`

wandb ディレクトリのフルパスです。 戻り値:

str: wandb_dir のプロパティ値です。

​class Settings

​method Settings.__init__

​プロパティ Settings.app_url

​プロパティ Settings.colab_url

​プロパティ Settings.deployment

​プロパティ Settings.files_dir

​プロパティ Settings.is_local

​プロパティ Settings.log_dir

​プロパティ Settings.log_internal

​プロパティ Settings.log_symlink_internal

​プロパティ Settings.log_symlink_user

​プロパティ Settings.log_user

​プロパティ Settings.project_url

​プロパティ Settings.resume_fname

​プロパティ Settings.run_mode

​プロパティ Settings.run_url

​プロパティ Settings.settings_workspace

​プロパティ Settings.sweep_url

​プロパティ Settings.sync_dir

​プロパティ Settings.sync_file

​プロパティ Settings.sync_symlink_latest

​プロパティ Settings.timespec

​プロパティ Settings.wandb_dir