Api methods - Weights & Biases Documentation

Class wandb.Api

method Api.artifact()

Returns a single artifact.

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

Arguments

str

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.

str | None

The type of artifact to fetch.

Returns

An Artifact object.

Raises

If the artifact name is not specified.

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()

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.

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

Arguments

str

The type of artifact collection to fetch.

str

An artifact collection name. Optionally append the entity that logged the artifact as a prefix followed by a forward slash.

Returns

An ArtifactCollection object.

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()

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

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

Arguments

str

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”.

str

The type of artifact collection.

Returns

True if the artifact collection exists, False otherwise.

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()

Returns a collection of matching artifact collections.

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

Arguments

str

The name of the project to filter on.

str

The name of the artifact type to filter on.

str | None

Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.

int

Sets the page size for query pagination. Usually there is no reason to change this.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Returns

An iterable ArtifactCollections object.

method Api.artifact_exists()

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

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

Arguments

str

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”.

str | None

The type of artifact.

Returns

True if the artifact version exists, False otherwise.

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()

Returns the matching ArtifactType.

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

Arguments

str

The name of the artifact type to retrieve.

str | None

If given, a project name or path to filter on.

Returns

An ArtifactType object.

method Api.artifact_types()

Returns a collection of matching artifact types.

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

Arguments

str | None

The project name or path to filter on.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Returns

An iterable ArtifactTypes object.

method Api.artifact_versions()

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

(self, type_name, name, per_page=50)

Arguments

method Api.artifacts()

Return an Artifacts collection.

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

Arguments

str

The type of artifacts to fetch.

str

The artifact’s collection name. Optionally append the entity that logged the artifact as a prefix followed by a forward slash.

str | None

Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.

int

Sets the page size for query pagination. Usually there is no reason to change this.

list[str] | None

Only return artifacts with all of these tags.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Returns

An iterable Artifacts object.

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()

Returns the only Automation matching the parameters.

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

Arguments

str

The name of the automation to fetch.

str | None

The entity to fetch the automation for.

Raises

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()

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.

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

Arguments

str | None

The entity to fetch the automations for.

str | None

The name of the automation to fetch.

int

The number of automations to fetch per page. Defaults to 50. Usually there is no reason to change this.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Returns

A list of automations.

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()

Create a new Automation.

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

Arguments

NewAutomation

The automation to create.

bool

If True, and a conflicting automation already exists, attempt to fetch the existing automation instead of raising an error.

Unpack[WriteAutomationsKwargs]

Returns

The saved Automation.

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()

Create a custom chart preset and return its id.

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

Arguments

str

The entity (user or team) that owns the chart

str

Unique identifier for the chart preset

str

Human-readable name shown in the UI

Literal['vega2']

Type of specification. Must be “vega2” for Vega-Lite v2 specifications.

Literal['private', 'public']

Access level for the chart:

“private”: Chart is only accessible to the entity that created it
“public”: Chart is publicly accessible

str | dict

The Vega/Vega-Lite specification as a dictionary or JSON string

Returns

The ID of the created chart preset in the format “entity/name”

Raises

If chart creation fails

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()

Create a new project.

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

Arguments

str

The name of the new project.

str

The entity of the new project.

method Api.create_registry()

Create a new registry.

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

Arguments

str

The name of the registry. Name must be unique within the organization.

Literal['organization', 'restricted']

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.

str | None

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.

str | None

The description of the registry.

list[str] | None

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.

Returns

A registry object.

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()

Create a new run.

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

Arguments

str | None

The ID to assign to the run. If not specified, W&B creates a random ID.

str | None

The project where to log the run to. If no project is specified, log the run to a project called “Uncategorized”.

str | None

The entity that owns the project. If no entity is specified, log the run to the default entity.

Returns

The newly created Run.

method Api.create_run_queue()

Create a new run queue in W&B Launch.

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

Arguments

str

Name of the queue to create

public.RunQueueResourceType

Type of resource to be used for the queue. One of “local-container”, “local-process”, “kubernetes”,“sagemaker”, or “gcp-vertex”.

str | None

Name of the entity to create the queue. If None, use the configured or default entity.

public.RunQueuePrioritizationMode | None

Version of prioritization to use. Either “V0” or None.

dict | None

Default resource configuration to be used for the queue. Use handlebars (eg. {{var}}) to specify template variables.

dict | None

A dictionary of template variable schemas to use with the config.

Returns

The newly created RunQueue.

method Api.create_team()

Create a new team.

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

Arguments

str

The name of the team

str | None

Username of the admin user of the team. Defaults to the current user.

Returns

A Team object.

method Api.create_user()

Create a new user.

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

Arguments

str

The email address of the user.

bool | None

Set user as a global instance administrator.

Returns

A User object.

method Api.delete_automation()

Delete an automation.

self,
obj: 'Automation | str'

Arguments

Automation | str

The automation to delete, or its ID.

Returns

True if the automation was deleted successfully.

method Api.flush()

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.

(self)

method Api.from_path()

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

(self,
path: 'str')

Arguments

str

The path to the project, run, sweep or report

Returns

A Project, Run, Sweep, or BetaReport instance.

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()

Return an iterator of all integrations for an entity.

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

Arguments

str | None

The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.

int

Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.

str | None

method Api.job()

Return a Job object.

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

Arguments

str | None

The name of the job.

str | None

The root path to download the job artifact.

Returns

A Job object.

method Api.list_jobs()

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

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

Arguments

str

The entity for the listed jobs.

str

The project for the listed jobs.

Returns

A list of matching jobs.

method Api.organization()

Return the matching Organization.

self,
name: 'str | None' = None

Arguments

str | None

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

Returns

An Organization object.

method Api.project()

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

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

Arguments

str

The project name.

str | None

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.

Returns

A Project object.

method Api.projects()

Get projects for a given entity.

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

Arguments

str | None

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.

int

Sets the page size for query pagination. Usually there is no reason to change this.

Returns

A Projects object which is an iterable collection of Projectobjects.

method Api.queued_run()

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

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

Arguments

str

method Api.registries()

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

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

Arguments

str | None

The organization of the registry to fetch. If not specified, use the organization specified in the user’s settings.

dict[str, Any] | None

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

str | None

Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.

int

Sets the page size for query pagination.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Returns

A lazy iterator of Registry objects.

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()

Return a registry given a registry name.

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

Arguments

str

The name of the registry. This is without the wandb-registry- prefix.

str | None

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.

Returns

A registry object.

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()

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

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

Arguments

str

The path to the project the report resides in. Specify the entity that created the project as a prefix followed by a forward slash.

str | None

Name of the report requested.

int

Sets the page size for query pagination. Usually there is no reason to change this.

Returns

A Reports object which is an iterable collection of BetaReport objects.

Examples

import wandb

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

method Api.run()

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

(self, path='')

Arguments

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.

Returns

A Run object.

Raises

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

method Api.run_queue()

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

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

Arguments

str

method Api.runs()

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

(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)

Arguments

str | None

(str) path to project, should be in the form: “entity/project”

dict[str, Any] | None

(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”

str

(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.

int

(int) Sets the page size for query pagination.

bool

(bool) Whether to eagerly fetch the sweep object in each run result.

bool

(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.

Returns

A Runs object, which is an iterable collection of Run objects.

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()

Returns an iterator of Slack integrations for an entity.

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

Arguments

str | None

The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.

int

Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.

str | None

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()

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

(self, path='')

Arguments

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.

Returns

A Sweep object.

method Api.sync_tensorboard()

Sync a local directory containing tfevent files to wandb.

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

Arguments

method Api.team()

Return the matching Team with the given name.

self,
team: 'str'

Arguments

str

The name of the team.

Returns

A Team object.

method Api.update_automation()

Update an existing automation.

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

Arguments

Automation

The automation to update. Must be an existing automation.

bool

If True, and the automation does not exist, create it.

Unpack[WriteAutomationsKwargs]

Returns

The updated automation.

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()

Upsert a run queue in W&B Launch.

(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)

Arguments

str

Name of the queue to create

dict

Optional default resource configuration to be used for the queue. Use handlebars (eg. {{var}}) to specify template variables.

public.RunQueueResourceType

Type of resource to be used for the queue. One of “local-container”, “local-process”, “kubernetes”, “sagemaker”, or “gcp-vertex”.

str | None

Optional name of the entity to create the queue. If None, use the configured or default entity.

dict | None

A dictionary of template variable schemas to be used with the config.

dict | None

Optional dictionary of external links to be used with the queue.

public.RunQueuePrioritizationMode | None

Optional version of prioritization to use. Either “V0” or None

Returns

The upserted RunQueue.

method Api.user()

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.

self,
username_or_email: 'str'

Arguments

str

The username or email address of the user.

Returns

A User object or None if a user is not found.

method Api.users()

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.

self,
username_or_email: 'str'

Arguments

str

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

Returns

An array of User objects.

method Api.webhook_integrations()

Returns an iterator of webhook integrations for an entity.

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

Arguments

str | None

The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.

int

Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.

str | None

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

​method Api.artifact()

Arguments

Returns

Raises

Examples

​method Api.artifact_collection()

Arguments

Returns

Examples

​method Api.artifact_collection_exists()

Arguments

Returns

Examples

​method Api.artifact_collections()

Arguments

Returns

​method Api.artifact_exists()

Arguments

Returns

Examples

​method Api.artifact_type()

Arguments

Returns

​method Api.artifact_types()

Arguments

Returns

​method Api.artifact_versions()

Arguments

​method Api.artifacts()

Arguments

Returns

Examples

​method Api.automation()

Arguments

Raises

Examples

​method Api.automations()

Arguments

Returns

Examples

​method Api.create_automation()

Arguments

Returns

Examples

​method Api.create_custom_chart()

Arguments

Returns

Raises

Examples

​method Api.create_project()

Arguments

​method Api.create_registry()

Arguments

Returns

Examples

​method Api.create_run()

Arguments

Returns

​method Api.create_run_queue()

Arguments

Returns

​method Api.create_team()

Arguments

Returns

​method Api.create_user()

Arguments

Returns

​method Api.delete_automation()

Arguments

Returns

​method Api.flush()

​method Api.from_path()

Arguments

Returns

Examples

​method Api.integrations()

Arguments

​method Api.job()

Arguments

Class wandb.Api

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()