Documentation for Recipe and related classes
Recipe management
add_actions(actions)
Add new actions to the recipe
add_recommended_actions(recommendation)
Add actions from a recommendation
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recommendation |
_type_
|
description |
required |
apply(datasets, output_dataset_name, timeout=DEFAULT_TIMEOUT)
Apply the recipe with new input datasets
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
datasets |
dict
|
input datasets: alias <-> ID |
required |
output_dataset_name |
str
|
name of output dataset |
required |
timeout |
int
|
time to wait for the recipe to be applied. Defaults to DEFAULT_TIMEOUT. |
DEFAULT_TIMEOUT
|
Returns:
| Type | Description |
|---|---|
Dataset
|
output dataset |
commit_actions(pipeline_configuration_id=None, timeout=300)
Commit actions of the current iteration
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pipeline_configuration_id |
str
|
description. Defaults to "". |
None
|
timeout |
int
|
waiting time in seconds. Defaults to 300. |
300
|
Returns:
| Name | Type | Description |
|---|---|---|
_type_ | description |
complete(output_dataset_name, timeout=300)
Complete the recipe
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_dataset_name |
_type_
|
name of the output dataset |
required |
timeout |
int
|
waiting time in seconds. Defaults to 300. |
300
|
Raises:
| Type | Description |
|---|---|
Exception
|
description |
Returns:
| Name | Type | Description |
|---|---|---|
_type_ |
Dataset
|
description |
copy(input_datasets, name, description='')
Create a copy of the current dataset
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_datasets |
dict
|
Input datasets |
required |
name |
str
|
name of the new recipe |
required |
description |
str
|
description of the new recipe. Defaults to ''. |
''
|
Returns:
| Name | Type | Description |
|---|---|---|
Recipe |
Recipe
|
new recipe |
get_recommendations(timeout=300)
Get recommended actions
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout |
int
|
waiting time in seconds. Defaults to 300. |
300
|
Returns:
| Name | Type | Description |
|---|---|---|
_type_ | description |
set_target_columns(target_columns)
Set the target column for the recipe. This will assist the recommendation agents
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_columns |
str
|
Name of the target columns in the dataset |
required |