Metadata object representing a feature in a feature group in the Feature Store.
See Training Dataset Feature for the feature representation of training dataset schemas.
property writable #
use_fully_qualified_name: bool
Use fully qualified name for the feature when generating dataframes for training/batch data.
property writable #
type: str | None
Data type of the feature in the offline feature store.
Not a Python type
This type property is not to be confused with Python types. The type property represents the actual data type of the feature in the feature store.
property writable #
online_type: str | None
Data type of the feature in the online feature store.
property writable #
primary: bool
Whether the feature is part of the primary key of the feature group.
property writable #
foreign: bool
Whether the feature is part of the foreign key of the feature group.
property writable #
partition: bool
Whether the feature is part of the partition key of the feature group.
property writable #
hudi_precombine_key: bool
Whether the feature is part of the hudi precombine key of the feature group.
property writable #
default_value: str | None
Default value of the feature as string, if the feature was appended to the feature group.
property #
feature_group_id: int | None
ID of the feature group to which this feature belongs.
property writable #
on_demand: bool
Whether the feature is a on-demand feature computed using on-demand transformation functions.
is_complex() -> bool
Returns true if the feature has a complex type.
Example
# connect to the Feature Store
fs = ...
# get the Feature Group instance
fg = fs.get_or_create_feature_group(...)
selected_feature = fg.get_feature("min_temp")
selected_feature.is_complex()
| RETURNS | DESCRIPTION |
|---|---|
bool | True if the feature type is a complex type, False otherwise. |
Deprecated
contains is deprecated and will be removed in a future release of Hopsworks. Instead of it, consider using Feature.isin.
Construct a filter similar to SQL's IN operator.
| PARAMETER | DESCRIPTION |
|---|---|
other | A single feature value or a list of feature values. |
| RETURNS | DESCRIPTION |
|---|---|
filter.Filter | A filter that leaves only the feature values also contained in |