This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Import & Export API

1: Api
2: File
3: Files
4: Job
5: Project
6: Projects
7: QueuedRun
8: Run
9: RunQueue
10: Runs
11: Sweep

View the source code

Classes

class Api: Used for querying the wandb server.

class File: File is a class associated with a file saved by wandb.

class Files: An iterable collection of File objects.

class Job

class Project: A project is a namespace for runs.

class Projects: An iterable collection of Project objects.

class QueuedRun: A single queued run associated with an entity and project. Call run = queued_run.wait_until_running() or run = queued_run.wait_until_finished() to access the run.

class Run: A single run associated with an entity and project.

class RunQueue

class Runs: An iterable collection of runs associated with a project and optional filter.

class Sweep: A set of runs associated with a sweep.

1 - Api

View the source code

Used for querying the wandb server.

Api(
    overrides: Optional[Dict[str, Any]] = None,
    timeout: Optional[int] = None,
    api_key: Optional[str] = None
) -> None

Examples:

Most common way to initialize

>>> wandb.Api()

Args
`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`.

Attributes

Methods

`artifact`

View source

artifact(
    name: str,
    type: Optional[str] = None
)

Return a single artifact by parsing path in the form project/name or entity/project/name.

Args
`name`	(str) An artifact name. May be prefixed with project/ or entity/project/. If no entity is specified in the name, the Run or API setting’s entity is used. Valid names can be in the following forms: name:version name:alias
`type`	(str, optional) The type of artifact to fetch.

Returns
An `Artifact` object.

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.

Note:

This method is intended for external use only. Do not call api.artifact() within the wandb repository code.

`artifact_collection`

View source

artifact_collection(
    type_name: str,
    name: str
) -> "public.ArtifactCollection"

Return a single artifact collection by type and parsing path in the form entity/project/name.

Args
`type_name`	(str) The type of artifact collection to fetch.
`name`	(str) An artifact collection name. May be prefixed with entity/project.

Returns
An `ArtifactCollection` object.

`artifact_collection_exists`

View source

artifact_collection_exists(
    name: str,
    type: str
) -> bool

Return whether an artifact collection exists within a specified project and entity.

Args
`name`	(str) An artifact collection name. May be prefixed with entity/project. If entity or project is not specified, it will be inferred from the override params if populated. Otherwise, entity will be pulled from the user settings and project will default to `uncategorized`.
`type`	(str) The type of artifact collection

Returns
True if the artifact collection exists, False otherwise.

`artifact_collections`

View source

artifact_collections(
    project_name: str,
    type_name: str,
    per_page: Optional[int] = 50
) -> "public.ArtifactCollections"

Return a collection of matching artifact collections.

Args
`project_name`	(str) The name of the project to filter on.
`type_name`	(str) The name of the artifact type to filter on.
`per_page`	(int, optional) Sets the page size for query pagination. None will use the default size. Usually there is no reason to change this.

Returns
An iterable `ArtifactCollections` object.

`artifact_exists`

View source

artifact_exists(
    name: str,
    type: Optional[str] = None
) -> bool

Return whether an artifact version exists within a specified project and entity.

Args
`name`	(str) An artifact name. May be prefixed with entity/project. If entity or project is not specified, it will be inferred from the override params if populated. Otherwise, entity will be pulled from the user settings and project will default to `uncategorized`. Valid names can be in the following forms: `name:version name:alias`.
`type`	(str, optional) The type of artifact.

Returns
True if the artifact version exists, False otherwise.

`artifact_type`

View source

artifact_type(
    type_name: str,
    project: Optional[str] = None
) -> "public.ArtifactType"

Return the matching ArtifactType.

Args
`type_name`	(str) The name of the artifact type to retrieve.
`project`	(str, optional) If given, a project name or path to filter on.

Returns
An `ArtifactType` object.

`artifact_types`

View source

artifact_types(
    project: Optional[str] = None
) -> "public.ArtifactTypes"

Return a collection of matching artifact types.

Args
`project`	(str, optional) If given, a project name or path to filter on.

Returns
An iterable `ArtifactTypes` object.

`artifact_versions`

View source

artifact_versions(
    type_name, name, per_page=50
)

Deprecated, use artifacts(type_name, name) instead.

`artifacts`

View source

artifacts(
    type_name: str,
    name: str,
    per_page: Optional[int] = 50,
    tags: Optional[List[str]] = None
) -> "public.Artifacts"

Return an Artifacts collection from the given parameters.

Args
`type_name`	(str) The type of artifacts to fetch.
`name`	(str) An artifact collection name. May be prefixed with entity/project.
`per_page`	(int, optional) Sets the page size for query pagination. None will use the default size. Usually there is no reason to change this.
`tags`	(list[str], optional) Only return artifacts with all of these tags.

Returns
An iterable `Artifacts` object.

`create_project`

View source

create_project(
    name: str,
    entity: str
) -> None

Create a new project.

Args
`name`	(str) The name of the new project.
`entity`	(str) The entity of the new project.

`create_run`

View source

create_run(
    *,
    run_id: Optional[str] = None,
    project: Optional[str] = None,
    entity: Optional[str] = None
) -> "public.Run"

Create a new run.

Args
`run_id`	(str, optional) The ID to assign to the run, if given. The run ID is automatically generated by default, so in general, you do not need to specify this and should only do so at your own risk.
`project`	(str, optional) If given, the project of the new run.
`entity`	(str, optional) If given, the entity of the new run.

Returns
The newly created `Run`.

`create_run_queue`

View source

create_run_queue(
    name: str,
    type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None,
    config: Optional[dict] = None,
    template_variables: Optional[dict] = None
) -> "public.RunQueue"

Create a new run queue (launch).

Args
`name`	(str) Name of the queue to create.
`type`	(str) Type of resource to be used for the queue. One of `local-container`, `local-process`, `kubernetes`, `sagemaker`, or `gcp-vertex`.
`entity`	(str) Optional name of the entity to create the queue. If None, will use the configured or default entity.
`prioritization_mode`	(str) Optional version of prioritization to use. Either `V0` or `None`.
`config`	(dict) Optional default resource configuration to be used for the queue. Use handlebars (eg. `{{var}}`) to specify template variables.
`template_variables`	(dict) A dictionary of template variable schemas to be used with the config. Expected format of: `{ "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } }`.

Returns
The newly created `RunQueue`

Raises
`ValueError` if any of the parameters are invalid `wandb.Error` on wandb API errors

`create_team`

View source

create_team(
    team, admin_username=None
)

Create a new team.

Args
`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
A `Team` object

`create_user`

View source

create_user(
    email, admin=(False)
)

Create a new user.

Args
`email`	(str) The email address of the user
`admin`	(bool) Whether this user should be a global instance admin

Returns
A `User` object

`flush`

View source

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.

`from_path`

View source

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

Args
`path`	(str) The path to the project, run, sweep or report

Returns
A `Project`, `Run`, `Sweep`, or `BetaReport` instance.

Raises
`wandb.Error` if path is invalid or the object doesn’t exist

`job`

View source

job(
    name: Optional[str],
    path: Optional[str] = None
) -> "public.Job"

Return a Job from the given parameters.

Args
`name`	(str) The job name.
`path`	(str, optional) If given, the root path in which to download the job artifact.

Returns
A `Job` object.

`list_jobs`

View source

list_jobs(
    entity: str,
    project: str
) -> List[Dict[str, Any]]

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

Args
`entity`	(str) The entity for the listed jobs.
`project`	(str) The project for the listed jobs.

Returns
A list of matching jobs.

`project`

View source

project(
    name: str,
    entity: Optional[str] = None
) -> "public.Project"

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

Args
`name`	(str) The project name.
`entity`	(str) 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.

`projects`

View source

projects(
    entity: Optional[str] = None,
    per_page: Optional[int] = 200
) -> "public.Projects"

Get projects for a given entity.

Args
`entity`	(str) 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`	(int) Sets the page size for query pagination. None will use the default size. Usually there is no reason to change this.

Returns
A `Projects` object which is an iterable collection of `Project` objects.

`queued_run`

View source

queued_run(
    entity, project, queue_name, run_queue_item_id, 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.

`reports`

View source

reports(
    path: str = "",
    name: Optional[str] = None,
    per_page: Optional[int] = 50
) -> "public.Reports"

Get reports for a given project path.

WARNING: This api is in beta and will likely change in a future release

Args
`path`	(str) path to project the report resides in, should be in the form: “entity/project”
`name`	(str, optional) 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
A `Reports` object which is an iterable collection of `BetaReport` objects.

`run`

View source

run(
    path=""
)

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

Args
`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
A `Run` object.

`run_queue`

View source

run_queue(
    entity, name
)

Return the named RunQueue for entity.

To create a new RunQueue, use wandb.Api().create_run_queue(...).

`runs`

View source

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

Args
`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 oldest to newest.
`per_page`	(int) Sets the page size for query pagination.
`include_sweeps`	(bool) Whether to include the sweep runs in the results.

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

`sweep`

View source

sweep(
    path=""
)

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

Args
`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
A `Sweep` object.

`sync_tensorboard`

View source

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

Sync a local directory containing tfevent files to wandb.

`team`

View source

team(
    team: str
) -> "public.Team"

Return the matching Team with the given name.

Args
`team`	(str) The name of the team.

Returns
A `Team` object.

`upsert_run_queue`

View source

upsert_run_queue(
    name: str,
    resource_config: dict,
    resource_type: "public.RunQueueResourceType",
    entity: Optional[str] = None,
    template_variables: Optional[dict] = None,
    external_links: Optional[dict] = None,
    prioritization_mode: Optional['public.RunQueuePrioritizationMode'] = None
)

Upsert a run queue (launch).

Args
`name`	(str) Name of the queue to create.
`entity`	(str) Optional name of the entity to create the queue. If None, will use the configured or default entity.
`resource_config`	(dict) Optional default resource configuration to be used for the queue. Use handlebars (eg. `{{var}}`) to specify template variables.
`resource_type`	(str) Type of resource to be used for the queue. One of `local-container`, `local-process`, `kubernetes`, `sagemaker`, or `gcp-vertex`.
`template_variables`	(dict) A dictionary of template variable schemas to be used with the config. Expected format of: `{ "var-name": { "schema": { "type": ("string", "number", or "integer"), "default": (optional value), "minimum": (optional minimum), "maximum": (optional maximum), "enum": [..."(options)"] } } }`.
`external_links`	(dict) Optional dictionary of external links to be used with the queue. Expected format of: `{ "name": "url" }`.
`prioritization_mode`	(str) Optional version of prioritization to use. Either `V0` or `None`.

Returns
The upserted `RunQueue`.

Raises
`ValueError` if any of the parameters are invalid `wandb.Error` on wandb API errors

`user`

View source

user(
    username_or_email: str
) -> Optional['public.User']

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.

Args
`username_or_email`	(str) The username or email address of the user

Returns
A `User` object or None if a user couldn’t be found

`users`

View source

users(
    username_or_email: str
) -> List['public.User']

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.

Args
`username_or_email`	(str) The prefix or suffix of the user you want to find

Returns
An array of `User` objects

Class Variables
`CREATE_PROJECT`
`DEFAULT_ENTITY_QUERY`
`USERS_QUERY`
`VIEWER_QUERY`

2 - File

View the source code

File is a class associated with a file saved by wandb.

File(
    client, attrs, run=None
)

Attributes
`path_uri`	Returns the uri path to the file in the storage bucket.

Methods

`delete`

View source

delete()

`display`

View source

display(
    height=420, hidden=(False)
) -> bool

Display this object in jupyter.

`download`

View source

download(
    root: str = ".",
    replace: bool = (False),
    exist_ok: bool = (False),
    api: Optional[Api] = None
) -> io.TextIOWrapper

Downloads a file previously saved by a run from the wandb server.

Args
replace (boolean): If `True`, download will overwrite a local file if it exists. Defaults to `False`. root (str): Local directory to save the file. Defaults to `.`.
`exist_ok` (boolean): If `True`, will not raise ValueError if file already exists and will not re-download unless replace=True. Defaults to `False`. api (Api, optional): If given, the `Api` instance used to download the file.

Raises
`ValueError` if file already exists, replace=False and exist_ok=False.

`snake_to_camel`

View source

snake_to_camel(
    string
)

`to_html`

View source

to_html(
    *args, **kwargs
)

3 - Files

View the source code

An iterable collection of File objects.

Files(
    client, run, names=None, per_page=50, upload=(False)
)

Attributes

Methods

`convert_objects`

View source

convert_objects()

`next`

View source

next()

`update_variables`

View source

update_variables()

`getitem`

View source

__getitem__(
    index
)

`iter`

View source

__iter__()

`len`

View source

__len__()

Class Variables
`QUERY`

4 - Job

View the source code

Job(
    api: "Api",
    name,
    path: Optional[str] = None
) -> None

Attributes

Methods

`call`

View source

call(
    config, project=None, entity=None, queue=None, resource="local-container",
    resource_args=None, template_variables=None, project_queue=None, priority=None
)

`set_entrypoint`

View source

set_entrypoint(
    entrypoint: List[str]
)

5 - Project

View the source code

A project is a namespace for runs.

Project(
    client, entity, project, attrs
)

Attributes

Methods

`artifacts_types`

View source

artifacts_types(
    per_page=50
)

`display`

View source

display(
    height=420, hidden=(False)
) -> bool

Display this object in jupyter.

`snake_to_camel`

View source

snake_to_camel(
    string
)

`sweeps`

View source

sweeps()

`to_html`

View source

to_html(
    height=420, hidden=(False)
)

Generate HTML containing an iframe displaying this project.

6 - Projects

View the source code

An iterable collection of Project objects.

Projects(
    client, entity, per_page=50
)

Attributes

Methods

`convert_objects`

View source

convert_objects()

`next`

View source

next()

`update_variables`

View source

update_variables()

`getitem`

View source

__getitem__(
    index
)

`iter`

View source

__iter__()

`len`

View source

__len__()

Class Variables
`QUERY`

7 - QueuedRun

View the source code

A single queued run associated with an entity and project. Call run = queued_run.wait_until_running() or run = queued_run.wait_until_finished() to access the run.

QueuedRun(
    client, entity, project, queue_name, run_queue_item_id,
    project_queue=LAUNCH_DEFAULT_PROJECT, priority=None
)

Attributes

Methods

`delete`

View source

delete(
    delete_artifacts=(False)
)

Delete the given queued run from the wandb backend.

`wait_until_finished`

View source

wait_until_finished()

`wait_until_running`

View source

wait_until_running()

8 - Run

View the source code

A single run associated with an entity and project.

Run(
    client: "RetryingClient",
    entity: str,
    project: str,
    run_id: str,
    attrs: Optional[Mapping] = None,
    include_sweeps: bool = (True)
)

Attributes

Methods

`create`

View source

@classmethod
create(
    api, run_id=None, project=None, entity=None
)

Create a run for the given project.

`delete`

View source

delete(
    delete_artifacts=(False)
)

Delete the given run from the wandb backend.

`display`

View source

display(
    height=420, hidden=(False)
) -> bool

Display this object in jupyter.

`file`

View source

file(
    name
)

Return the path of a file with a given name in the artifact.

Args
name (str): name of requested file.

Returns
A `File` matching the name argument.

`files`

View source

files(
    names=None, per_page=50
)

Return a file path for each file named.

Args
names (list): names of the requested files, if empty returns all files per_page (int): number of results per page.

Returns
A `Files` object, which is an iterator over `File` objects.

`history`

View source

history(
    samples=500, keys=None, x_axis="_step", pandas=(True), stream="default"
)

Return sampled history metrics for a run.

This is simpler and faster if you are ok with the history records being sampled.

Args
`samples`	(int, optional) The number of samples to return
`pandas`	(bool, optional) Return a pandas dataframe
`keys`	(list, optional) Only return metrics for specific keys
`x_axis`	(str, optional) Use this metric as the xAxis defaults to _step
`stream`	(str, optional) “default” for metrics, “system” for machine metrics

Returns
`pandas.DataFrame`	If pandas=True returns a `pandas.DataFrame` of history metrics. list of dicts: If pandas=False returns a list of dicts of history metrics.

`load`

View source

load(
    force=(False)
)

`log_artifact`

View source

log_artifact(
    artifact: "wandb.Artifact",
    aliases: Optional[Collection[str]] = None,
    tags: Optional[Collection[str]] = None
)

Declare an artifact as output of a run.

Args
artifact (`Artifact`): An artifact returned from `wandb.Api().artifact(name)`. aliases (list, optional): Aliases to apply to this artifact.
`tags`	(list, optional) Tags to apply to this artifact, if any.

Returns
A `Artifact` object.

`logged_artifacts`

View source

logged_artifacts(
    per_page: int = 100
) -> public.RunArtifacts

Fetches all artifacts logged by this run.

Retrieves all output artifacts that were logged during the run. Returns a paginated result that can be iterated over or collected into a single list.

Args
`per_page`	Number of artifacts to fetch per API request.

Returns
An iterable collection of all Artifact objects logged as outputs during this run.

Example:

>>> import wandb
>>> import tempfile
>>> with tempfile.NamedTemporaryFile(
...     mode="w", delete=False, suffix=".txt"
... ) as tmp:
...     tmp.write("This is a test artifact")
...     tmp_path = tmp.name
>>> run = wandb.init(project="artifact-example")
>>> artifact = wandb.Artifact("test_artifact", type="dataset")
>>> artifact.add_file(tmp_path)
>>> run.log_artifact(artifact)
>>> run.finish()
>>> api = wandb.Api()
>>> finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
>>> for logged_artifact in finished_run.logged_artifacts():
...     print(logged_artifact.name)
test_artifact

`save`

View source

save()

`scan_history`

View source

scan_history(
    keys=None, page_size=1000, min_step=None, max_step=None
)

Returns an iterable collection of all history records for a run.

Example:

Export all the loss values for an example run

run = api.run("l2k2/examples-numpy-boston/i0wt6xua")
history = run.scan_history(keys=["Loss"])
losses = [row["Loss"] for row in history]

Args
keys ([str], optional): only fetch these keys, and only fetch rows that have all of keys defined. page_size (int, optional): size of pages to fetch from the api. min_step (int, optional): the minimum number of pages to scan at a time. max_step (int, optional): the maximum number of pages to scan at a time.

Returns
An iterable collection over history records (dict).

`snake_to_camel`

View source

snake_to_camel(
    string
)

`to_html`

View source

to_html(
    height=420, hidden=(False)
)

Generate HTML containing an iframe displaying this run.

`update`

View source

update()

Persist changes to the run object to the wandb backend.

`upload_file`

View source

upload_file(
    path, root="."
)

Upload a file.

Args
path (str): name of file to upload. root (str): the root path to save the file relative to. For example, from within `my_dir`, to save the run to `my_dir/file.txt`, set root to `../`.

Returns
A `File` matching the name argument.

`use_artifact`

View source

use_artifact(
    artifact, use_as=None
)

Declare an artifact as an input to a run.

Args
artifact (`Artifact`): An artifact returned from `wandb.Api().artifact(name)` use_as (string, optional): A string identifying how the artifact is used in the script. Used to easily differentiate artifacts used in a run, when using the beta wandb launch feature’s artifact swapping functionality.

Returns
A `Artifact` object.

`used_artifacts`

View source

used_artifacts(
    per_page: int = 100
) -> public.RunArtifacts

Fetches artifacts explicitly used by this run.

Retrieves only the input artifacts that were explicitly declared as used during the run, typically via run.use_artifact(). Returns a paginated result that can be iterated over or collected into a single list.

Args
`per_page`	Number of artifacts to fetch per API request.

Returns
An iterable collection of Artifact objects explicitly used as inputs in this run.

Example:

>>> import wandb
>>> run = wandb.init(project="artifact-example")
>>> run.use_artifact("test_artifact:latest")
>>> run.finish()
>>> api = wandb.Api()
>>> finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
>>> for used_artifact in finished_run.used_artifacts():
...     print(used_artifact.name)
test_artifact

`wait_until_finished`

View source

wait_until_finished()

9 - RunQueue

View the source code

RunQueue(
    client: "RetryingClient",
    name: str,
    entity: str,
    prioritization_mode: Optional[RunQueuePrioritizationMode] = None,
    _access: Optional[RunQueueAccessType] = None,
    _default_resource_config_id: Optional[int] = None,
    _default_resource_config: Optional[dict] = None
) -> None

Attributes
`items`	Up to the first 100 queued runs. Modifying this list will not modify the queue or any enqueued items.

Methods

`create`

View source

@classmethod
create(
    name: str,
    resource: "RunQueueResourceType",
    entity: Optional[str] = None,
    prioritization_mode: Optional['RunQueuePrioritizationMode'] = None,
    config: Optional[dict] = None,
    template_variables: Optional[dict] = None
) -> "RunQueue"

`delete`

View source

delete()

Delete the run queue from the wandb backend.

10 - Runs

View the source code

An iterable collection of runs associated with a project and optional filter.

Runs(
    client: "RetryingClient",
    entity: str,
    project: str,
    filters: Optional[Dict[str, Any]] = None,
    order: Optional[str] = None,
    per_page: int = 50,
    include_sweeps: bool = (True)
)

This is generally used indirectly via the Api.runs method.

Attributes

Methods

`convert_objects`

View source

convert_objects()

`histories`

View source

histories(
    samples: int = 500,
    keys: Optional[List[str]] = None,
    x_axis: str = "_step",
    format: Literal['default', 'pandas', 'polars'] = "default",
    stream: Literal['default', 'system'] = "default"
)

Return sampled history metrics for all runs that fit the filters conditions.

Args
`samples`	(int, optional) The number of samples to return per run
`keys`	(list[str], optional) Only return metrics for specific keys
`x_axis`	(str, optional) Use this metric as the xAxis defaults to _step
`format`	(Literal, optional) Format to return data in, options are `default`, `pandas`, `polars`
`stream`	(Literal, optional) `default` for metrics, `system` for machine metrics

Returns
`pandas.DataFrame`	If format=`"pandas"`, returns a `pandas.DataFrame` of history metrics.
`polars.DataFrame`	If format=`"polars"` returns a `polars.DataFrame` of history metrics. list of dicts: If format=`"default"`, returns a list of dicts containing history metrics with a `run_id` key.

`next`

View source

next()

`update_variables`

View source

update_variables()

`getitem`

View source

__getitem__(
    index
)

`iter`

View source

__iter__()

`len`

View source

__len__()

Class Variables
`QUERY`

11 - Sweep

View the source code

A set of runs associated with a sweep.

Sweep(
    client, entity, project, sweep_id, attrs=None
)

Examples:

Instantiate with:

api = wandb.Api()
sweep = api.sweep(path / to / sweep)

Attributes
`runs`	(`Runs`) list of runs
`id`	(str) sweep id
`project`	(str) name of project
`config`	(str) dictionary of sweep configuration
`state`	(str) the state of the sweep
`expected_run_count`	(int) number of expected runs for the sweep

Methods

`best_run`

View source

best_run(
    order=None
)

Return the best run sorted by the metric defined in config or the order passed in.

`display`

View source

display(
    height=420, hidden=(False)
) -> bool

Display this object in jupyter.

`get`

View source

@classmethod
get(
    client, entity=None, project=None, sid=None, order=None, query=None, **kwargs
)

Execute a query against the cloud backend.

`load`

View source

load(
    force: bool = (False)
)

`snake_to_camel`

View source

snake_to_camel(
    string
)

`to_html`

View source

to_html(
    height=420, hidden=(False)
)

Generate HTML containing an iframe displaying this sweep.

Class Variables
`LEGACY_QUERY`
`QUERY`