> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sdk-add-methods-properties.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Run

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/runs.py#L601" />

## <Badge color="yellow" size="lg" shape="rounded">Class</Badge> wandb.apis.public.Run

A single run associated with an entity and project.

```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
run_id: 'str',
attrs: 'Mapping | None' = None,
include_sweeps: 'bool' = False,
lazy: 'bool' = True,
api_key: 'str | None' = None)
```

## Args

<ResponseField name="service_api" type="ServiceApi">
  Interface to the wandb-core service that performs W\&B API calls for this run.
</ResponseField>

<ResponseField name="entity" type="str">
  The entity associated with the run.
</ResponseField>

<ResponseField name="project" type="str">
  The project associated with the run.
</ResponseField>

<ResponseField name="run_id" type="str">
  The unique identifier for the run.
</ResponseField>

<ResponseField name="attrs" type="Mapping | None">
  The attributes of the run.
</ResponseField>

<ResponseField name="include_sweeps" type="bool">
  Whether to include sweeps in the run.
</ResponseField>

<ResponseField name="lazy" type="bool" />

<ResponseField name="api_key" type="str | None" />

## Attributes

* `tags` (`[str]`): a list of tags associated with the run
* `url` (`str`): the url of this run
* `id` (`str`): unique identifier for the run (defaults to eight characters)
* `name` (`str`): the name of the run
* `state` (`str`): one of: running, finished, crashed, killed, preempting, preempted
* `config` (`dict`): a dict of hyperparameters associated with the run
* `created_at` (`str`): ISO timestamp when the run was started
* `system_metrics` (`dict`): the latest system metrics recorded for the run
* `summary` (`dict`): A mutable dict-like property that holds the current summary. Calling update will persist any changes.
* `project` (`str`): the project associated with the run
* `entity` (`str`): the name of the entity associated with the run
* `project_internal_id` (`int`): the internal id of the project
* `user` (`str`): the name of the user who created the run
* `path` (`str`): Unique identifier \[entity]/\[project]/\[run\_id]
* `notes` (`str`): Notes about the run
* `read_only` (`boolean`): Whether the run is editable
* `history_keys` (`str`): History metric keys logged with `wandb.Run.log({"key": "value"})`
* `metadata` (`str`): Metadata about the run from wandb-metadata.json