Run
The Run object is created by calling run() on a Function. Run-level parameters are provided alongside task parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| local_execution | bool | Execute the run locally instead of remotely. (Default: False) |
| inputs | dict | Mapping of function argument names to entity keys. |
| outputs | dict | Mapping of outputs. Must be in the form: |
| parameters | dict | Extra parameters passed to the function. |
Methods
Once the run is created, you can access its attributes and methods through the run object.
output
Get run's output by name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_name
|
str
|
Key of the result. |
required |
as_key
|
bool
|
If True, return result as key. |
False
|
as_dict
|
bool
|
If True, return result as dictionary. |
False
|
Returns:
| Type | Description |
|---|---|
Entity | dict | str | None
|
Result. |
outputs
Get run's outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
as_key
|
bool
|
If True, return results as keys. |
False
|
as_dict
|
bool
|
If True, return results as dictionaries. |
False
|
Returns:
| Type | Description |
|---|---|
dict
|
List of output objects. |
inputs
Get inputs passed in spec as objects or as dictionaries.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
as_dict
|
bool
|
If True, return inputs as dictionaries. |
False
|
Returns:
| Type | Description |
|---|---|
dict
|
Inputs. |