Settings

*,
allow_media_symlink: bool = False,
allow_offline_artifacts: bool = True,
allow_val_change: bool = False,
anonymous: object = <object object at 0x105251170>,
api_key: Optional[str] = None,
azure_account_url_to_access_key: Optional[Dict[str, str]] = None,
app_url_override: Optional[str] = None,
base_url: str = 'https://api.wandb.ai',
code_dir: Optional[str] = None,
config_paths: Optional[collections.abc.Sequence[str]] = 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,
credentials_file: str = <factory>,
disable_code: bool = False,
disable_git: bool = False,
disable_git_fork_point: bool = True,
disable_job_creation: bool = True,
docker: Optional[str] = None,
email: Optional[str] = None,
entity: Optional[str] = None,
organization: Optional[str] = None,
force: bool = False,
fork_from: Optional[wandb.sdk.lib.run_moment.RunMoment] = None,
git_commit: Optional[str] = None,
git_remote: str = 'origin',
git_remote_url: Optional[str] = None,
git_root: Optional[str] = None,
heartbeat_seconds: int = 30,
host: Optional[str] = None,
http_proxy: Optional[str] = None,
https_proxy: Optional[str] = None,
identity_token_file: Optional[str] = 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: Optional[str] = None,
job_source: Optional[Literal['repo', 'artifact', 'image']] = None,
label_disable: bool = False,
launch: bool = False,
launch_config_path: Optional[str] = None,
login_timeout: Optional[float] = None,
mode: Literal['online', 'offline', 'shared', 'disabled', 'dryrun', 'run'] = 'online',
notebook_name: Optional[str] = None,
program: Optional[str] = None,
program_abspath: Optional[str] = None,
program_relpath: Optional[str] = None,
project: Optional[str] = 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: Optional[wandb.sdk.lib.run_moment.RunMoment] = None,
resumed: bool = False,
root_dir: str = <factory>,
run_group: Optional[str] = None,
run_id: Optional[str] = None,
run_job_type: Optional[str] = None,
run_name: Optional[str] = None,
run_notes: Optional[str] = None,
run_tags: Optional[Tuple[str, ...]] = None,
sagemaker_disable: bool = False,
save_code: Optional[bool] = None,
settings_system: Optional[str] = None,
stop_fn: Optional[Callable[[], NoneType]] = None,
max_end_of_run_history_metrics: int = 10,
max_end_of_run_summary_metrics: int = 10,
show_colors: Optional[bool] = None,
show_emoji: Optional[bool] = None,
show_errors: bool = True,
show_info: bool = True,
show_warnings: bool = True,
silent: bool = False,
start_method: Optional[str] = None,
stop_on_fatal_error: bool = False,
strict: Optional[bool] = None,
summary_timeout: int = 60,
summary_warnings: int = 5,
sweep_id: Optional[str] = None,
sweep_param_path: Optional[str] = None,
symlink: bool = <factory>,
sync_tensorboard: Optional[bool] = None,
table_raise_on_max_row_limit_exceeded: bool = False,
use_dot_wandb: Optional[bool] = None,
username: Optional[str] = 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: Optional[str] = None,
x_extra_http_headers: Optional[Dict[str, str]] = None,
x_file_stream_max_bytes: Optional[int] = None,
x_file_stream_max_line_bytes: Optional[int] = None,
x_file_stream_transmit_interval: Optional[float] = None,
x_file_stream_retry_max: Optional[int] = None,
x_file_stream_retry_wait_min_seconds: Optional[float] = None,
x_file_stream_retry_wait_max_seconds: Optional[float] = None,
x_file_stream_timeout_seconds: Optional[float] = None,
x_file_transfer_retry_max: Optional[int] = None,
x_file_transfer_retry_wait_min_seconds: Optional[float] = None,
x_file_transfer_retry_wait_max_seconds: Optional[float] = None,
x_file_transfer_timeout_seconds: Optional[float] = None,
x_files_dir: Optional[str] = None,
x_flow_control_custom: Optional[bool] = None,
x_flow_control_disabled: Optional[bool] = None,
x_graphql_retry_max: Optional[int] = None,
x_graphql_retry_wait_min_seconds: Optional[float] = None,
x_graphql_retry_wait_max_seconds: Optional[float] = None,
x_graphql_timeout_seconds: Optional[float] = None,
x_internal_check_process: float = 8.0,
x_jupyter_name: Optional[str] = None,
x_jupyter_path: Optional[str] = None,
x_jupyter_root: Optional[str] = None,
x_label: Optional[str] = None,
x_live_policy_rate_limit: Optional[int] = None,
x_live_policy_wait_time: Optional[int] = None,
x_log_level: int = 20,
x_network_buffer: Optional[int] = None,
x_primary: bool = True,
x_proxies: Optional[Dict[str, str]] = None,
x_runqueue_item_id: Optional[str] = None,
x_save_requirements: bool = True,
x_server_side_derived_summary: bool = False,
x_server_side_expand_glob_metrics: bool = True,
x_service_transport: Optional[str] = None,
x_service_wait: float = 30.0,
x_skip_transaction_log: bool = False,
x_start_time: Optional[float] = None,
x_stats_pid: int = 54642,
x_stats_sampling_interval: float = 15.0,
x_stats_neuron_monitor_config_path: Optional[str] = None,
x_stats_dcgm_exporter: Optional[str] = None,
x_stats_open_metrics_endpoints: Optional[Dict[str, str]] = None,
x_stats_open_metrics_filters: Union[Dict[str, Dict[str, str]], collections.abc.Sequence[str], NoneType] = None,
x_stats_open_metrics_http_headers: Optional[Dict[str, str]] = None,
x_stats_disk_paths: Optional[collections.abc.Sequence[str]] = ('/',),
x_stats_cpu_count: Optional[int] = None,
x_stats_cpu_logical_count: Optional[int] = None,
x_stats_gpu_count: Optional[int] = None,
x_stats_gpu_type: Optional[str] = None,
x_stats_gpu_device_ids: Optional[collections.abc.Sequence[int]] = 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_sync: bool = False,
x_sync_dir_suffix: str = '',
x_update_finish_state: bool = True

Description

Settings for the W&B SDK.

This class manages configuration settings for the W&B SDK, ensuring type safety and validation of all settings. Settings are accessible as attributes and can be initialized programmatically, through environment variables (WANDB_ prefix), and with configuration files.

The settings are organized into three categories:

1. Public settings: Core configuration options that users can safely modify to customize W&B’s behavior for their specific needs.
2. Internal settings: Settings prefixed with ‘x_’ that handle low-level SDK behavior. These settings are primarily for internal use and debugging. While they can be modified, they are not considered part of the public API and may change without notice in future versions.
3. Computed settings: Read-only settings that are automatically derived from other settings or the environment.

Args:

• allow_media_symlink:
• allow_offline_artifacts:
• allow_val_change:
• anonymous:
• api_key:
• azure_account_url_to_access_key:
• app_url_override:
• base_url:
• code_dir:
• config_paths:
• console:
• console_multipart:
• console_chunk_max_bytes:
• console_chunk_max_seconds:
• credentials_file:
• disable_code:
• disable_git:
• disable_git_fork_point:
• disable_job_creation:
• docker:
• email:
• entity:
• organization:
• force:
• fork_from:
• git_commit:
• git_remote:
• git_remote_url:
• git_root:
• heartbeat_seconds:
• host:
• http_proxy:
• https_proxy:
• identity_token_file:
• ignore_globs:
• init_timeout:
• finish_timeout:
• finish_timeout_raises:
• insecure_disable_ssl:
• job_name:
• job_source:
• label_disable:
• launch:
• launch_config_path:
• login_timeout:
• mode:
• notebook_name:
• program:
• program_abspath:
• program_relpath:
• project:
• quiet:
• reinit:
• relogin:
• resume:
• resume_from:
• resumed:
• root_dir:
• run_group:
• run_id:
• run_job_type:
• run_name:
• run_notes:
• run_tags:
• sagemaker_disable:
• save_code:
• settings_system:
• stop_fn:
• max_end_of_run_history_metrics:
• max_end_of_run_summary_metrics:
• show_colors:
• show_emoji:
• show_errors:
• show_info:
• show_warnings:
• silent:
• start_method:
• stop_on_fatal_error:
• strict:
• summary_timeout:
• summary_warnings:
• sweep_id:
• sweep_param_path:
• symlink:
• sync_tensorboard:
• table_raise_on_max_row_limit_exceeded:
• use_dot_wandb:
• username:
• x_cli_only_mode:
• x_disable_meta:
• x_disable_stats:
• x_disable_viewer:
• x_disable_machine_info:
• x_executable:
• x_extra_http_headers:
• x_file_stream_max_bytes:
• x_file_stream_max_line_bytes:
• x_file_stream_transmit_interval:
• x_file_stream_retry_max:
• x_file_stream_retry_wait_min_seconds:
• x_file_stream_retry_wait_max_seconds:
• x_file_stream_timeout_seconds:
• x_file_transfer_retry_max:
• x_file_transfer_retry_wait_min_seconds:
• x_file_transfer_retry_wait_max_seconds:
• x_file_transfer_timeout_seconds:
• x_files_dir:
• x_flow_control_custom:
• x_flow_control_disabled:
• x_graphql_retry_max:
• x_graphql_retry_wait_min_seconds:
• x_graphql_retry_wait_max_seconds:
• x_graphql_timeout_seconds:
• x_internal_check_process:
• x_jupyter_name:
• x_jupyter_path:
• x_jupyter_root:
• x_label:
• x_live_policy_rate_limit:
• x_live_policy_wait_time:
• x_log_level:
• x_network_buffer:
• x_primary:
• x_proxies:
• x_runqueue_item_id:
• x_save_requirements:
• x_server_side_derived_summary:
• x_server_side_expand_glob_metrics:
• x_service_transport:
• x_service_wait:
• x_skip_transaction_log:
• x_start_time:
• x_stats_pid:
• x_stats_sampling_interval:
• x_stats_neuron_monitor_config_path:
• x_stats_dcgm_exporter:
• x_stats_open_metrics_endpoints:
• x_stats_open_metrics_filters:
• x_stats_open_metrics_http_headers:
• x_stats_disk_paths:
• x_stats_cpu_count:
• x_stats_cpu_logical_count:
• x_stats_gpu_count:
• x_stats_gpu_type:
• x_stats_gpu_device_ids:
• x_stats_buffer_size:
• x_stats_coreweave_metadata_base_url:
• x_stats_coreweave_metadata_endpoint:
• x_stats_track_process_tree:
• x_sync:
• x_sync_dir_suffix:
• x_update_finish_state:

Properties:

app_url

The URL for the W&B UI, usually https://wandb.ai.

This is different from base_url (like https://api.wandb.ai) which is used to access W&B APIs programmatically.

colab_url

The URL to the Colab notebook, if running in Colab.

deployment

files_dir

Absolute path to the local directory where the run’s files are stored.

is_local

log_dir

The directory for storing log files.

log_internal

The path to the file to use for internal logs.

log_symlink_internal

The path to the symlink to the internal log file of the most recent run.

log_symlink_user

The path to the symlink to the user-process log file of the most recent run.

log_user

The path to the file to use for user-process logs.

project_url

The W&B URL where the project can be viewed.

resume_fname

The path to the resume file.

run_mode

The mode of the run. Can be either “run” or “offline-run”.

run_url

The W&B URL where the run can be viewed.

settings_workspace

The path to the workspace settings file.

sweep_url

The W&B URL where the sweep can be viewed.

sync_dir

The directory for storing the run’s files.

sync_file

Path to the append-only binary transaction log file.

sync_symlink_latest

Path to the symlink to the most recent run’s transaction log file.

timespec

The time specification for the run.

wandb_dir

Full path to the wandb directory.

Methods:

construct

copy

Returns a copy of the model.

!!! warning “Deprecated” This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

data = self.model_dump(include=include, exclude=exclude, round_trip=True)
data = {**data, **(update or {})}
copied = self.model_validate(data)

dict

from_orm

json

model_construct

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

model_copy

!!! abstract “Usage Documentation” model_copy

Returns a copy of the model.

!!! note The underlying instance’s [__dict__][object.dict] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

model_dump

!!! abstract “Usage Documentation” model_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

model_dump_json

!!! abstract “Usage Documentation” model_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

model_json_schema

Generates a JSON schema for a model class.

model_parametrized_name

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

model_post_init

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

model_rebuild

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

model_validate

Validate a pydantic model instance.

model_validate_json

!!! abstract “Usage Documentation” JSON Parsing

Validate the given JSON data against the Pydantic model.

model_validate_strings

Validate the given object with string data against the Pydantic model.

parse_file

parse_obj

parse_raw

schema

schema_json

update_forward_refs

validate

validate_anonymous

validate_x_extra_http_headers

validate_x_stats_coreweave_metadata_base_url