Feature Store APIs¶
Feature group¶
-
class
sagemaker.feature_store.feature_group.
FeatureGroup
(name: str = NOTHING, sagemaker_session: sagemaker.session.Session = <class 'sagemaker.session.Session'>, feature_definitions: Sequence[sagemaker.feature_store.feature_definition.FeatureDefinition] = NOTHING)¶ FeatureGroup definition.
This class instantiates a FeatureGroup object that comprises of a name for the FeatureGroup, session instance, and a list of feature definition objects i.e., FeatureDefinition.
-
feature_definitions
¶ list of FeatureDefinitions.
- Type
Sequence[FeatureDefinition]
Method generated by attrs for class FeatureGroup.
-
-
class
sagemaker.feature_store.feature_group.
AthenaQuery
(catalog: str, database: str, table_name: str, sagemaker_session: sagemaker.session.Session)¶ Class to manage querying of feature store data with AWS Athena.
This class instantiates a AthenaQuery object that is used to retrieve data from feature store via standard SQL queries.
Method generated by attrs for class AthenaQuery.
-
class
sagemaker.feature_store.feature_group.
IngestionManagerPandas
(feature_group_name: str, sagemaker_session: sagemaker.session.Session, data_frame: pandas.core.frame.DataFrame, max_workers: int = 1)¶ Class to manage the multi-threaded data ingestion process.
This class will manage the data ingestion process which is multi-threaded.
-
data_frame
¶ pandas DataFrame to be ingested to the given feature group.
- Type
DataFrame
Method generated by attrs for class IngestionManagerPandas.
-
Feature definition¶
-
class
sagemaker.feature_store.feature_definition.
FeatureDefinition
(feature_name: str, feature_type: sagemaker.feature_store.feature_definition.FeatureTypeEnum)¶ Feature definition.
This instantiates a Feature Definition object where FeatureDefinition is a subclass of Config.
-
feature_type
¶ The type of the feature
- Type
Method generated by attrs for class FeatureDefinition.
-
-
class
sagemaker.feature_store.feature_definition.
FractionalFeatureDefinition
(feature_name: str)¶ Fractional feature definition.
This class instantiates a FractionalFeatureDefinition object, a subclass of FeatureDefinition where the data type of the feature being defined is a Fractional.
-
feature_type
¶ A FeatureTypeEnum.FRACTIONAL type
- Type
Construct an instance of FractionalFeatureDefinition.
- Parameters
feature_name (str) – the name of the feature.
-
-
class
sagemaker.feature_store.feature_definition.
IntegralFeatureDefinition
(feature_name: str)¶ Fractional feature definition.
This class instantiates a IntegralFeatureDefinition object, a subclass of FeatureDefinition where the data type of the feature being defined is a Integral.
-
feature_type
¶ a FeatureTypeEnum.INTEGRAL type.
- Type
Construct an instance of IntegralFeatureDefinition.
- Parameters
feature_name (str) – the name of the feature.
-
-
class
sagemaker.feature_store.feature_definition.
StringFeatureDefinition
(feature_name: str)¶ Fractional feature definition.
This class instantiates a StringFeatureDefinition object, a subclass of FeatureDefinition where the data type of the feature being defined is a String.
-
feature_type
¶ a FeatureTypeEnum.STRING type.
- Type
Construct an instance of StringFeatureDefinition.
- Parameters
feature_name (str) – the name of the feature.
-
-
class
sagemaker.feature_store.feature_definition.
FeatureTypeEnum
(value)¶ Enum of feature types.
The data type of a feature can be Fractional, Integral or String.
Inputs¶
-
class
sagemaker.feature_store.inputs.
Config
¶ Base config object for FeatureStore.
Configs must implement the to_dict method.
-
class
sagemaker.feature_store.inputs.
DataCatalogConfig
(table_name: str = NOTHING, catalog: str = NOTHING, database: str = NOTHING)¶ DataCatalogConfig for FeatureStore.
Method generated by attrs for class DataCatalogConfig.
-
class
sagemaker.feature_store.inputs.
OfflineStoreConfig
(s3_storage_config: sagemaker.feature_store.inputs.S3StorageConfig, disable_glue_table_creation: bool = False, data_catalog_config: sagemaker.feature_store.inputs.DataCatalogConfig = None)¶ OfflineStoreConfig for FeatureStore.
-
s3_storage_config
¶ configuration of S3 storage.
- Type
-
data_catalog_config
¶ configuration of the data catalog.
- Type
Method generated by attrs for class OfflineStoreConfig.
-
-
class
sagemaker.feature_store.inputs.
OnlineStoreConfig
(enable_online_store: bool = True, online_store_security_config: sagemaker.feature_store.inputs.OnlineStoreSecurityConfig = None)¶ OnlineStoreConfig for FeatureStore.
-
online_store_security_config
¶ configuration of security setting.
Method generated by attrs for class OnlineStoreConfig.
-
-
class
sagemaker.feature_store.inputs.
OnlineStoreSecurityConfig
(kms_key_id: str = NOTHING)¶ OnlineStoreSecurityConfig for FeatureStore.
Method generated by attrs for class OnlineStoreSecurityConfig.