Login Reference

wandb.sdk.wandb_login

[view_source]

Log in to Weights & Biases, authenticating your machine to log data to your account.

login

login(anonymous=None, key=None, relogin=None, host=None, force=None)

[view_source]

Log in to W&B.

Arguments:

  • anonymous string, optional - Can be "must", "allow", or "never".

    If set to "must" we'll always login anonymously, if set to

    "allow" we'll only create an anonymous user if the user

    isn't already logged in.

  • key string, optional - authentication key.

  • relogin bool, optional - If true, will re-prompt for API key.

  • host string, optional - The host to connect to.

Returns:

  • bool - if key is configured

Raises:

UsageError - if api_key can not configured and no tty

_WandbLogin Objects

class _WandbLogin(object)

[view_source]

__init__

| __init__()

[view_source]

setup

| setup(kwargs)

[view_source]

is_apikey_configured

| is_apikey_configured()

[view_source]

set_backend

| set_backend(backend)

[view_source]

set_silent

| set_silent(silent)

[view_source]

login

| login()

[view_source]

login_display

| login_display()

[view_source]

configure_api_key

| configure_api_key(key)

[view_source]

update_session

| update_session(key)

[view_source]

prompt_api_key

| prompt_api_key()

[view_source]

propogate_login

| propogate_login()

[view_source]