Skip to content

Create a run

Runs are normally created by calling run() on a Function or Workflow. Use new_run() for direct run creation; the kind and specification parameters depend on the runtime.

new_run

Create a new run entity in the backend.

Parameters:

Name Type Description Default
project str

Project name.

required
kind str

Entity kind.

required
uuid str

Entity identifier.

None
name str

Entity name.

None
labels list[str]

Entity labels.

None
task str

Task reference associated with the run.

None
**kwargs dict

Additional entity specification parameters.

{}

Returns:

Type Description
Run

Created run entity.

Examples:

Create a run directly:

import digitalhub as dh

run = dh.new_run(
    project="my-project",
    kind="python+run",
    task="task-string",
)