> For the complete documentation index, see [llms.txt](https://arig23498.gitbook.io/aritra-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://arig23498.gitbook.io/aritra-documentation/ref/python/public-api/api.md).

# wandb.apis.public.Api

[![](https://www.tensorflow.org/images/GitHub-Mark-32px.png)View source on GitHub](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L191-L560)

Used for querying the wandb server.

```python
Api(
    overrides={}
)
```

#### Examples:

Most common way to initialize

```
>>> wandb.Api()
```

| Arguments   |                                                                                                                                                                |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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` <a href="#artifact" id="artifact"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L539-L560)

```python
artifact(
    name, type=None
)
```

Returns a single artifact by parsing path in the form `entity/project/run_id`.

| Arguments |                                                                                                                                        |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `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              |   |
| -------------------- | - |
| A `Artifact` object. |   |

### `artifact_type` <a href="#artifact_type" id="artifact_type"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L528-L531)

```python
artifact_type(
    type_name, project=None
)
```

### `artifact_types` <a href="#artifact_types" id="artifact_types"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L523-L526)

```python
artifact_types(
    project=None
)
```

### `artifact_versions` <a href="#artifact_versions" id="artifact_versions"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L533-L537)

```python
artifact_versions(
    type_name, name, per_page=50
)
```

### `create_run` <a href="#create_run" id="create_run"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L253-L257)

```python
create_run(
    **kwargs
)
```

Create a new run

### `flush` <a href="#flush" id="flush"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L308-L314)

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

### `projects` <a href="#projects" id="projects"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L371-L393)

```python
projects(
    entity=None, per_page=200
)
```

Get projects for a given entity.

| Arguments  |                                                                                                                                               |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity`   | (str) Name of the entity requested. If None will fallback 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                                                                   |   |
| ------------------------------------------------------------------------- | - |
| A `Projects` object which is an iterable collection of `Project` objects. |   |

### `reports` <a href="#reports" id="reports"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L395-L426)

```python
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  |                                                                                                                           |
| ---------- | ------------------------------------------------------------------------------------------------------------------------- |
| `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                                                                     |   |
| --------------------------------------------------------------------------- | - |
| A `Reports` object which is an iterable collection of `BetaReport` objects. |   |

### `run` <a href="#run" id="run"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L487-L503)

```python
run(
    path=""
)
```

Returns a single run by parsing path in the form entity/project/run\_id.

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

### `runs` <a href="#runs" id="runs"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L428-L485)

```python
runs(
    path="", filters=None, order="-created_at", per_page=50
)
```

Return a set of runs from a project that match the filters provided.

You can filter by `config.*`, `summary.*`, `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 sorted by ascending loss

```
api.runs(path="my_entity/my_project", order="+summary_metrics.loss")
```

| 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" 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                                                            |   |
| ------------------------------------------------------------------ | - |
| A `Runs` object, which is an iterable collection of `Run` objects. |   |

### `sweep` <a href="#sweep" id="sweep"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L505-L521)

```python
sweep(
    path=""
)
```

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

| Arguments |                                                                                                                                                                                                 |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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` <a href="#sync_tensorboard" id="sync_tensorboard"></a>

[View source](https://www.github.com/wandb/client/tree/v0.10.31.dev1/wandb/apis/public.py#L259-L280)

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

Sync a local directory containing tfevent files to wandb

| Class Variables |   |
| --------------- | - |
| VIEWER\_QUERY   |   |