abacusai.eda

Module Contents

Classes

Eda

A exploratory data analysis object

class abacusai.eda.Eda(client, edaId=None, name=None, createdAt=None, projectId=None, featureGroupId=None, referenceFeatureGroupVersion=None, testFeatureGroupVersion=None, edaConfigs=None, latestEdaVersion={}, refreshSchedules={})

Bases: abacusai.return_class.AbstractApiClass

A exploratory data analysis object

Parameters:
  • client (ApiClient) – An authenticated API Client instance

  • edaId (str) – The unique identifier of the eda object.

  • name (str) – The user-friendly name for the eda object.

  • createdAt (str) – Date and time at which the eda object was created.

  • projectId (str) – The project this eda object belongs to.

  • featureGroupId (str) – Feature group ID for which eda analysis is being done.

  • referenceFeatureGroupVersion (str) – Reference Feature group version for data consistency analysis, will be latest feature group version for collinearity analysis.

  • testFeatureGroupVersion (str) – Test Feature group version for data consistency analysis, will be latest feature group version for collinearity analysis.

  • edaConfigs (dict) – Configurations for eda object.

  • latestEdaVersion (EdaVersion) – The latest eda object version.

  • refreshSchedules (RefreshSchedule) – List of refresh schedules that indicate when the next model version will be trained.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict

rerun()

Reruns the specified eda object.

Parameters:

eda_id (str) – The eda object to rerun.

Returns:

The eda object that is being rerun.

Return type:

Eda

refresh()

Calls describe and refreshes the current object’s fields

Returns:

The current object

Return type:

Eda

describe()

Retrieves a full description of the specified eda object.

Parameters:

eda_id (str) – The unique ID associated with the eda object.

Returns:

The description of the eda object.

Return type:

Eda

list_versions(limit=100, start_after_version=None)

Retrieves a list of the versions for a given eda object.

Parameters:
  • limit (int) – The max length of the list of all eda versions.

  • start_after_version (str) – The id of the version after which the list starts.

Returns:

An array of eda versions.

Return type:

EdaVersion

rename(name)

Renames a model monitor

Parameters:

name (str) – The name to apply to the model monitor

delete()

Deletes the specified eda and all its versions.

Parameters:

eda_id (str) – The ID of the eda to delete.