Class wandb.Api
Used for querying the W&B server.Args
You can set
base_url if you are using a W&B server other than https://api.forge.coreweave.com. You can also set defaults for entity, project, and run.HTTP timeout in seconds for API requests. If not specified, the default timeout will be used.
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
Properties
Methods
method Api.artifact()
Arguments
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.
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.method Api.artifact_collection()
ArtifactCollection object to retrieve
information about specific artifacts in that collection, and more.
Arguments
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.method Api.artifact_collection_exists()
Arguments
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”.
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.method Api.artifact_collections()
Arguments
Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.
Pagination cursor for resuming a past query, captured from a previous paginator’s
.cursor attribute.method Api.artifact_exists()
Arguments
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”.
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.method Api.artifact_type()
ArtifactType.
Arguments
method Api.artifact_types()
Arguments
Pagination cursor for resuming a past query, captured from a previous paginator’s
.cursor attribute.method Api.artifact_versions()
Api.artifacts(type_name, name) method instead.
Arguments
method Api.artifacts()
Artifacts collection.
Arguments
The artifact’s collection name. Optionally append the entity that logged the artifact as a prefix followed by a forward slash.
Optional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.
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..cursor and passing it as start=:
method Api.automation()
Arguments
Raises
ValueError: If zero or multiple Automations match the search criteria.
Examples
Get an existing automation named “my-automation”:method Api.automations()
Arguments
The number of automations to fetch per page. Defaults to 50. Usually there is no reason to change this.
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”:method Api.create_automation()
Arguments
If True, and a conflicting automation already exists, attempt to fetch the existing automation instead of raising an error.
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:method Api.create_custom_chart()
Arguments
Access level for the chart:
- “private”: Chart is only accessible to the entity that created it
- “public”: Chart is publicly accessible
Raises
wandb.Error: If chart creation failsUnsupportedError: If the server doesn’t support custom charts
Examples
method Api.create_project()
Arguments
method Api.create_registry()
Arguments
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.
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.
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
method Api.create_run()
Arguments
The project where to log the run to. If no project is specified, log the run to a project called “Uncategorized”.
The entity that owns the project. If no entity is specified, log the run to the default entity.
method Api.create_run_queue()
Arguments
Type of resource to be used for the queue. One of “local-container”, “local-process”, “kubernetes”,“sagemaker”, or “gcp-vertex”.
Default resource configuration to be used for the queue. Use handlebars (eg.
{{var}}) to specify template variables.method Api.create_team()
create_team().
This setting determines the organization the new team will belong to.
Arguments
method Api.create_user()
Arguments
method Api.delete_automation()
Arguments
method Api.flush()
api.flush() to get the latest values associated with the run.
method Api.from_path()
Arguments
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.method Api.integrations()
Arguments
The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.
Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.
method Api.job()
Job object.
Arguments
method Api.list_jobs()
Arguments
method Api.organization()
Organization.
Arguments
The name of the organization. If omitted, this method will attempt to infer and return the current default organization.
method Api.project()
Project with the given name (and entity, if given).
Arguments
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()
Arguments
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.queued_run()
entity/project/queue_id/run_queue_item_id.
Arguments
method Api.registries()
Registry objects.
Use the iterator to search and filter registries, collections,
or artifact versions across your organization’s registry. Results are
fetched lazily as you iterate, so you can stop after any number of
items—for example, with :func:itertools.islice—without requesting
the rest.
Arguments
The organization of the registry to fetch. If not specified, use the organization specified in the user’s settings.
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, metadataOptional string to specify the order of the results. If prefixed with ’+’, sorts ascending (default). If prefixed with ’-’, sorts descending.
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”.cursor and passing it as start=:
method Api.registry()
Arguments
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 registrymethod Api.reports()
wandb.Api.reports() API is in beta and will likely change in
future releases.
Arguments
The path to the project the report resides in. Specify the entity that created the project as a prefix followed by a forward slash.
Examples
method Api.run()
entity/project/run_id.
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.Raises
RunNotFoundError: If a run is not found, or run data is not able to be loaded.
method Api.run_queue()
RunQueue for entity.
See Api.create_run_queue for more information on how to create a run queue.
Arguments
method Api.runs()
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
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
(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) 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.(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
method Api.slack_integrations()
Arguments
The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.
Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.
Examples
Get all registered Slack integrations for the team “my-team”:method Api.sweep()
entity/project/sweep_id.
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.method Api.sync_tensorboard()
Arguments
method Api.team()
Team with the given name.
Arguments
method Api.update_automation()
Arguments
Examples
Disable and edit the description of an existing automation (“my-automation”):method Api.upsert_run_queue()
Arguments
Optional default resource configuration to be used for the queue. Use handlebars (eg.
{{var}}) to specify template variables.Type of resource to be used for the queue. One of “local-container”, “local-process”, “kubernetes”, “sagemaker”, or “gcp-vertex”.
Optional name of the entity to create the queue. If
None, use the configured or default entity.Optional version of prioritization to use. Either “V0” or None
method Api.user()
api.viewer
to get your own user object.
Arguments
method Api.users()
api.viewer
to get your own user object.
Arguments
method Api.webhook_integrations()
Arguments
The entity (e.g. team name) for which to fetch integrations. If not provided, the user’s default entity will be used.
Number of integrations to fetch per page. Defaults to 50. Usually there is no reason to change this.