Method
createEda POST
Copy POST

Run an Exploratory Data Analysis (EDA) for the specified project.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes projectId str The unique ID associated with the project.
Yes featureGroupId str The unique ID of the prediction data feature group.
Yes name str The name you want your model monitor to have. Defaults to " EDA".
No refreshSchedule str A cron-style string that describes a schedule in UTC to automatically retrain the created EDA.
No includeCollinearity bool Set to True if the EDA type is collinearity.
No includeDataConsistency bool Set to True if the EDA type is data consistency.
No collinearityKeys list List of features to use for collinearity
No primaryKeys list List of features that corresponds to the primary keys or item ids for the given feature group for Data Consistency analysis or Forecasting analysis respectively.
No dataConsistencyTestConfig dict Test feature group version selection strategy for Data Consistency EDA type.
No dataConsistencyReferenceConfig dict Reference feature group version selection strategy for Data Consistency EDA type.
No featureMappings dict A JSON map to override features for the given feature_group, where keys are column names and the values are feature data use types. (In forecasting, used to set the timestamp column and target value)
No forecastFrequency str The frequency of the data. It can be either HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result Eda
KEY TYPE Description
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.

Exceptions:

TYPE WHEN
DataNotFoundError

projectId is not found.

DataNotFoundError

featureGroupId is not found.

ConflictError

The project has validation errors.

Language:

Coming Soon!