abacusai.feature_group_version
Module Contents
Classes
A materialized version of a feature group |
- class abacusai.feature_group_version.FeatureGroupVersion(client, featureGroupVersion=None, featureGroupId=None, sql=None, sourceTables=None, createdAt=None, status=None, error=None, deployable=None, cpuSize=None, memory=None, features={}, pointInTimeGroups={}, codeSource={})
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.
featureGroupId (str) –
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.
cpuSize (str) – Cpu size specified for the python feature group.
memory (int) – Memory in GB specified for the python feature group.
features (Feature) – List of features.
pointInTimeGroups (PointInTimeGroup) – List of Point In Time Groups
codeSource (CodeSource) – If a python feature group, information on the source code
- __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
- create_snapshot_feature_group(table_name)
Creates a Snapshot Feature Group corresponding to a specific feature group version.
- Parameters
table_name (str) – The name for the newly created Snapshot Feature Group table.
- Returns
Feature Group corresponding to the newly created Snapshot.
- Return type
- export_to_file_connector(location, export_file_format, overwrite=False)
Export Feature group to File Connector.
- Parameters
- Returns
The FeatureGroupExport instance
- Return type
- export_to_database_connector(database_connector_id, object_name, write_mode, database_feature_mapping, id_column=None, additional_id_columns=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
additional_id_columns (list) – For database connectors which support it, additional ID columns to use as a complex key for upserting
- Returns
The FeatureGroupExport instance
- Return type
- export_to_console(export_file_format)
Export Feature group to console.
- Parameters
export_file_format (str) – File format to export to.
- Returns
The FeatureGroupExport instance
- Return type
- get_materialization_logs(stdout=False, stderr=False)
Returns logs for materialized feature group version.
- Parameters
- Returns
A function logs.
- Return type
- refresh()
Calls describe and refreshes the current object’s fields
- Returns
The current object
- Return type
- describe()
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
- wait_for_results(timeout=3600)
A waiting call until feature group version is materialized
- 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.
- wait_for_materialization(timeout=3600)
A waiting call until feature group version is materialized.
- 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.
- get_status()
Gets the status of the feature group version.
- Returns
A string describing the status of a feature group version (pending, complete, etc.).
- Return type
- _download_avro_file(file_part, tmp_dir)