> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-update-reference-docs-60.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Settings

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "ソースを表示" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_settings.py#L61" />

## <Badge color="yellow" size="lg" shape="rounded">クラス</Badge> 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` 設定を上書きします)。

```python theme={null}
*,
allow_media_symlink: bool = False,
allow_offline_artifacts: bool = True,
allow_val_change: bool = False,
anonymous: object = object(),
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 = <factory>,
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: collections.abc.Sequence[str] = (),
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: Optional[Literal['repo', 'artifact', 'image']] = 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: Union[Literal['default', 'return_previous', 'finish_previous', 'create_new'], bool] = 'default',
relogin: bool = False,
resume: Optional[Literal['allow', 'must', 'never', 'auto']] = None,
resume_from: wandb.sdk.lib.run_moment.RunMoment | None = None,
resumed: bool = False,
root_dir: str = <factory>,
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,
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 = <factory>,
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_no_gzip: bool = True,
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 = 32512,
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
```

<div id="args">
  ## 引数
</div>

<ResponseField name="allow_media_symlink" type="bool">
  メディアファイルを run ディレクトリにシンボリックリンクするかどうか。

  true の場合、メディアファイルはコピーする代わりに、
  run ディレクトリにシンボリックリンクまたはハードリンクされます。これにより、
  ログすることが高速化され、ディスク使用量を削減できる場合があります。ただし、
  W\&B サーバーへのアップロード前に元のファイルを削除または変更すると、
  その内容がアップロードデータに反映されます。
</ResponseField>

<ResponseField name="allow_offline_artifacts" type="bool">
  オフラインモードで表のアーティファクトを同期できるようにするフラグ。

  以前の動作に戻すには、これを False に設定します。
</ResponseField>

<ResponseField name="allow_val_change" type="bool">
  `Config` 値を設定後に変更できるようにするフラグ。
</ResponseField>

<ResponseField name="anonymous" type="object">
  非推奨であり、削除される予定です。
</ResponseField>

<ResponseField name="api_key" type="str | None">
  W\&B APIキー。
</ResponseField>

<ResponseField name="azure_account_url_to_access_key" type="dict[str, str] | None">
  Azure インテグレーション用の、Azure アカウント URL と対応するアクセスキーのマッピング。
</ResponseField>

<ResponseField name="app_url_override" type="str | None">
  W\&B UI の「app」URL のオーバーライド。

  通常、`app_url` は `base_url` に基づいて算出されますが、これを使用して
  明示的に設定できます。

  WANDB\_APP\_URL は対応する環境変数です。
</ResponseField>

<ResponseField name="base_url" type="str">
  データ同期に使用する W\&B バックエンドの URL。
</ResponseField>

<ResponseField name="code_dir" type="str | None">
  W\&B でトラッキングするコードを含むディレクトリ。
</ResponseField>

<ResponseField name="config_paths" type="collections.abc.Sequence[str] | None">
  `Config` オブジェクトに読み込む設定ファイルのパス。
</ResponseField>

<ResponseField name="console" type="Literal">
  適用するコンソール出力の取得方法。

  指定可能な値は次のとおりです。

  * "auto" - システム環境と設定に基づいて、コンソール出力の取得方法を
    自動的に選択します。
  * "off" - コンソール出力の取得を無効にします。
  * "redirect" - 出力を取得するために低レベルのファイルディスクリプタをリダイレクトします。
  * "wrap" - sys.stdout/sys.stderr の write メソッドをオーバーライドします。システムの状態に基づいて、
    "wrap\_raw" または "wrap\_emu" のいずれかにマッピングされます。
  * "wrap\_raw" - "wrap" と同じですが、エミュレーターを介さずに生の出力を直接取得します。
    `wrap` 設定から導出されるため、手動で設定しないでください。
  * "wrap\_emu" - "wrap" と同じですが、エミュレーターを介して出力を取得します。
    `wrap` 設定から導出されるため、手動で設定しないでください。
</ResponseField>

<ResponseField name="console_multipart" type="bool">
  マルチパートコンソールログを有効にします。

  True の場合、SDK はコンソール出力を単一の `output.log` ではなく、
  `logs/` ディレクトリ以下のタイムスタンプ付きファイルに書き込みます。

  各パートは閉じられるとすぐにアップロードされるため、run がアクティブな間、
  ユーザーはログにリアルタイムでアクセスできます。ロールオーバーの頻度は
  `console_chunk_max_bytes` および/または `console_chunk_max_seconds` によって制御されます。
  両方の制限が `0` の場合、すべてのログは run の終了時に一度だけアップロードされます。

  注: アップロードされたチャンクは不変です。以前の行を変更するターミナル制御シーケンス
  (例: キャリッジリターンを使用するプログレスバー) は、
  現在のチャンクにのみ影響します。
</ResponseField>

<ResponseField name="console_chunk_max_bytes" type="int">
  マルチパートコンソールログのサイズベースのロールオーバーしきい値 (バイト単位) 。

  現在のパートがこのサイズに達すると、新しいコンソールログファイルを開始します。
  `console_multipart` が `True` の場合にのみ有効です。
  `console_chunk_max_seconds` と組み合わせて使用できます。先に
  到達した制限によってロールオーバーがトリガーされます。値を `0` にすると、
  サイズベースの制限が無効になります。
</ResponseField>

<ResponseField name="console_chunk_max_seconds" type="int">
  マルチパートコンソールログの時間ベースのロールオーバーしきい値 (秒単位) 。

  現在のパートの開始からこの秒数が経過すると、新しいコンソールログファイルを開始します。
  `console_multipart` を `True` にする必要があります。`console_chunk_max_bytes` と
  併用できます。先に到達した制限によってパートが閉じられます。値を `0` にすると、時間ベースの
  制限が無効になります。
</ResponseField>

<ResponseField name="capture_loggers" type="dict[str, str] | None">
  run の Logs タブに取得する Python ロガーの名前。

  ロガー名と最小ログレベルのマッピングです。設定すると、wandb は
  指定した各ロガーに logging.Handler をインストールし、run の終了時に削除します。
  これらのロガーから出力されたログレコードは、stdout/stderr の取得と同様に、
  run のコンソール出力として公開されます。

  ログレコードは `logging.basicConfig()` と同じ形式でフォーマットされます。たとえば、
  `INFO:my_module:Some message.` のようになります。現在、この形式はカスタマイズできません。

  すべてのログを取得するには、ルートロガー名である 'root' を渡します。

  これは `console` 設定とは独立しており、両方を同時に有効にできます。

  例:

  ```python theme={null}
  wandb.init(
      settings=wandb.Settings(
          console="off",
          capture_loggers={
              "my_app": "INFO",
              "my_app.training": "ERROR",
          },
      ),
  )
  ```
</ResponseField>

<ResponseField name="credentials_file" type="str">
  一時的なアクセストークンを書き込むファイルへのパス。
</ResponseField>

<ResponseField name="disable_code" type="bool">
  コードの取得を無効にするかどうか。
</ResponseField>

<ResponseField name="disable_git" type="bool">
  Git の状態の取得を無効にするかどうか。
</ResponseField>

<ResponseField name="disable_git_fork_point" type="bool">
  リモートブランチからフォークポイントを推測する機能を無効にするかどうか。

  True に設定すると、アップストリームブランチが設定されている場合、SDK はそのブランチの
  最新コミットを使用します。設定されていない場合は、差分パッチの生成をスキップします。

  False に設定すると、アップストリームブランチが設定されている場合、SDK はそのブランチの最新コミットの使用を試みます。
  それ以外の場合は、すべてのリモートブランチから最も近いコミットを検索します。
  アップストリームブランチが多数あるリポジトリでは、パフォーマンスに影響する可能性があります。
</ResponseField>

<ResponseField name="disable_job_creation" type="bool">
  W\&B Launch 用のジョブ アーティファクトの作成を無効にするかどうか。
</ResponseField>

<ResponseField name="docker" type="str | None">
  スクリプトの実行に使用する Docker イメージ。
</ResponseField>

<ResponseField name="email" type="str | None">
  ユーザーのメールアドレス。
</ResponseField>

<ResponseField name="entity" type="str | None">
  ユーザーやチームなどの W\&B エンティティ。
</ResponseField>

<ResponseField name="organization" type="str | None">
  W\&B 組織。
</ResponseField>

<ResponseField name="force" type="bool">
  `wandb.login()` に `force` フラグを渡すかどうか。
</ResponseField>

<ResponseField name="fork_from" type="wandb.sdk.lib.run_moment.RunMoment | None">
  フォーク元とする、以前の run 実行時点を指定します。

  この時点は、run ID、メトリクス、およびその値で定義されます。
  現在、サポートされるメトリクスは '\_step' のみです。
</ResponseField>

<ResponseField name="git_commit" type="str | None">
  run に関連付ける Git コミットハッシュ。
</ResponseField>

<ResponseField name="git_remote" type="str">
  run に関連付ける Git リモート。
</ResponseField>

<ResponseField name="git_remote_url" type="str | None">
  Git リモートリポジトリの URL。
</ResponseField>

<ResponseField name="git_root" type="str | None">
  Git リポジトリのルートディレクトリ。
</ResponseField>

<ResponseField name="host" type="str | None">
  スクリプトを実行するマシンのホスト名。
</ResponseField>

<ResponseField name="http_proxy" type="str | None">
  W\&B への HTTP リクエストに使用するカスタムプロキシサーバー。
</ResponseField>

<ResponseField name="https_proxy" type="str | None">
  W\&B への HTTPS リクエストに使用するカスタムプロキシサーバー。
</ResponseField>

<ResponseField name="identity_token_file" type="str | None">
  認証用のアイデンティティトークン (JWT) を含むファイルへのパス。
</ResponseField>

<ResponseField name="ignore_globs" type="Sequence">
  アップロードから除外する file を指定する、`files_dir` を基準とした Unix glob パターン。
</ResponseField>

<ResponseField name="init_timeout" type="float">
  タイムアウトまで `wandb.init` 呼び出しの完了を待機する時間 (秒) 。
</ResponseField>

<ResponseField name="finish_timeout" type="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 フックでスクリプト終了時に自動的に実行されます) にも、この設定が適用されます。
</ResponseField>

<ResponseField name="finish_timeout_raises" type="bool">
  finish\_timeout が期限切れになった場合に TimeoutError を発生させるかどうかです。

  これを `finish_timeout` 設定とともに使用すると、`run.finish()` はメッセージの出力に加えて、タイムアウト後に TimeoutError を発生させます。

  Run をコンテキストマネージャーとして使用する場合、`run.finish()` は暗黙的に呼び出されることに注意してください。

  with wandb.init() as run:
  ...  # `with` ブロックの終了時に run.finish() が実行されます

  これは `wandb.teardown()` でエラーを発生させません (いずれにしてもスクリプトの終了時に実行されるためです) 。
</ResponseField>

<ResponseField name="insecure_disable_ssl" type="bool">
  安全でない方法で SSL 検証を無効にするかどうかです。
</ResponseField>

<ResponseField name="job_name" type="str | None">
  スクリプトを実行している Launch ジョブの名前です。
</ResponseField>

<ResponseField name="job_source" type="Optional">
  Launch のソースタイプです。
</ResponseField>

<ResponseField name="label_disable" type="bool">
  自動ラベリング機能を無効にするかどうかです。
</ResponseField>

<ResponseField name="launch_config_path" type="str | None">
  Launch 設定 file へのパスです。
</ResponseField>

<ResponseField name="login_timeout" type="float | None">
  ログイン操作がタイムアウトするまで待機する秒数です。
</ResponseField>

<ResponseField name="mode" type="Literal">
  W\&B ログすることと同期の動作モードです。
</ResponseField>

<ResponseField name="notebook_name" type="str | None">
  Jupyter のような環境で実行している場合のノートブック名です。
</ResponseField>

<ResponseField name="program" type="str | None">
  利用可能な場合、run を作成したスクリプトへのパスです。
</ResponseField>

<ResponseField name="program_abspath" type="str | None">
  リポジトリのルートディレクトリから run を作成したスクリプトまでの絶対パスです。

  リポジトリのルートディレクトリは、存在する場合は .git ディレクトリを含むディレクトリとして定義されます。それ以外の場合は、現在の作業ディレクトリです。
</ResponseField>

<ResponseField name="program_relpath" type="str | None">
  run を作成したスクリプトへの相対パスです。
</ResponseField>

<ResponseField name="project" type="str | None">
  W\&B のプロジェクト ID です。
</ResponseField>

<ResponseField name="quiet" type="bool">
  必須ではない出力を抑制するフラグです。
</ResponseField>

<ResponseField name="reinit" type="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" と同じです。
</ResponseField>

<ResponseField name="relogin" type="bool">
  新しいログイン試行を強制するフラグです。
</ResponseField>

<ResponseField name="resume" type="Optional">
  run の再開時の動作を指定します。

  オプション:

  * "must": 同じ ID を持つ既存の run から再開します。そのような run が存在しない場合は、
    失敗します。
  * "allow": 同じ ID を持つ既存の run からの再開を試みます。見つからない場合は、
    新しい run が作成されます。
  * "never": 常に新しい run を開始します。同じ ID を持つ run がすでに存在する場合は、
    失敗します。
  * "auto": 同じマシン上で直近に失敗した run から自動的に再開します。
</ResponseField>

<ResponseField name="resume_from" type="wandb.sdk.lib.run_moment.RunMoment | None">
  run の以前の実行における再開元の時点を指定します。

  この時点は、run ID、メトリクス、およびその値で定義されます。
  現在サポートされているメトリクスは '\_step' のみです。
</ResponseField>

<ResponseField name="root_dir" type="str">
  すべての run 関連パスの基準となるルート ディレクトリです。

  特に、wandb ディレクトリと run ディレクトリの導出に使用されます。
</ResponseField>

<ResponseField name="run_group" type="str | None">
  関連する Runs のグループ識別子です。

  UI で Runs をグループ化するために使用します。
</ResponseField>

<ResponseField name="run_id" type="str | None">
  run の ID です。
</ResponseField>

<ResponseField name="run_job_type" type="str | None">
  実行するジョブのタイプ (例: トレーニング、評価) です。
</ResponseField>

<ResponseField name="run_name" type="str | None">
  run の人が読みやすい名前です。
</ResponseField>

<ResponseField name="run_notes" type="str | None">
  run に関する追加のメモまたは説明です。
</ResponseField>

<ResponseField name="run_tags" type="tuple[str, ...] | None">
  整理やフィルタリングのために run に関連付けるタグです。
</ResponseField>

<ResponseField name="sagemaker_disable" type="bool">
  SageMaker 固有の機能を無効にするフラグです。
</ResponseField>

<ResponseField name="save_code" type="bool | None">
  run に関連付けられているコードを保存するかどうかです。
</ResponseField>

<ResponseField name="settings_system" type="str | None">
  システム全体の設定ファイルへのパスです。
</ResponseField>

<ResponseField name="stop_fn" type="collections.abc.Callable[[], None] | None">
  run を停止するために実行するコールバックです。

  run は Web UI から、または致命的なエラー発生後に
  (設定で構成されている場合) 停止できます。

  デフォルトでは、run を停止するために W\&B はメインスレッドに SIGINT を送信します。
  別のシグナルを使用したり、中断前に別のアクションを実行したりするためにこの動作を
  オーバーライドするには、このコールバックを設定します。

  コールバックは別のスレッドで実行されます。停止が要求された後すぐに実行されますが、
  即時には実行されません。
</ResponseField>

<ResponseField name="max_end_of_run_history_metrics" type="int">
  run の終了時に表示する履歴スパークラインの最大数です。
</ResponseField>

<ResponseField name="max_end_of_run_summary_metrics" type="int">
  run の終了時に表示するサマリー メトリクスの最大数です。
</ResponseField>

<ResponseField name="show_errors" type="bool">
  エラー メッセージを表示するかどうかです。
</ResponseField>

<ResponseField name="show_info" type="bool">
  情報メッセージを表示するかどうかです。
</ResponseField>

<ResponseField name="show_warnings" type="bool">
  警告メッセージを表示するかどうかです。
</ResponseField>

<ResponseField name="silent" type="bool">
  すべての出力を抑制するフラグです。
</ResponseField>

<ResponseField name="stop_on_fatal_error" type="bool">
  致命的なエラーの後に run を停止するかどうかです。

  W\&B でデータのアップロード中に回復不能なエラーが発生すると、メッセージを出力して
  アップロードを停止しますが、引き続きデータをログできます。
  通常、これは望ましい動作です。トレーニング メトリクスはディスクに保存されるため、
  アップロードされていない場合でも `wandb sync` を使用して復元できます。

  トレーニング後にファイルが削除される場合、これは役に立ちません。
  その場合、これを True に設定すると、Web UI で停止ボタンを押した場合と同様に、
  致命的なエラーの後に run が停止します。
</ResponseField>

<ResponseField name="strict" type="bool | None">
  検証およびエラー チェックの厳格モードを有効にするかどうかです。
</ResponseField>

<ResponseField name="summary_timeout" type="int">
  タイムアウトまでサマリー操作を待機する時間 (秒) です。
</ResponseField>

<ResponseField name="sweep_id" type="str | None">
  この run が属する sweep の識別子です。
</ResponseField>

<ResponseField name="sweep_param_path" type="str | None">
  sweep パラメーター設定へのパスです。
</ResponseField>

<ResponseField name="symlink" type="bool">
  シンボリックリンクを使用するかどうかです (Windows 以外ではデフォルトで True) 。
</ResponseField>

<ResponseField name="sync_tensorboard" type="bool | None">
  TensorBoard ログを W\&B と同期するかどうか。
</ResponseField>

<ResponseField name="table_raise_on_max_row_limit_exceeded" type="bool">
  表の行数制限を超えた場合に例外を発生させるかどうか。
</ResponseField>

<ResponseField name="use_dot_wandb" type="bool | None">
  run データに、非表示の `.wandb` ディレクトリと表示される `wandb` ディレクトリのどちらを使用するか。

  True の場合、SDK は `.wandb` を使用します。False の場合は `wandb` を使用します。
  設定されていない場合、`.wandb` がすでに存在すれば `.wandb` を使用し、存在しない場合は `wandb` を使用します。
</ResponseField>

<ResponseField name="username" type="str | None">
  ユーザー名。
</ResponseField>

<ResponseField name="x_disable_meta" type="bool">
  システムメタデータの収集を無効にするフラグ。
</ResponseField>

<ResponseField name="x_disable_stats" type="bool">
  システムメトリクスの収集を無効にするフラグ。
</ResponseField>

<ResponseField name="x_extra_http_headers" type="dict[str, str] | None">
  すべての送信 HTTP リクエストに追加するヘッダー。
</ResponseField>

<ResponseField name="x_label" type="str | None">
  run 用に収集されるシステムメトリクスとコンソールログに割り当てるラベル。

  フロントエンドでデータをグループ化するために使用し、分散トレーニングジョブ内の
  異なるプロセスからのデータを区別できます。
</ResponseField>

<ResponseField name="x_primary" type="bool">
  内部 wandb ファイルとメタデータを保存するかどうかを決定します。

  分散環境では、プライマリプロセスが主なログすることを処理し、
  システムメトリクスとログのみが必要な場合に、セカンダリプロセスによる
  ファイルの上書きを回避するのに役立ちます。
</ResponseField>

<ResponseField name="x_save_requirements" type="bool">
  requirements ファイルを保存するフラグ。
</ResponseField>

<ResponseField name="x_server_side_derived_summary" type="bool">
  history から summary を自動計算する処理をサーバーに委譲するフラグ。

  ユーザーが指定した summary の更新は無効になりません。
</ResponseField>

<ResponseField name="x_service_wait" type="float">
  wandb-core の内部サービスの起動を待機する時間 (秒) 。
</ResponseField>

<ResponseField name="x_skip_transaction_log" type="bool">
  run イベントをトランザクションログに保存しないかどうか。

  これはオンライン run にのみ該当します。ディスクに書き込まれる
  データ量を削減するために使用できます。

  復旧可能性に関する保証が失われるため、
  注意して使用してください。
</ResponseField>

<ResponseField name="x_stats_sampling_interval" type="float">
  システムモニターのサンプリング間隔 (秒) 。
</ResponseField>

<ResponseField name="x_stats_open_metrics_endpoints" type="dict[str, str] | None">
  システムメトリクス用にモニターする OpenMetrics `/metrics` エンドポイント。
</ResponseField>

<ResponseField name="x_stats_open_metrics_filters" type="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", ...)`
</ResponseField>

<ResponseField name="x_stats_open_metrics_http_headers" type="dict[str, str] | None">
  OpenMetrics リクエストに追加する HTTP ヘッダー。
</ResponseField>

<ResponseField name="x_stats_disk_paths" type="collections.abc.Sequence[str] | None">
  ディスク使用量をモニターするシステムパス。
</ResponseField>

<ResponseField name="x_stats_cpu_count" type="int | None">
  システム CPU 数。

  設定した場合、run メタデータ内の自動検出された値を上書きします。
</ResponseField>

<ResponseField name="x_stats_cpu_logical_count" type="int | None">
  論理 CPU 数。

  設定した場合、run メタデータ内の自動検出された値を上書きします。
</ResponseField>

<ResponseField name="x_stats_gpu_count" type="int | None">
  GPU デバイス数。

  設定した場合、run メタデータ内の自動検出された値を上書きします。
</ResponseField>

<ResponseField name="x_stats_gpu_type" type="str | None">
  GPU デバイスタイプ。

  設定した場合、run メタデータ内の自動検出された値を上書きします。
</ResponseField>

<ResponseField name="x_stats_gpu_device_ids" type="collections.abc.Sequence[int] | None">
  モニターする GPU デバイスのインデックス。

  設定されていない場合、システムモニターはすべての GPU のメトリクスを取得します。
  CUDA/ROCm のデバイス列挙に対応する 0 始まりのインデックスを前提とします。
</ResponseField>

<ResponseField name="x_stats_track_process_tree" type="bool">
  `x_stats_pid` を起点に、プロセスツリー全体のリソース使用量をモニターします。

  `True` の場合、システムモニターは、PID `x_stats_pid` を持つプロセスとそのすべての子孫プロセスの RSS、CPU%、スレッド数を集計します。
  パフォーマンスのオーバーヘッドが発生する可能性があるため、デフォルトで無効です。
</ResponseField>

<ResponseField name="x_stats_no_cgroup" type="bool">
  システムメトリクスの割合に対する cgroup v2 の CPU およびメモリ制限を無効にします。
</ResponseField>

<ResponseField name="x_sync_dir_suffix" type="str">
  run のディレクトリ名 (sync\_dir) に追加する接尾辞です。

  名前の競合を回避するために wandb.init() で設定します。
  設定した場合、ダッシュでデフォルト名に連結されます。
</ResponseField>

<ResponseField name="x_update_finish_state" type="bool">
  このプロセスがサーバー上の run の最終状態を更新できるかどうかを示すフラグです。

  メインプロセスのみが最終状態を決定する必要がある分散トレーニングでは、False に設定します。
</ResponseField>

<div id="properties">
  ## プロパティ
</div>

<ResponseField name="app_url" type="str">
  W\&B UI の URL。通常は [https://wandb.ai](https://wandb.ai) です。

  W\&B API にプログラムでアクセスするために使用する `base_url` (例: [https://api.wandb.ai](https://api.wandb.ai)) とは異なります。
</ResponseField>

<ResponseField name="colab_url" type="str | None">
  Colab で実行している場合の Colab ノートブックの URL。
</ResponseField>

<ResponseField name="deployment" type="Literal['local', 'cloud']">
  説明はありません。
</ResponseField>

<ResponseField name="files_dir" type="str">
  run の file が保存されているローカルディレクトリの絶対パス。
</ResponseField>

<ResponseField name="is_local" type="bool">
  説明はありません。
</ResponseField>

<ResponseField name="log_dir" type="str">
  ログ file を保存するディレクトリ。
</ResponseField>

<ResponseField name="log_internal" type="str">
  内部ログに使用する file のパス。
</ResponseField>

<ResponseField name="log_symlink_internal" type="str">
  最新の run の内部ログ file へのシンボリックリンクのパス。
</ResponseField>

<ResponseField name="log_symlink_user" type="str">
  最新の run のユーザープロセスログ file へのシンボリックリンクのパス。
</ResponseField>

<ResponseField name="log_user" type="str">
  ユーザープロセスログに使用する file のパス。
</ResponseField>

<ResponseField name="project_url" type="str">
  project を表示できる W\&B URL。
</ResponseField>

<ResponseField name="resume_fname" type="str">
  再開用 file のパス。
</ResponseField>

<ResponseField name="run_mode" type="Literal['run', 'offline-run']">
  run のモード。"run" または "offline-run" のいずれかです。
</ResponseField>

<ResponseField name="run_url" type="str">
  run を表示できる W\&B URL。
</ResponseField>

<ResponseField name="settings_workspace" type="str">
  Workspace settings file のパス。
</ResponseField>

<ResponseField name="sweep_url" type="str">
  sweep を表示できる W\&B URL。
</ResponseField>

<ResponseField name="sync_dir" type="str">
  run の file を保存するディレクトリ。
</ResponseField>

<ResponseField name="sync_file" type="str">
  追記専用のバイナリトランザクションログ file のパス。
</ResponseField>

<ResponseField name="sync_symlink_latest" type="str">
  最新の run のトランザクションログ file へのシンボリックリンクのパス。
</ResponseField>

<ResponseField name="timespec" type="str">
  run の時刻指定。
</ResponseField>

<ResponseField name="wandb_dir" type="str">
  wandb ディレクトリの完全パス。
</ResponseField>

<div id="methods">
  ## メソッド
</div>

### <Badge color="blue" size="lg" shape="rounded">method</Badge> Settings.validate\_anonymous()

```python theme={null}
value: 'object'
```

<div id="arguments">
  ##### 引数
</div>

<ResponseField name="value" type="object">
  説明は提供されていません。
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">method</Badge> Settings.validate\_x\_extra\_http\_headers()

```python theme={null}
(value)
```

<div id="arguments">
  ##### 引数
</div>

<ResponseField name="value" type="_empty">
  説明はありません。
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">method</Badge> Settings.validate\_x\_stats\_coreweave\_metadata\_base\_url()

```python theme={null}
(value)
```

<div id="arguments">
  ##### 引数
</div>

<ResponseField name="value" type="_empty">
  説明はありません。
</ResponseField>
