DatasetProfile Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

A DatasetProfile collects summary statistics on the data produced by a Dataflow.

Create DatasetProfile object.

Constructor

DatasetProfile(saved_dataset_id, run_id, experiment_name, workspace, profile)

Name	Description
saved_dataset_id Required	str The id of the dataset on which profile is computed.
run_id Required	str The run id for the experiment which is used to compute the profile.
experiment_name Required	str The name of the submitted experiment used to compute the profile.
workspace Required	Workspace Workspace which the profile run belongs to. See https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.workspace.workspace for more information on workspaces.
profile Required	<xref:azureml.dataprep.DataProfile> Profile result from the latest profile run of type DataProfile.
saved_dataset_id Required	str The id of the dataset on which profile is computed.
run_id Required	str The run id for the experiment which is used to compute the profile.
experiment_name Required	str The name of the submitted experiment used to compute the profile.
workspace Required	Workspace Workspace which the profile run belongs to. See https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.workspace.workspace for more information on workspaces.
profile Required	<xref:azureml.dataprep.DataProfile> Profile result from the latest profile run of type DataProfile.

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Return the experiment Run object of type Run that produced this profile.

is_stale

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Return boolean to describe whether the computed profile is stale or not.

A Profile is considered to be stale if there is changed in underlying data after the profile is computed.

if the data source change cannot be detected, TypeError is raised.
if the data source was changed after submitting the profile run, the flag will be True;
otherwise, the profile matches current data, and the flag will be False.

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Return the experiment Run object of type Run that produced this profile.

get_producing_run()

Type	Description
Run	The submitted experiment run for this profile run. See https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.run(class for more information on run.

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Return boolean to describe whether the computed profile is stale or not.

A Profile is considered to be stale if there is changed in underlying data after the profile is computed.

if the data source change cannot be detected, TypeError is raised.
if the data source was changed after submitting the profile run, the flag will be True;
otherwise, the profile matches current data, and the flag will be False.

is_stale()

Type	Description
bool	boolean to describe whether the computed profile is stale or not.