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: azureml.dataprep.api.errorhandlers.DataPrepException) -> NoReturn

Parameters

e

get_dataprep_json

Get dataprep json.

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

Parameters

X
<xref:azureml.dataprep.Dataflow>
default value: None

Training features.

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

Training labels.

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

Sample weights for training data.

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

validation features.

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

validation labels.

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

validation set sample weights.

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

custom validation splits indices.

Returns

JSON string representation of a dict of Dataflows

get_dataprep_json_dataset

Get dataprep json.

get_dataprep_json_dataset(training_data: Optional[Any] = None, validation_data: Optional[Any] = None, test_data: Optional[Any] = None) -> Optional[str]

Parameters

training_data
<xref:azureml.dataprep.Dataflow>
default value: None

Training data.

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

Validation data

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

Test data

Returns

JSON string representation of a dict of Dataflows

is_dataflow

Check if object passed is of type dataflow.

is_dataflow(dataflow: Any) -> bool

Parameters

dataflow
Required

The value to be checked.

Returns

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

dataprep_json
str
Required

the JSON string representation of a dict of Dataflows

dataflow_json_dict

Returns

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]) -> Optional[str]

Parameters

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

the dict with key as dataflow name and value as dataflow

Returns

the JSON string representation of a dict of Dataflows