abacusai.refresh_pipeline_run

Classes

RefreshPolicy

A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated.

AbstractApiClass

RefreshPipelineRun

This keeps track of the overall status of a refresh. A refresh can span multiple resources such as the creation of new dataset versions and the training of a new model version based on them.

Module Contents

class abacusai.refresh_pipeline_run.RefreshPolicy(client, refreshPolicyId=None, name=None, cron=None, nextRunTime=None, createdAt=None, refreshType=None, projectId=None, datasetIds=None, featureGroupId=None, modelIds=None, deploymentIds=None, batchPredictionIds=None, modelMonitorIds=None, notebookId=None, paused=None, predictionOperatorId=None, pipelineId=None, featureGroupExportConfig={})

Bases: abacusai.return_class.AbstractApiClass

A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated.

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • refreshPolicyId (str) – The unique identifier for the refresh policy

  • name (str) – The user-friendly name for the refresh policy

  • cron (str) – A cron-style string that describes when this refresh policy is to be executed in UTC

  • nextRunTime (str) – The next UTC time that this refresh policy will be executed

  • createdAt (str) – The time when the refresh policy was created

  • refreshType (str) – The type of refresh policy to be run

  • projectId (str) – The unique identifier of a project that this refresh policy applies to

  • datasetIds (list[str]) – Comma-separated list of Dataset IDs that this refresh policy applies to

  • featureGroupId (str) – Feature Group ID that this refresh policy applies to

  • modelIds (list[str]) – Comma-separated list of Model IDs that this refresh policy applies to

  • deploymentIds (list[str]) – Comma-separated list of Deployment IDs that this refresh policy applies to

  • batchPredictionIds (list[str]) – Comma-separated list of Batch Prediction IDs that this refresh policy applies to

  • modelMonitorIds (list[str]) – Comma-separated list of Model Monitor IDs that this refresh policy applies to

  • notebookId (str) – Notebook ID that this refresh policy applies to

  • paused (bool) – True if the refresh policy is paused

  • predictionOperatorId (str) – Prediction Operator ID that this refresh policy applies to

  • pipelineId (str) – The Pipeline ID With The Cron Schedule

  • featureGroupExportConfig (FeatureGroupRefreshExportConfig) – The export configuration for the feature group. Only applicable if refresh_type is FEATUREGROUP.

__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

delete()

Delete a refresh policy.

Parameters:

refresh_policy_id (str) – Unique string identifier associated with the refresh policy to delete.

refresh()

Calls describe and refreshes the current object’s fields

Returns:

The current object

Return type:

RefreshPolicy

describe()

Retrieve a single refresh policy

Parameters:

refresh_policy_id (str) – The unique ID associated with this refresh policy.

Returns:

An object representing the refresh policy.

Return type:

RefreshPolicy

list_refresh_pipeline_runs()

List the the times that the refresh policy has been run

Parameters:

refresh_policy_id (str) – Unique identifier associated with the refresh policy.

Returns:

List of refresh pipeline runs for the given refresh policy ID.

Return type:

list[RefreshPipelineRun]

pause()

Pauses a refresh policy

Parameters:

refresh_policy_id (str) – Unique identifier associated with the refresh policy to be paused.

resume()

Resumes a refresh policy

Parameters:

refresh_policy_id (str) – The unique ID associated with this refresh policy.

run()

Force a run of the refresh policy.

Parameters:

refresh_policy_id (str) – Unique string identifier associated with the refresh policy to be run.

update(name=None, cron=None, feature_group_export_config=None)

Update the name or cron string of a refresh policy

Parameters:

  • name (str) – Name of the refresh policy to be updated.

  • cron (str) – Cron string describing the schedule from the refresh policy to be updated.

  • feature_group_export_config (FeatureGroupExportConfig) – Feature group export configuration to update a feature group refresh policy.

Returns:

Updated refresh policy.

Return type:

RefreshPolicy

class abacusai.refresh_pipeline_run.AbstractApiClass(client, id)
__eq__(other)

Return self==value.

_get_attribute_as_dict(attribute)
class abacusai.refresh_pipeline_run.RefreshPipelineRun(client, refreshPipelineRunId=None, refreshPolicyId=None, createdAt=None, startedAt=None, completedAt=None, status=None, refreshType=None, datasetVersions=None, featureGroupVersion=None, modelVersions=None, deploymentVersions=None, batchPredictions=None, refreshPolicy={})

Bases: abacusai.return_class.AbstractApiClass

This keeps track of the overall status of a refresh. A refresh can span multiple resources such as the creation of new dataset versions and the training of a new model version based on them.

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • refreshPipelineRunId (str) – The unique identifier for the refresh pipeline run.

  • refreshPolicyId (str) – Populated when the run was triggered by a refresh policy.

  • createdAt (str) – The time when this refresh pipeline run was created, in ISO-8601 format.

  • startedAt (str) – The time when the refresh pipeline run was started, in ISO-8601 format.

  • completedAt (str) – The time when the refresh pipeline run was completed, in ISO-8601 format.

  • status (str) – The status of the refresh pipeline run.

  • refreshType (str) – The type of refresh policy to be run.

  • datasetVersions (list[str]) – A list of dataset version IDs that this refresh pipeline run is monitoring.

  • featureGroupVersion (str) – The feature group version ID that this refresh pipeline run is monitoring.

  • modelVersions (list[str]) – A list of model version IDs that this refresh pipeline run is monitoring.

  • deploymentVersions (list[str]) – A list of deployment version IDs that this refresh pipeline run is monitoring.

  • batchPredictions (list[str]) – A list of batch prediction IDs that this refresh pipeline run is monitoring.

  • refreshPolicy (RefreshPolicy) – The refresh policy for this refresh policy run.

__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

refresh()

Calls describe and refreshes the current object’s fields

Returns:

The current object

Return type:

RefreshPipelineRun

describe()

Retrieve a single refresh pipeline run

Parameters:

refresh_pipeline_run_id (str) – Unique string identifier associated with the refresh pipeline run.

Returns:

A refresh pipeline run object.

Return type:

RefreshPipelineRun

wait_for_complete(timeout=None)

A waiting call until refresh pipeline run has completed.

Parameters:

timeout (int) – The waiting time given to the call to finish, if it doesn’t finish by the allocated time, the call is said to be timed out.

get_status()

Gets the status of the refresh pipeline run.

Returns:

A string describing the status of a refresh pipeline run (pending, complete, etc.).

Return type:

str