Skip to content

featurebyte.FeatureList.info

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

Description

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

  • name: The name of the FeatureList object.
  • description: The description of the FeatureList object.
  • namespace_description: The namespace description of the FeatureList object.
  • created_at: The timestamp indicating when the FeatureList object was created.
  • updated_at: The timestamp indicating when the FeatureList object was last updated.
  • primary_entity: Details about the primary entity of the FeatureList object.
  • entities: List of entities involved in the computation of the features contained in the FeatureList object.
  • tables: List of tables involved in the computation of the features contained in the FeatureList object.
  • version_count: The number of versions with the same feature list namespace.
  • catalog_name: The catalog name of the FeatureList object.
  • status: The status of the FeatureList object.
  • feature_count: The number of features contained in the FeatureList object.
  • dtype_distribution: The number of features per data type.
  • deployed: Indicates whether the FeatureList object is deployed
  • serving_endpoint: The URL for a deployed FeatureList for online serving of features.

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

  • version: The version name.
  • production_ready_fraction: The percentage of features that are production-ready.
  • default_feature_fraction: The percentage of features that are default features.

This method is only available for FeatureList 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_list = catalog.get_feature_list("invoice_feature_list")
>>> info = feature_list.info()
>>> del info["created_at"]
>>> del info["updated_at"]
>>> info
{
  'name': 'invoice_feature_list',
  'description': None,
  'entities': [
    {
      'name': 'grocerycustomer',
      'serving_names': [
        'GROCERYCUSTOMERGUID'
      ],
      'catalog_name': 'grocery'
    }
  ],
  'primary_entity': [
    {
      'name': 'grocerycustomer',
      'serving_names': [
        'GROCERYCUSTOMERGUID'
      ],
      'catalog_name': 'grocery'
    }
  ],
  'tables': [
    {
      'name': 'GROCERYINVOICE',
      'status': 'PUBLIC_DRAFT',
      'catalog_name': 'grocery'
    }
  ],
  'version_count': 3,
  'catalog_name': 'grocery',
  'dtype_distribution': [
    {
      'dtype': 'FLOAT',
      'count': 1
    }
  ],
  'default_feature_list_id': ...,
  'status': 'DRAFT',
  'feature_count': 1,
  'version': {
    'this': ...,
    'default': ...
  },
  'production_ready_fraction': {
    'this': 1.0,
    'default': 1.0
  },
  'default_feature_fraction': {
    'this': 1.0,
    'default': 1.0
  },
  'versions_info': None,
  'deployed': False,
  'namespace_description': None
}