Share via

dataprep_utilities Module

  • Reference

Utility methods for interacting with azureml.dataprep.

Functions

dataprep_error_handler

Handle dataprep errors.

param e: The exception raised by dataprep service type: DprepException

dataprep_error_handler(e: DataPrepException) -> NoReturn

Parameters

Name Description
e
Required

get_dataprep_json

Get dataprep json.

get_dataprep_json(X: Any | None = None, y: Any | None = None, sample_weight: Any | None = None, X_valid: Any | None = None, y_valid: Any | None = None, sample_weight_valid: Any | None = None, cv_splits_indices: Any | None = None) -> str | None

Parameters

Name Description
X
<xref:azureml.dataprep.Dataflow>

Training features.

Default value: None
y
<xref:azureml.dataprep.Dataflow>

Training labels.

Default value: None
sample_weight
<xref:azureml.dataprep.Dataflow>

Sample weights for training data.

Default value: None
X_valid
<xref:azureml.dataprep.Dataflow>

validation features.

Default value: None
y_valid
<xref:azureml.dataprep.Dataflow>

validation labels.

Default value: None
sample_weight_valid
<xref:azureml.dataprep.Dataflow>

validation set sample weights.

Default value: None
cv_splits_indices
<xref:azureml.dataprep.Dataflow>

custom validation splits indices.

Default value: None

Returns

Type Description

JSON string representation of a dict of Dataflows

get_dataprep_json_dataset

Get dataprep json.

get_dataprep_json_dataset(training_data: Any | None = None, validation_data: Any | None = None, test_data: Any | None = None) -> str | None

Parameters

Name Description
training_data
<xref:azureml.dataprep.Dataflow>

Training data.

Default value: None
validation_data
<xref:azureml.dataprep.Dataflow>

Validation data

Default value: None
test_data
<xref:azureml.dataprep.Dataflow>

Test data

Default value: None

Returns

Type Description

JSON string representation of a dict of Dataflows

is_dataflow

Check if object passed is of type dataflow.

is_dataflow(dataflow: Any) -> bool

Parameters

Name Description
dataflow
Required

The value to be checked.

Returns

Type Description

True if dataflow is of type azureml.dataprep.Dataflow

load_dataflows_from_json_dict

Load dataflows from json dict.

load_dataflows_from_json_dict(dataflow_json_dict: Dict[str, Any]) -> Dict[str, Any]

Parameters

Name Description
dataprep_json
Required
str

the JSON string representation of a dict of Dataflows
dataflow_json_dict
Required

Returns

Type Description

a dict with key as dataflow name and value as dataflow, or None if JSON is malformed

save_dataflows_to_json

Save dataflows to json.

save_dataflows_to_json(dataflow_dict: Dict[str, Any]) -> str | None

Parameters

Name Description
dataflow_dict
Required
dict(str, <xref:azureml.dataprep.Dataflow>)

the dict with key as dataflow name and value as dataflow

Returns

Type Description

the JSON string representation of a dict of Dataflows