Skip to content

Latest commit

History

History
562 lines (364 loc) 路 19.4 KB

File metadata and controls

562 lines (364 loc) 路 19.4 KB
title Settings

wandb.sdk.wandb_settings

[view_source]

This module configures settings for wandb runs.

Order of loading settings: (differs from priority) defaults environment wandb.setup(settings=) system_config workspace_config wandb.init(settings=) network_org network_entity network_project

Priority of settings: See "source" variable.

When override is used, it has priority over non-override settings

Override priorities are in the reverse order of non-override settings

defaults

[view_source]

env_prefix

[view_source]

env_settings

[view_source]

env_convert

[view_source]

get_wandb_dir

get_wandb_dir(root_dir: str)

[view_source]

SettingsConsole Objects

@enum.unique
class SettingsConsole(enum.Enum)

[view_source]

OFF

[view_source]

WRAP

[view_source]

REDIRECT

[view_source]

Settings Objects

class Settings(object)

[view_source]

Settings Constructor

Arguments:

  • entity - personal user or team to use for Run.
  • project - project name for the Run.

Raises:

  • Exception - if problem.

mode

[view_source]

console

[view_source]

disabled

[view_source]

run_tags

[view_source]

resume_fname_spec

[view_source]

root_dir

[view_source]

log_dir_spec

[view_source]

log_user_spec

[view_source]

log_internal_spec

[view_source]

sync_file_spec

[view_source]

sync_dir_spec

[view_source]

files_dir_spec

[view_source]

log_symlink_user_spec

[view_source]

log_symlink_internal_spec

[view_source]

sync_symlink_latest_spec

[view_source]

settings_system_spec

[view_source]

settings_workspace_spec

[view_source]

silent

[view_source]

show_info

[view_source]

show_warnings

[view_source]

show_errors

[view_source]

Source Objects

@enum.unique
class Source(enum.IntEnum)

[view_source]

BASE

[view_source]

ORG

[view_source]

ENTITY

[view_source]

PROJECT

[view_source]

USER

[view_source]

SYSTEM

[view_source]

WORKSPACE

[view_source]

ENV

[view_source]

SETUP

[view_source]

LOGIN

[view_source]

INIT

[view_source]

SETTINGS

[view_source]

ARGS

[view_source]

Console

[view_source]

__init__

 | __init__(base_url: str = None, api_key: str = None, anonymous=None, mode: str = None, entity: str = None, project: str = None, run_group: str = None, run_job_type: str = None, run_id: str = None, run_name: str = None, run_notes: str = None, resume: str = None, magic: Union[Dict, str, bool] = False, run_tags: Sequence = None, sweep_id=None, allow_val_change: bool = None, force: bool = None, relogin: bool = None, problem="fatal", system_sample_seconds=2, system_samples=15, heartbeat_seconds=30, config_paths=None, _config_dict=None, root_dir=None, settings_system_spec="~/.config/wandb/settings", settings_workspace_spec="{wandb_dir}/settings", sync_dir_spec="{wandb_dir}/{run_mode}-{timespec}-{run_id}", sync_file_spec="run-{run_id}.wandb", sync_symlink_latest_spec="{wandb_dir}/latest-run", log_dir_spec="{wandb_dir}/{run_mode}-{timespec}-{run_id}/logs", log_user_spec="debug.log", log_internal_spec="debug-internal.log", log_symlink_user_spec="{wandb_dir}/debug.log", log_symlink_internal_spec="{wandb_dir}/debug-internal.log", resume_fname_spec="{wandb_dir}/wandb-resume.json", files_dir_spec="{wandb_dir}/{run_mode}-{timespec}-{run_id}/files", symlink=None, program=None, notebook_name=None, disable_code=None, ignore_globs=None, save_code=None, program_relpath=None, git_remote=None, dev_prod=None, host=None, username=None, email=None, docker=None, _start_time=None, _start_datetime=None, _cli_only_mode=None, _disable_viewer=None, console=None, disabled=None, reinit=None, _save_requirements=True, show_colors=None, show_emoji=None, silent=None, show_info=None, show_warnings=None, show_errors=None, summary_errors=None, summary_warnings=None, _internal_queue_timeout=2, _internal_check_process=8, _disable_meta=None, _disable_stats=None, _jupyter_path=None, _jupyter_name=None, _jupyter_root=None, _executable=None, _cuda=None, _args=None, _os=None, _python=None, _kaggle=None, _except_exit=None)

[view_source]

resume_fname

 | @property
 | resume_fname() -> str

[view_source]

wandb_dir

 | @property
 | wandb_dir() -> str

[view_source]

log_user

 | @property
 | log_user() -> str

[view_source]

log_internal

 | @property
 | log_internal() -> str

[view_source]

sync_file

 | @property
 | sync_file() -> str

[view_source]

files_dir

 | @property
 | files_dir() -> str

[view_source]

log_symlink_user

 | @property
 | log_symlink_user() -> str

[view_source]

log_symlink_internal

 | @property
 | log_symlink_internal() -> str

[view_source]

sync_symlink_latest

 | @property
 | sync_symlink_latest() -> str

[view_source]

settings_system

 | @property
 | settings_system() -> str

[view_source]

settings_workspace

 | @property
 | settings_workspace() -> str

[view_source]

__copy__

 | __copy__()

[view_source]

Copy (note that the copied object will not be frozen).

duplicate

 | duplicate()

[view_source]

update

 | update(__d=None, **kwargs)

[view_source]

setdefaults

 | setdefaults(__d=None)

[view_source]

save

 | save(fname)

[view_source]

load

 | load(fname)

[view_source]

__setattr__

 | __setattr__(name, value)

[view_source]

keys

 | keys()

[view_source]

__getitem__

 | __getitem__(k)

[view_source]

freeze

 | freeze()

[view_source]

is_frozen

 | is_frozen() -> bool

[view_source]

_Setter Objects

class _Setter(object)

[view_source]

__init__

 | __init__(settings, source, override)

[view_source]

__enter__

 | __enter__()

[view_source]

__exit__

 | __exit__(exc_type, exc_value, exc_traceback)

[view_source]

__setattr__

 | __setattr__(name, value)

[view_source]

update

 | update(*args, **kwargs)

[view_source]