Documentation
English
Search…
⌃K

wandb.apis.public.Api

Used for querying the wandb server.
Api(
overrides=None,
timeout: Optional[int] = None,
api_key: Optional[str] = None
) -> None

Examples:

Most common way to initialize
>>> wandb.Api()
Arguments
Text
overrides
(dict) You can set base_url if you are using a wandb server other than https://api.wandb.ai. You can also set defaults for entity, project, and run.

Methods

artifact

artifact(
name, type=None
)
Returns a single artifact by parsing path in the form entity/project/run_id.
Arguments
Text
name
(str) An artifact name. May be prefixed with entity/project. Valid names can be in the following forms: name:version name:alias digest
type
(str, optional) The type of artifact to fetch.
Returns
Text
A Artifact object.

artifact_type

artifact_type(
type_name, project=None
)

artifact_types

artifact_types(
project=None
)

artifact_versions

artifact_versions(
type_name, name, per_page=50
)

create_report

create_report(
project: str,
entity: str = "",
title: Optional[str] = "Untitled Report",
description: Optional[str] = "",
width: Optional[str] = "readable",
blocks: "Optional[wandb.apis.reports.util.Block]" = None
) -> "wandb.apis.reports.Report"

create_run

create_run(
**kwargs
)
Create a new run

create_team

create_team(
team, admin_username=None
)
Creates a new team
Arguments
Text
team
(str) The name of the team
admin_username
(str) optional username of the admin user of the team, defaults to the current user.
Returns
Text
A Team object

create_user

create_user(
email, admin=(False)
)
Creates a new user
Arguments
Text
email
(str) The name of the team
admin
(bool) Whether this user should be a global instance admin
Returns
Text
A User object

flush

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

from_path

from_path(
path
)
Return a run, sweep, project or report from a path

Examples:

project = api.from_path("my_project")
team_project = api.from_path("my_team/my_project")
run = api.from_path("my_team/my_project/runs/id")
sweep = api.from_path("my_team/my_project/sweeps/id")
report = api.from_path("my_team/my_project/reports/My-Report-Vm11dsdf")
Arguments
Text
path
(str) The path to the project, run, sweep or report
Returns
Text
A Project, Run, Sweep, or BetaReport instance.
Raises
Text
wandb.Error if path is invalid or the object doesn't exist

job

job(
name, path=None
)

load_report

load_report(
path: str
) -> "wandb.apis.reports.Report"
Get report at a given path.
Arguments
Text
path
(str) Path to the target report in the form entity/project/reports/reportId. You can get this by copy-pasting the URL after your wandb url. For example: megatruong/report-editing/reports/My-fabulous-report-title--VmlldzoxOTc1Njk0
Returns
Text
A BetaReport object which represents the report at path
Raises
Text
wandb.Error if path is invalid

project

project(
name, entity=None
)

projects

projects(
entity=None, per_page=200
)
Get projects for a given entity.
Arguments
Text
entity
(str) Name of the entity requested. If None, will fall back to default entity passed to Api. If no default entity, will raise a ValueError.
per_page
(int) Sets the page size for query pagination. None will use the default size. Usually there is no reason to change this.
Returns
Text
A Projects object which is an iterable collection of Project objects.

queued_run

queued_run(
entity, project, queue_name, run_queue_item_id, container_job=(False)
)
Returns a single queued run by parsing the path in the form entity/project/queue_id/run_queue_item_id

reports

reports(
path="", name=None, per_page=50
)
Get reports for a given project path.
WARNING: This api is in beta and will likely change in a future release
Arguments
Text
path
(str) path to project the report resides in, should be in the form: "entity/project"
name
(str) optional name of the report requested.
per_page
(int) Sets the page size for query pagination. None will use the default size. Usually there is no reason to change this.
Returns
Text
A Reports object which is an iterable collection of BetaReport objects.

run

run(
path=""
)
Returns a single run by parsing path in the form entity/project/run_id.
Arguments
Text
path
(str) 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
Text
A Run object.

runs

runs(
path: Optional[str] = None,
filters: Optional[Dict[str, Any]] = None,
order: str = "-created_at",
per_page: int = 50,
include_sweeps: bool = (True)
)
Return a set of runs from a project that match the filters provided.
You can filter by config.*, summary_metrics.*, tags, state, entity, createdAt, etc.

Examples:

Find runs in my_project where config.experiment_name has been set to "foo"
api.runs(path="my_entity/my_project", filters={"config.experiment_name": "foo"})
Find runs in my_project where config.experiment_name has been set to "foo" or "bar"
api.runs(
path="my_entity/my_project",
filters={"$or": [{"config.experiment_name": "foo"}, {"config.experiment_name": "bar"}]}
)
Find runs in my_project where config.experiment_name matches a regex (anchors are not supported)
api.runs(
path="my_entity/my_project",
filters={"config.experiment_name": {"$regex": "b.*"}}
)
Find runs in my_project where the run name matches a regex (anchors are not supported)
api.runs(
path="my_entity/my_project",
filters={"display_name": {"$regex": "^foo.*"}}
)
Find runs in my_project sorted by ascending loss
api.runs(path="my_entity/my_project", order="+summary_metrics.loss")
Arguments
Text
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" You can compose operations to make more complicated queries, see Reference for the language is at https://docs.mongodb.com/manual/reference/operator/query
order
(str) Order can be created_at, heartbeat_at, config.*.value, or summary_metrics.*. If you prepend order with a + order is ascending. If you prepend order with a - order is descending (default). The default order is run.created_at from newest to oldest.
Returns
Text
A Runs object, which is an iterable collection of Run objects.

sweep

sweep(
path=""
)
Returns a sweep by parsing path in the form entity/project/sweep_id.
Arguments
Text
path
(str, optional) 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
Text
A Sweep object.

sync_tensorboard

sync_tensorboard(
root_dir, run_id=None, project=None, entity=None
)
Sync a local directory containing tfevent files to wandb

team

team(
team
)

user

user(
username_or_email
)
Return a user from a username or email address
Note: This function only works for Local Admins, if you are trying to get your own user object, please use api.viewer.
Arguments
Text
username_or_email
(str) The username or email address of the user
Returns
Text
A User object or None if a user couldn't be found

users

users(
username_or_email
)
Return all users from a partial username or email address query
Note: This function only works for Local Admins, if you are trying to get your own user object, please use api.viewer.
Arguments
Text
username_or_email
(str) The prefix or suffix of the user you want to find
Returns
Text
An array of User objects
Class Variables
Text
USERS_QUERY
VIEWER_QUERY
VIEW_REPORT_QUERY