Api - Weights & Biases Documentation

`class` wandb.Api

overrides: 'dict[str, Any] | None' = None,
timeout: 'int | None' = None,
api_key: 'str | None' = None

Used for querying the W&B server.

Args

overrides: You can set base_url if you are using a W&B server other than https://api.wandb.ai. You can also set defaults for entity, project, and run.
timeout: HTTP timeout in seconds for API requests. If not specified, the default timeout will be used.
api_key: API key to use for authentication. If not provided, the API key from the current environment or configuration will be used. Prompts for an API key if none is provided or configured in the environment.

Examples

import wandb

wandb.Api()

Properties

`property` default_entity

Returns the default W&B entity.

`property` user_agent

Returns W&B public user agent.

`property` viewer

Returns the viewer object.

Methods

`method` Api.artifact()

(self,
name: 'str',
type: 'str | None' = None)

Returns a single artifact.

Arguments

name: The artifact’s name. The name of an artifact resembles a filepath that consists, at a minimum, the name of the project the artifact was logged to, the name of the artifact, and the artifact’s version or alias. Optionally append the entity that logged the artifact as a prefix followed by a forward slash. If no entity is specified in the name, the Run or API setting’s entity is used.
type: The type of artifact to fetch.

Raises

ValueError: If the artifact name is not specified.
ValueError: If the artifact type is specified but does not match the type of the fetched artifact.

Examples

In the following code snippets “entity”, “project”, “artifact”, “version”, and “alias” are placeholders for your W&B entity, name of the project the artifact is in, the name of the artifact, and artifact’s version, respectively.

import wandb

# Specify the project, artifact's name, and the artifact's alias
wandb.Api().artifact(name="project/artifact:alias")

# Specify the project, artifact's name, and a specific artifact version
wandb.Api().artifact(name="project/artifact:version")

# Specify the entity, project, artifact's name, and the artifact's alias
wandb.Api().artifact(name="entity/project/artifact:alias")

# Specify the entity, project, artifact's name, and a specific artifact version
wandb.Api().artifact(name="entity/project/artifact:version")

`method` Api.artifact_collection()

self,
type_name: 'str',
name: 'str'

Returns a single artifact collection by type. You can use the returned ArtifactCollection object to retrieve information about specific artifacts in that collection, and more.

Arguments

type_name: The type of artifact collection to fetch.
name: An artifact collection name. Optionally append the entity that logged the artifact as a prefix followed by a forward slash.

Examples

In the proceeding code snippet “type”, “entity”, “project”, and “artifact_name” are placeholders for the collection type, your W&B entity, name of the project the artifact is in, and the name of the artifact, respectively.

import wandb

collections = wandb.Api().artifact_collection(
    type_name="type", name="entity/project/artifact_name"
)

# Get the first artifact in the collection
artifact_example = collections.artifacts()[0]

# Download the contents of the artifact to the specified root directory.
artifact_example.download()

`method` Api.artifact_collection_exists()

self,
name: 'str',
type: 'str'

Whether an artifact collection exists within a specified project and entity.

Arguments

name: An artifact collection name. Optionally append the entity that logged the artifact as a prefix followed by a forward slash. If entity or project is not specified, infer the collection from the override params if they exist. Otherwise, entity is pulled from the user settings and project will default to “uncategorized”.
type: The type of artifact collection.

Examples

In the proceeding code snippet “type”, and “collection_name” refer to the type of the artifact collection and the name of the collection, respectively.

import wandb

wandb.Api.artifact_collection_exists(type="type", name="collection_name")

`method` Api.artifact_collections()

self,
project_name: 'str',
type_name: 'str',
order: 'str | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None

Returns a collection of matching artifact collections.

Arguments

project_name: The name of the project to filter on.
type_name: The name of the artifact type to filter on.
order: Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.
per_page: Sets the page size for query pagination. Usually there is no reason to change this.
start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

`method` Api.artifact_exists()

self,
name: 'str',
type: 'str | None' = None

Whether an artifact version exists within the specified project and entity.

Arguments

name: The name of artifact. Add the artifact’s entity and project as a prefix. Append the version or the alias of the artifact with a colon. If the entity or project is not specified, W&B uses override parameters if populated. Otherwise, the entity is pulled from the user settings and the project is set to “Uncategorized”.
type: The type of artifact.

Examples

In the proceeding code snippets “entity”, “project”, “artifact”, “version”, and “alias” are placeholders for your W&B entity, name of the project the artifact is in, the name of the artifact, and artifact’s version, respectively.

import wandb

wandb.Api().artifact_exists("entity/project/artifact:version")
wandb.Api().artifact_exists("entity/project/artifact:alias")

`method` Api.artifact_type()

self,
type_name: 'str',
project: 'str | None' = None

Returns the matching ArtifactType.

Arguments

type_name: The name of the artifact type to retrieve.
project: If given, a project name or path to filter on.

`method` Api.artifact_types()

self,
project: 'str | None' = None,
start: 'str | None' = None

Returns a collection of matching artifact types.

Arguments

project: The project name or path to filter on.
start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

`method` Api.artifact_versions()

(self, type_name, name, per_page=50)

Deprecated. Use Api.artifacts(type_name, name) method instead.

Arguments

type_name:
name:
per_page:

`method` Api.artifacts()

self,
type_name: 'str',
name: 'str',
order: 'str | None' = None,
per_page: 'int' = 50,
tags: 'list[str] | None' = None,
start: 'str | None' = None

Return an Artifacts collection.

Arguments

type_name: The type of artifacts to fetch.
name: The artifact’s collection name. Optionally append the entity that logged the artifact as a prefix followed by a forward slash.
order: Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.
per_page: Sets the page size for query pagination. Usually there is no reason to change this.
tags: Only return artifacts with all of these tags.
start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Examples

In the proceeding code snippet, “type”, “entity”, “project”, and “artifact_name” are placeholders for the artifact type, W&B entity, name of the project the artifact was logged to, and the name of the artifact, respectively.

import wandb

wandb.Api().artifacts(type_name="type", name="entity/project/artifact_name")

Pause iteration and resume later from the same position by saving the paginator’s .cursor and passing it as start=:

from itertools import islice

import wandb

api = wandb.Api()

# Consume the first page of results, then save the cursor.
page_size = 10
artifacts = api.artifacts(
    type_name="type",
    name="entity/project/artifact_name",
    per_page=page_size,
)
first_page = list(islice(artifacts, page_size))

saved_cursor = artifacts.cursor

# Later (e.g. in a new process), resume iteration from the saved cursor.
remaining_artifacts = api.artifacts(
    type_name="type",
    name="entity/project/artifact_name",
    per_page=page_size,
    start=saved_cursor,
)

`method` Api.automation()

self,
name: 'str', *,
entity: 'str | None' = None

Returns the only Automation matching the parameters.

Arguments

name: The name of the automation to fetch.
entity: The entity to fetch the automation for.

Raises

ValueError: If zero or multiple Automations match the search criteria.

Examples

Get an existing automation named “my-automation”:

import wandb

api = wandb.Api()
automation = api.automation(name="my-automation")

Get an existing automation named “other-automation”, from the entity “my-team”:

automation = api.automation(name="other-automation", entity="my-team")

`method` Api.automations()

self,
entity: 'str | None' = None, *,
name: 'str | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None

Returns an iterator over all Automations that match the given parameters. If no parameters are provided, the returned iterator will contain all Automations that the user has access to.

Arguments

entity: The entity to fetch the automations for.
name: The name of the automation to fetch.
per_page: The number of automations to fetch per page. Defaults to 50. Usually there is no reason to change this.
start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Examples

Fetch all existing automations for the entity “my-team”:

import wandb

api = wandb.Api()
automations = api.automations(entity="my-team")

`method` Api.create_automation()

self,
obj: 'NewAutomation', *,
fetch_existing: 'bool' = False, **kwargs: 'Unpack[WriteAutomationsKwargs]'

Create a new Automation.

Arguments

obj: The automation to create.
fetch_existing: If True, and a conflicting automation already exists, attempt to fetch the existing automation instead of raising an error.
kwargs:

Examples

Create a new automation named “my-automation” that sends a Slack notification when a run within a specific project logs a metric exceeding a custom threshold:

import wandb
from wandb.automations import OnRunMetric, RunEvent, SendNotification

api = wandb.Api()

project = api.project("my-project", entity="my-team")

# Use the first Slack integration for the team
slack_hook = next(api.slack_integrations(entity="my-team"))

event = OnRunMetric(
    scope=project,
    filter=RunEvent.metric("custom-metric") > 10,
)
action = SendNotification.from_integration(slack_hook)

automation = api.create_automation(
    event >> action,
    name="my-automation",
    description="Send a Slack message whenever 'custom-metric' exceeds 10.",
)

`method` Api.create_custom_chart()

self,
entity: 'str',
name: 'str',
display_name: 'str',
spec_type: "Literal['vega2']",
access: "Literal['private', 'public']",
spec: 'str | dict'

Create a custom chart preset and return its id.

Arguments

entity: The entity (user or team) that owns the chart
name: Unique identifier for the chart preset
display_name: Human-readable name shown in the UI
spec_type: Type of specification. Must be “vega2” for Vega-Lite v2 specifications.
access: Access level for the chart:
- “private”: Chart is only accessible to the entity that created it
- “public”: Chart is publicly accessible
spec: The Vega/Vega-Lite specification as a dictionary or JSON string

Raises

wandb.Error: If chart creation fails
UnsupportedError: If the server doesn’t support custom charts

Examples

    import wandb

    api = wandb.Api()

    # Define a simple bar chart specification
    vega_spec = {
        "$schema": "https://vega.github.io/schema/vega-lite/v6.json",
        "mark": "bar",
        "data": {"name": "wandb"},
        "encoding": {
            "x": {"field": "${field:x}", "type": "ordinal"},
            "y": {"field": "${field:y}", "type": "quantitative"},
        },
    }

    # Create the custom chart
    chart_id = api.create_custom_chart(
        entity="my-team",
        name="my-bar-chart",
        display_name="My Custom Bar Chart",
        spec_type="vega2",
        access="private",
        spec=vega_spec,
    )

    # Use with wandb.plot_table()
    chart = wandb.plot_table(
        vega_spec_name=chart_id,
        data_table=my_table,
        fields={"x": "category", "y": "value"},
    )

`method` Api.create_project()

self,
name: 'str',
entity: 'str'

Create a new project.

Arguments

name: The name of the new project.
entity: The entity of the new project.

`method` Api.create_registry()

self,
name: 'str',
visibility: "Literal['organization', 'restricted']",
organization: 'str | None' = None,
description: 'str | None' = None,
artifact_types: 'list[str] | None' = None

Create a new registry.

Arguments

name: The name of the registry. Name must be unique within the organization.
visibility: The visibility of the registry. organization: Anyone in the organization can view this registry. You can edit their roles later from the settings in the UI. restricted: Only invited members via the UI can access this registry. Public sharing is disabled.
organization: The organization of the registry. If no organization is set in the settings, the organization will be fetched from the entity if the entity only belongs to one organization.
description: The description of the registry.
artifact_types: The accepted artifact types of the registry. A type is no more than 128 characters and do not include characters / or :. If not specified, all types are accepted. Allowed types added to the registry cannot be removed later.

Examples

import wandb

api = wandb.Api()
registry = api.create_registry(
    name="my-registry",
    visibility="restricted",
    organization="my-org",
    description="This is a test registry",
    artifact_types=["model"],
)

`method` Api.create_run()

self, *,
run_id: 'str | None' = None,
project: 'str | None' = None,
entity: 'str | None' = None

Create a new run.

Arguments

run_id: The ID to assign to the run. If not specified, W&B creates a random ID.
project: The project where to log the run to. If no project is specified, log the run to a project called “Uncategorized”.
entity: The entity that owns the project. If no entity is specified, log the run to the default entity.

`method` Api.create_run_queue()

self,
name: 'str',
type: 'public.RunQueueResourceType',
entity: 'str | None' = None,
prioritization_mode: 'public.RunQueuePrioritizationMode | None' = None,
config: 'dict | None' = None,
template_variables: 'dict | None' = None

Create a new run queue in W&B Launch.

Arguments

name: Name of the queue to create
type: Type of resource to be used for the queue. One of “local-container”, “local-process”, “kubernetes”,“sagemaker”, or “gcp-vertex”.
entity: Name of the entity to create the queue. If None, use the configured or default entity.
prioritization_mode: Version of prioritization to use. Either “V0” or None.
config: Default resource configuration to be used for the queue. Use handlebars (eg. {{var}}) to specify template variables.
template_variables: A dictionary of template variable schemas to use with the config.

`method` Api.create_team()

self,
team: 'str',
admin_username: 'str | None' = None

Create a new team. For W&B Multi-tenant Cloud users, set the Default API organization in your user settings in the W&B UI before calling create_team(). This setting determines the organization the new team will belong to.

Arguments

team: The name of the team.
admin_username: Username of the admin user of the team. Defaults to the current user.

`method` Api.create_user()

self,
email: 'str',
admin: 'bool | None' = False

Create a new user.

Arguments

email: The email address of the user.
admin: Set user as a global instance administrator.

`method` Api.delete_automation()

self,
obj: 'Automation | str'

Delete an automation.

Arguments

obj: The automation to delete, or its ID.

`method` Api.flush()

(self)

Flush the local cache. The api object keeps a local cache of runs, so if the state of the run may change while executing your script you must clear the local cache with api.flush() to get the latest values associated with the run.

`method` Api.from_path()

(self,
path: 'str')

Return a run, sweep, project or report from a path.

Arguments

path: The path to the project, run, sweep or report

Examples

In the proceeding code snippets “project”, “team”, “run_id”, “sweep_id”, and “report_name” are placeholders for the project, team, run ID, sweep ID, and the name of a specific report, respectively.

import wandb

api = wandb.Api()

project = api.from_path("project")
team_project = api.from_path("team/project")
run = api.from_path("team/project/runs/run_id")
sweep = api.from_path("team/project/sweeps/sweep_id")
report = api.from_path("team/project/reports/report_name")

`method` Api.integrations()

self,
entity: 'str | None' = None, *,
per_page: 'int' = 50,
start: 'str | None' = None

Return an iterator of all integrations for an entity.

Arguments

entity: The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.
per_page: Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.
start:

`method` Api.job()

self,
name: 'str | None',
path: 'str | None' = None

Return a Job object.

Arguments

name: The name of the job.
path: The root path to download the job artifact.

`method` Api.list_jobs()

self,
entity: 'str',
project: 'str'

Return a list of jobs, if any, for the given entity and project.

Arguments

entity: The entity for the listed jobs.
project: The project for the listed jobs.

`method` Api.organization()

self,
name: 'str | None' = None

Return the matching Organization.

Arguments

name: The name of the organization. If omitted, this method will attempt to infer and return the current default organization.

`method` Api.project()

self,
name: 'str',
entity: 'str | None' = None

Return the Project with the given name (and entity, if given).

Arguments

name: The project name.
entity: Name of the entity requested. If None, will fall back to the default entity passed to Api. If no default entity, will raise a ValueError.

`method` Api.projects()

self,
entity: 'str | None' = None,
per_page: 'int' = 200

Get projects for a given entity.

Arguments

entity: Name of the entity requested. If None, will fall back to the default entity passed to Api. If no default entity, will raise a ValueError.
per_page: Sets the page size for query pagination. Usually there is no reason to change this.

`method` Api.queued_run()

(self,
entity: 'str',
project: 'str',
queue_name: 'str',
run_queue_item_id: 'str', project_queue=None, priority=None)

Return a single queued run based on the path. Parses paths of the form entity/project/queue_id/run_queue_item_id.

Arguments

entity:
project:
queue_name:
run_queue_item_id:
project_queue:
priority:

`method` Api.registries()

self,
organization: 'str | None' = None,
filter: 'dict[str, Any] | None' = None,
order: 'str | None' = None,
per_page: 'int' = 100,
start: 'str | None' = None

Returns a lazy iterator of Registry objects. Use the iterator to search and filter registries, collections, or artifact versions across your organization’s registry.

Arguments

organization: The organization of the registry to fetch. If not specified, use the organization specified in the user’s settings.
filter: Optional MongoDB-style filter to apply to each object in the lazy registry iterator. Fields available to filter for registries are name, description, created_at, updated_at. Fields available to filter for collections are name, tag, description, created_at, updated_at Fields available to filter for versions are tag, alias, created_at, updated_at, metadata
order: Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.
per_page: Sets the page size for query pagination.
start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Examples

Find all registries with the names that contain “model”

import wandb

api = wandb.Api()  # specify an org if your entity belongs to multiple orgs
api.registries(filter={"name": {"$regex": "model"}})

Find all collections in the registries with the name “my_collection” and the tag “my_tag”

api.registries().collections(filter={"name": "my_collection", "tag": "my_tag"})

Find all artifact versions in the registries with a collection name that contains “my_collection” and a version that has the alias “best”

api.registries().collections(
    filter={"name": {"$regex": "my_collection"}}
).versions(filter={"alias": "best"})

Find all artifact versions in the registries that contain “model” and have the tag “prod” or alias “best”

api.registries(filter={"name": {"$regex": "model"}}).versions(
    filter={"$or": [{"tag": "prod"}, {"alias": "best"}]}
)

Pause iteration and resume later from the same position by saving the paginator’s .cursor and passing it as start=:

from itertools import islice

import wandb

api = wandb.Api()

# Consume the first page of results, then save the cursor.
page_size = 10
registries = api.registries(per_page=page_size)
first_page = list(islice(registries, page_size))

saved_cursor = registries.cursor

# Later (e.g. in a new process), resume iteration from the saved cursor.
remaining_registries = api.registries(per_page=page_size, start=saved_cursor)

`method` Api.registry()

self,
name: 'str',
organization: 'str | None' = None

Return a registry given a registry name.

Arguments

name: The name of the registry. This is without the wandb-registry- prefix.
organization: The organization of the registry. If no organization is set in the settings, the organization will be fetched from the entity if the entity only belongs to one organization.

Examples

Fetch and update a registry

import wandb

api = wandb.Api()
registry = api.registry(name="my-registry", organization="my-org")
registry.description = "This is an updated description"
registry.save()

`method` Api.reports()

self,
path: 'str' = '',
name: 'str | None' = None,
per_page: 'int' = 50

Get reports for a given project path. Note: wandb.Api.reports() API is in beta and will likely change in future releases.

Arguments

path: The path to the project the report resides in. Specify the entity that created the project as a prefix followed by a forward slash.
name: Name of the report requested.
per_page: Sets the page size for query pagination. Usually there is no reason to change this.

Examples

import wandb

wandb.Api.reports("entity/project")

`method` Api.run()

(self, path='')

Return a single run by parsing path in the form entity/project/run_id.

Arguments

path: Path to run in the form entity/project/run_id. If api.entity is set, this can be in the form project/run_id and if api.project is set this can just be the run_id.

Raises

RunNotFoundError: If a run is not found, or run data is not able to be loaded.

`method` Api.run_queue()

(self,
entity: 'str',
name: 'str')

Return the named RunQueue for entity. See Api.create_run_queue for more information on how to create a run queue.

Arguments

entity:
name:

`method` Api.runs()

(self,
path: 'str | None' = None,
filters: 'dict[str, Any] | None' = None,
order: 'str' = '+created_at',
per_page: 'int' = 50,
include_sweeps: 'bool' = False,
lazy: 'bool' = True)

Returns a Runs object, which lazily iterates over Run objects. Fields you can filter by include:

createdAt: The timestamp when the run was created. (in ISO 8601 format, e.g. “2023-01-01T12:00:00Z”)
displayName: The human-readable display name of the run. (e.g. “eager-fox-1”)
duration: The total runtime of the run in seconds.
group: The group name used to organize related runs together.
host: The hostname where the run was executed.
jobType: The type of job or purpose of the run.
name: The unique identifier of the run. (e.g. “a1b2cdef”)
state: The current state of the run.
tags: The tags associated with the run.
username: The username of the user who initiated the run

Additionally, you can filter by items in the run config or summary metrics. Such as config.experiment_name, summary_metrics.loss, etc. For more complex filtering, you can use MongoDB query operators. For details, see: https://docs.mongodb.com/manual/reference/operator/query The following operations are supported:

$and
$or
$nor
$eq
$ne
$gt
$gte
$lt
$lte
$in
$nin
$exists
$regex

Arguments

path: (str) path to project, should be in the form: “entity/project”
filters: (dict) queries for specific runs using the MongoDB query language. You can filter by run properties such as config.key, summary_metrics.key, state, entity, createdAt, etc. For example: {"config.experiment_name": "foo"} would find runs with a config entry of experiment name set to “foo”
order: (str) Order can be created_at, heartbeat_at, config.*.value, or summary_metrics.*. If you prepend order with a + order is ascending (default). If you prepend order with a - order is descending. The default order is run.created_at from oldest to newest.
per_page: (int) Sets the page size for query pagination.
include_sweeps: (bool) Whether to eagerly fetch the sweep object in each run result.
lazy: (bool) Whether to use lazy loading for faster performance. When True (default), only essential run metadata is loaded initially. Heavy fields like config, summaryMetrics, and systemMetrics are loaded on-demand when accessed. Set to False for full data upfront.

Examples

import wandb
from wandb.apis.public import Api

# Find runs in project where config.experiment_name has been set to "foo"
Api.runs(path="my_entity/project", filters={"config.experiment_name": "foo"})

# Find runs in project where config.experiment_name has been set to "foo" or "bar"
Api.runs(
    path="my_entity/project",
    filters={
        "$or": [
            {"config.experiment_name": "foo"},
            {"config.experiment_name": "bar"},
        ]
    },
)

# Find runs in project where config.experiment_name matches a regex
Api.runs(
    path="my_entity/project",
    filters={"config.experiment_name": {"$regex": "b.*"}},
)

Note: Regular expressions use Google’s RE2 syntax: https://github.com/google/re2/wiki/Syntax

# Find runs in project where the run name matches a regex
Api.runs(
    path="my_entity/project", filters={"display_name": {"$regex": "^foo.*"}}
)

# Find runs in project sorted by ascending loss
Api.runs(path="my_entity/project", order="+summary_metrics.loss")

`method` Api.slack_integrations()

self, *,
entity: 'str | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None

Returns an iterator of Slack integrations for an entity.

Arguments

entity: The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.
per_page: Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.
start:

Examples

Get all registered Slack integrations for the team “my-team”:

import wandb

api = wandb.Api()
slack_integrations = api.slack_integrations(entity="my-team")

Find only Slack integrations that post to channel names starting with “team-alerts-”:

slack_integrations = api.slack_integrations(entity="my-team")
team_alert_integrations = [
    ig
    for ig in slack_integrations
    if ig.channel_name.startswith("team-alerts-")
]

`method` Api.sweep()

(self, path='')

Return a sweep by parsing path in the form entity/project/sweep_id.

Arguments

path: Path to sweep in the form entity/project/sweep_id. If api.entity is set, this can be in the form project/sweep_id and if api.project is set this can just be the sweep_id.

`method` Api.sync_tensorboard()

(self, root_dir, run_id=None, project=None, entity=None)

Sync a local directory containing tfevent files to wandb.

Arguments

root_dir:
run_id:
project:
entity:

`method` Api.team()

self,
team: 'str'

Return the matching Team with the given name.

Arguments

team: The name of the team.

`method` Api.update_automation()

self,
obj: 'Automation', *,
create_missing: 'bool' = False, **kwargs: 'Unpack[WriteAutomationsKwargs]'

Update an existing automation.

Arguments

obj: The automation to update. Must be an existing automation.
create_missing: If True, and the automation does not exist, create it.
kwargs:

Examples

Disable and edit the description of an existing automation (“my-automation”):

import wandb

api = wandb.Api()

automation = api.automation(name="my-automation")
automation.enabled = False
automation.description = "Kept for reference, but no longer used."

updated_automation = api.update_automation(automation)

import wandb

api = wandb.Api()

automation = api.automation(name="my-automation")

updated_automation = api.update_automation(
    automation,
    enabled=False,
    description="Kept for reference, but no longer used.",
)

`method` Api.upsert_run_queue()

(self,
name: 'str',
resource_config: 'dict',
resource_type: 'public.RunQueueResourceType',
entity: 'str | None' = None,
template_variables: 'dict | None' = None,
external_links: 'dict | None' = None,
prioritization_mode: 'public.RunQueuePrioritizationMode | None' = None)

Upsert a run queue in W&B Launch.

Arguments

name: Name of the queue to create
resource_config: Optional default resource configuration to be used for the queue. Use handlebars (eg. {{var}}) to specify template variables.
resource_type: Type of resource to be used for the queue. One of “local-container”, “local-process”, “kubernetes”, “sagemaker”, or “gcp-vertex”.
entity: Optional name of the entity to create the queue. If None, use the configured or default entity.
template_variables: A dictionary of template variable schemas to be used with the config.
external_links: Optional dictionary of external links to be used with the queue.
prioritization_mode: Optional version of prioritization to use. Either “V0” or None

`method` Api.user()

self,
username_or_email: 'str'

Return a user from a username or email address. This function only works for local administrators. Use api.viewer to get your own user object.

Arguments

username_or_email: The username or email address of the user.

`method` Api.users()

self,
username_or_email: 'str'

Return all users from a partial username or email address query. This function only works for local administrators. Use api.viewer to get your own user object.

Arguments

username_or_email: The prefix or suffix of the user you want to find.

`method` Api.webhook_integrations()

self,
entity: 'str | None' = None, *,
per_page: 'int' = 50,
start: 'str | None' = None

Returns an iterator of webhook integrations for an entity.

Arguments

entity: The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.
per_page: Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.
start:

Examples

Get all registered webhook integrations for the team “my-team”:

import wandb

api = wandb.Api()
webhook_integrations = api.webhook_integrations(entity="my-team")

Find only webhook integrations that post requests to “https://my-fake-url.com”:

webhook_integrations = api.webhook_integrations(entity="my-team")
my_webhooks = [
    ig
    for ig in webhook_integrations
    if ig.url_endpoint.startswith("https://my-fake-url.com")
]

​class wandb.Api

​Args

​Examples

​Properties

​property default_entity

​property user_agent

​property viewer

​Methods

​method Api.artifact()

Arguments

Raises

Examples

​method Api.artifact_collection()

Arguments

Examples

​method Api.artifact_collection_exists()

Arguments

Examples

​method Api.artifact_collections()

Arguments

​method Api.artifact_exists()

Arguments

Examples

​method Api.artifact_type()

Arguments

​method Api.artifact_types()

Arguments

​method Api.artifact_versions()

Arguments

​method Api.artifacts()

Arguments

Examples

​method Api.automation()

Arguments

Raises

Examples

​method Api.automations()

Arguments

Examples

​method Api.create_automation()

Arguments

Examples

​method Api.create_custom_chart()

Arguments

Raises

Examples

​method Api.create_project()

Arguments

​method Api.create_registry()

Arguments

Examples

​method Api.create_run()

Arguments

​method Api.create_run_queue()

Arguments

​method Api.create_team()

Arguments

​method Api.create_user()

Arguments

​method Api.delete_automation()

Arguments

​method Api.flush()

​method Api.from_path()

Arguments

Examples

​method Api.integrations()

Arguments

​method Api.job()

Arguments

​method Api.list_jobs()

Arguments

​method Api.organization()

Arguments

​method Api.project()

Arguments

​method Api.projects()

Arguments

​method Api.queued_run()

Arguments

​method Api.registries()

`class` wandb.Api

Args

Examples

Properties

`property` default_entity

`property` user_agent

`property` viewer

Methods

`method` Api.artifact()

`method` Api.artifact_collection()

`method` Api.artifact_collection_exists()

`method` Api.artifact_collections()

`method` Api.artifact_exists()

`method` Api.artifact_type()

`method` Api.artifact_types()

`method` Api.artifact_versions()

`method` Api.artifacts()

`method` Api.automation()

`method` Api.automations()

`method` Api.create_automation()

`method` Api.create_custom_chart()

`method` Api.create_project()

`method` Api.create_registry()

`method` Api.create_run()

`method` Api.create_run_queue()

`method` Api.create_team()

`method` Api.create_user()

`method` Api.delete_automation()

`method` Api.flush()

`method` Api.from_path()

`method` Api.integrations()

`method` Api.job()

`method` Api.list_jobs()

`method` Api.organization()

`method` Api.project()

`method` Api.projects()

`method` Api.queued_run()

`method` Api.registries()

`method` Api.registry()

`method` Api.reports()

`method` Api.run()

`method` Api.run_queue()

`method` Api.runs()

`method` Api.slack_integrations()

`method` Api.sweep()

`method` Api.sync_tensorboard()

`method` Api.team()

`method` Api.update_automation()

`method` Api.upsert_run_queue()

`method` Api.user()

`method` Api.users()

`method` Api.webhook_integrations()