abacusai.feature_group_version

Module Contents

Classes

FeatureGroupVersion

A materialized version of a feature group

class abacusai.feature_group_version.FeatureGroupVersion(client, featureGroupVersion=None, sql=None, sourceTables=None, createdAt=None, status=None, error=None, deployable=None, features={})

Bases: abacusai.return_class.AbstractApiClass

A materialized version of a feature group

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

  • featureGroupVersion (str) – The unique identifier for this version of feature group.

  • sql (str) – The sql definition creating this feature group.

  • sourceTables (list of string) – The source tables for this feature group.

  • createdAt (str) – The timestamp at which the feature group was created.

  • status (str) – The current status of the feature group version.

  • error (str) – Relevant error if the status is FAILED.

  • deployable (bool) – whether feature group is deployable or not.

  • features (Feature) – List of features.

__repr__(self)

Return repr(self).

to_dict(self)

Get a dict representation of the parameters in this class

Returns

The dict value representation of the class parameters

Return type

dict

export_to_file_connector(self, location, export_file_format, overwrite=False)

Export Feature group to File Connector.

Parameters
  • location (str) – Cloud file location to export to.

  • export_file_format (str) – File format to export to.

  • overwrite (bool) – If true and a file exists at this location, this process will overwrite the file.

Returns

The FeatureGroupExport instance

Return type

FeatureGroupExport

export_to_database_connector(self, database_connector_id, object_name, write_mode, database_feature_mapping, id_column=None)

Export Feature group to Database Connector.

Parameters
  • database_connector_id (str) – Database connector to export to.

  • object_name (str) – The database object to write to

  • write_mode (str) – Either INSERT or UPSERT

  • database_feature_mapping (dict) – A key/value pair JSON Object of “database connector column” -> “feature name” pairs.

  • id_column (str) – Required if mode is UPSERT. Indicates which database column should be used as the lookup key for UPSERT

Returns

The FeatureGroupExport instance

Return type

FeatureGroupExport

get_materialization_logs(self, stdout=False, stderr=False)

Returns logs for materialized feature group version.

Parameters
  • stdout (bool) – Set True to get info logs

  • stderr (bool) – Set True to get error logs

Returns

A function logs.

Return type

FunctionLogs

refresh(self)

Calls describe and refreshes the current object’s fields

Returns

The current object

Return type

FeatureGroupVersion

describe(self)

Get a specific feature group version.

Parameters

feature_group_version (str) – The unique ID associated with the feature group version.

Returns

A feature group version.

Return type

FeatureGroupVersion

wait_for_results(self, timeout=3600)

A waiting call until feature group version is created.

Parameters

timeout (int, optional) – 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. Default value given is 3600 milliseconds.

get_status(self)

Gets the status of the feature group version.

Returns

A string describing the status of a feature group version (pending, complete, etc.).

Return type

str

_get_avro_file(self, file_part)
load_as_pandas(self, max_workers=10)

Loads the feature group version into a pandas dataframe.

Parameters

max_workers (int, optional) – The number of threads.

Returns

A pandas dataframe displaying the data in the feature group version.

Return type

DataFrame