featurebyte.UseCase.create

create(

name: str,

target_name: str,

context_name: str,

description: Optional[str]=None,

higher_prediction_is_better: bool=True

) -> UseCase

Description

Create a new UseCase.

Parameters

• name: str
  Name of the UseCase.
  
  
• target_name: str
  target name of the UseCase.
  
  
• context_name: str
  context name of the UseCase.
  
  
• description: Optional[str]
  description of the UseCase.
  
  
• higher_prediction_is_better: bool
  default: True
  Whether higher prediction values are better. Set to True (default) for targets like revenue or conversions. Set to False for targets like churn or costs. This information is important for causal modeling.
  
  

Returns

• UseCase
  The newly created UseCase.
  
  

Examples

>>> fb.UseCase.create(
...     name="use_case_1",
...     context_name="context_1",
...     target_name="target_1",
...     description="use case description.",
... )

>>> use_case_1 = catalog.get_use_case("use_case_1")