Skip to content

featurebyte.UseCase.info

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

Description

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

  • author: The name of the user who created the UseCase object.
  • name: The name of the UseCase object.
  • created_at: The timestamp indicating when the UseCase object was created.
  • updated_at: The timestamp indicating when the UseCase object was last updated.
  • primary_entities: List of primary entities of the use case.
  • description: Description of the use case.
  • default_eda_table: Default eda table of the use case.
  • default_preview_table: Default preview table of the use case.

Parameters

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

Returns

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

Examples

>>> use_case = catalog.get_target("use_case")
>>> info = use_case.info()