Skip to content

featurebyte.Feature.info

info(
verbose: bool=False
) -> Dict[str, Any]

Description

Returns a dictionary that summarizes the essential information of an Feature object. The dictionary contains the following keys:

  • created_at: The timestamp indicating when the Feature object was created.
  • name: The name of the Feature object.
  • updated_at: The timestamp indicating when the Feature object was last updated.
  • catalog_name: The catalog name of the Feature object.
  • primary_entity: Details about the primary entity of the Feature object.
  • entities: List of entities involved in the computation of the Feature object.
  • primary_table: Details about the primary table of the Feature object.
  • tables: List of tables involved in the computation of the Feature object.
  • default_version_mode: Indicates whether the default version mode is 'auto' or 'manual'.
  • version_count: The number of versions with the same feature namespace.
  • dtype: the data type of the Feature object.
  • default_feature_id: The unique identifier of the default version with the same feature namespace. This is the version returned by the catalog when only the object's feature namespace is used.
  • metadata: Summary of key operations.

Some information is provided for both the Feature object and the default version with the same feature namespace:

  • version: The version name.
  • readiness: The readiness state.
  • table_feature_job_setting: Details of the Feature Job setting of tables used by the feature.
  • table_cleaning_operation: Details of cleaning operations of table columns used by the feature.

This method is only available for Feature objects that are saved in the catalog.

Parameters

  • verbose: bool
    default: False
    Control verbose level of the summary.

Returns

  • Dict[str, Any]
    Key-value mapping of properties of the object.

Examples

>>> feature = catalog.get_feature("InvoiceCount_60days")
>>> feature.info()