> For the complete documentation index, see [llms.txt](https://docs.dbnl.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dbnl.com/v0.21.x/using-distributional/python-sdk/sdk-functions/run/create_run.md).

# create\_run

<pre class="language-python"><code class="lang-python">dbnl.create_run(
    *,
    project: <a data-footnote-ref href="#user-content-fn-1">Project</a>,
    run_config: <a data-footnote-ref href="#user-content-fn-2">RunConfig</a>,
    display_name: Optional[str] = None,
    metadata: Optional[Dict[str, str]] = None,
) -> <a data-footnote-ref href="#user-content-fn-3">Run</a>:
</code></pre>

## Parameters

<table><thead><tr><th width="233">Arguments</th><th>Description</th></tr></thead><tbody><tr><td><code>project</code></td><td>The dbnl <a href="/pages/vfXFauh5ZnUjluqFCP7i">Project</a> that this Run will be associated with.</td></tr><tr><td><code>run_config</code></td><td>The dbnl <a href="/pages/HIhELmSZ1QDDyatoPYAM">RunConfig</a> that this Run will be associated with. Two Runs with the same RunConfig can be compared in the web UI and associated in Tests. The associated RunConfig must be from the same Project.</td></tr><tr><td><code>display_name</code></td><td>An optional display name for the Run. Display names do not have to be unique.</td></tr><tr><td><code>metadata</code></td><td>Any additional key-value pairs information the user wants to track.</td></tr></tbody></table>

## Returns

<table><thead><tr><th width="190">Type</th><th>Description</th></tr></thead><tbody><tr><td><a href="/pages/QtYyvw16aMflnd2CNWFJ">Run</a></td><td>A new dbnl <a href="/pages/QtYyvw16aMflnd2CNWFJ">Run</a> for <a href="/pages/DFWWot1PWlBd73ULt88p">reporting results</a>.</td></tr></tbody></table>

## Examples

```python
import dbnl
dbnl.login()


proj1 = dbnl.get_or_create_project(name="test_p1")
runcfg1 = dbnl.create_run_config(project=proj1, columns=[{"name": "error", "type": "float"}])

run1 = dbnl.create_run(
    project=proj1, 
    run_config=runcfg1, 
    metadata={"mode": "dev"},
)
```

[^1]: [Project](/v0.21.x/using-distributional/python-sdk/sdk-objects/project.md)

[^2]: [RunConfig](/v0.21.x/using-distributional/python-sdk/sdk-objects/runconfig.md)

[^3]: [Run](/v0.21.x/using-distributional/python-sdk/sdk-objects/run.md)