Ml Experiment

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

ml_experiment_create

ml_experiment_create(workspace_id: str, display_name: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Create a ml experiment.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the ml experiment in.	required
display_name	str	The display name of the ml experiment.	required
description	str | None	The description of the ml experiment.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

ml_experiment_get

ml_experiment_get(workspace_id: str, ml_experiment_id: str, preview: bool = True) -> requests.Response

Get a ml experiment.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the ml experiment from.	required
ml_experiment_id	str	The id of the ml experiment to get.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

ml_experiment_list

ml_experiment_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response

List ml experiments for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list data pipelines for.	required
continuation_token	str | None	A token for retrieving the next page of results.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

ml_experiment_update

ml_experiment_update(workspace_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response

Update a ml experiment.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update the ml experiment in.	required
display_name	str | None	The display name of the ml experiment.	None
description	str | None	The description of the ml experiment.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

ml_experiment_delete

ml_experiment_delete(workspace_id: str, ml_experiment_id: str, preview: bool = True) -> requests.Response

Delete a ml experiment.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete the ml experiment from.	required
ml_experiment_id	str	The id of the ml experiment to delete.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.