Skip to content

FeatureByte User Documentation

UseCase.name

Initializing search

Introduction
Get Started
User Interface
SDK
SDK Reference
Concepts
Roadmap

FeatureByte User Documentation

Introduction
Get Started
Get Started
User Interface
SDK
SDK
- SDK Overview
- SDK Core Objects
SDK Reference
SDK Reference
- FeatureStore
  FeatureStore
  - Class Methods
    Class Methods
    
    FeatureStore.create
    
    FeatureStore.get
    
    FeatureStore.get_by_id
    
    FeatureStore.list
  - Get
    Get
    
    FeatureStore.get_data_source
  - Info
    Info
    
    FeatureStore.created_at
    
    FeatureStore.details
    
    FeatureStore.info
    
    FeatureStore.name
    
    FeatureStore.type
    
    FeatureStore.updated_at
  - Lineage
    Lineage
    
    FeatureStore.id
- OnlineStore
  OnlineStore
  - Class Methods
    Class Methods
    
    OnlineStore.create
    
    OnlineStore.get
    
    OnlineStore.get_by_id
    
    OnlineStore.list
  - Info
    Info
    
    OnlineStore.created_at
    
    OnlineStore.details
    
    OnlineStore.info
    
    OnlineStore.name
    
    OnlineStore.updated_at
  - Lineage
    Lineage
    
    OnlineStore.id
- Catalog
  Catalog
- DataSource
  DataSource
  - List
    List
    
    DataSource.list_databases
    
    DataSource.list_schemas
    
    DataSource.list_source_tables
  - Get
    Get
    
    DataSource.get_source_table
  - Info
    Info
    
    DataSource.type
- SourceTable
  SourceTable
  - Create Table
    Create Table
    
    SourceTable.create_batch_request_table
    
    SourceTable.create_dimension_table
    
    SourceTable.create_event_table
    
    SourceTable.create_item_table
    
    SourceTable.create_observation_table
    
    SourceTable.create_scd_table
  - Explore
    Explore
    
    SourceTable.describe
    
    SourceTable.preview
    
    SourceTable.sample
- Table
  Table
  - Class Methods
    Class Methods
    
    DimensionTable.get_by_id
    
    EventTable.get_by_id
    
    ItemTable.get_by_id
    
    SCDTable.get_by_id
  - Type
    Type
    
    DimensionTable
    
    EventTable
    
    ItemTable
    
    SCDTable
  - Get View
    Get View
    
    DimensionTable.get_view
    
    EventTable.get_view
    
    ItemTable.get_view
    
    SCDTable.get_change_view
    
    SCDTable.get_view
  - Add Metadata
    Add Metadata
    
    Table.update_record_creation_timestamp_column
  - Manage
    Manage
    
    Table.update_status
  - Set Feature Job
    Set Feature Job
    
    EventTable.create_new_feature_job_setting_analysis
    
    EventTable.initialize_default_feature_job_setting
    
    EventTable.list_feature_job_setting_analysis
    
    EventTable.update_default_feature_job_setting
  - Explore
    Explore
    
    Table.describe
    
    Table.preview
    
    Table.sample
  - Info
    Info
    
    EventTable.default_feature_job_setting
    
    ItemTable.default_feature_job_setting
    
    Table.column_cleaning_operations
    
    Table.columns
    
    Table.columns_info
    
    Table.created_at
    
    Table.dtypes
    
    Table.info
    
    Table.name
    
    Table.record_creation_timestamp_column
    
    Table.status
    
    Table.type
    
    Table.updated_at
  - Lineage
    Lineage
    
    ItemTable.event_table_id
    
    Table.catalog_id
    
    Table.entity_ids
    
    Table.feature_store
    
    Table.id
    
    Table.preview_sql
- TableColumn
  TableColumn
  - Add Metadata
    Add Metadata
    
    TableColumn.as_entity
    
    TableColumn.update_critical_data_info
    
    TableColumn.update_description
  - Manage
    Manage
    
    TableColumn.update_description
  - Explore
    Explore
    
    TableColumn.describe
    
    TableColumn.preview
    
    TableColumn.sample
  - Info
    Info
    
    TableColumn.cleaning_operations
    
    TableColumn.name
  - Lineage
    Lineage
    
    TableColumn.preview_sql
- Entity
  Entity
  - Manage
    Manage
    
    Entity.update_name
  - Info
    Info
    
    Entity.created_at
    
    Entity.info
    
    Entity.name
    
    Entity.name_history
    
    Entity.parents
    
    Entity.serving_names
    
    Entity.updated_at
  - Lineage
    Lineage
    
    Entity.catalog_id
    
    Entity.id
- Relationship
  Relationship
  - Manage
    Manage
    
    Relationship.disable
    
    Relationship.enable
  - Info
    Info
    
    Relationship.created_at
    
    Relationship.info
    
    Relationship.name
    
    Relationship.updated_at
  - Lineage
    Lineage
    
    Relationship.catalog_id
    
    Relationship.id
- View
  View
  - Type
    Type
    
    ChangeView
    
    DimensionView
    
    EventView
    
    ItemView
    
    SCDView
  - Create
    Create
    
    View.raw
  - Create Feature
    Create Feature
    
    View.as_features
    
    view.groupby
  - Create Table
    Create Table
    
    View.create_batch_request_table
    
    View.create_observation_table
  - Join
    Join
    
    EventView.add_feature
    
    ItemView.join_event_table_attributes
    
    View.join
  - Explore
    Explore
    
    View.describe
    
    View.preview
    
    View.sample
  - Info
    Info
    
    ChangeView.default_feature_job_setting
    
    ChangeView.get_default_feature_job_setting
    
    DimensionView.dimension_id_column
    
    EventView.default_feature_job_setting
    
    EventView.event_id_column
    
    ItemView.default_feature_job_setting
    
    ItemView.event_id_column
    
    ItemView.event_table_id
    
    ItemView.item_id_column
    
    SCDView.current_flag_column
    
    SCDView.effective_timestamp_column
    
    SCDView.end_timestamp_column
    
    SCDView.natural_key_column
    
    SCDView.surrogate_key_column
    
    View.column_cleaning_operations
    
    View.columns
    
    View.columns_info
    
    View.dtypes
    
    View.entity_columns
    
    View.get_join_column
    
    View.timestamp_column
  - Lineage
    Lineage
    
    View.feature_store
    
    View.preview_sql
- ViewColumn
  ViewColumn
  - Create Feature
    Create Feature
    
    ViewColumn.as_feature
  - Create Target
    Create Target
    
    ViewColumn.as_target
  - Transform
    Transform
    
    ViewColumn.abs
    
    ViewColumn.astype
    
    ViewColumn.ceil
    
    ViewColumn.dt.day
    
    ViewColumn.dt.day_of_week
    
    ViewColumn.dt.hour
    
    ViewColumn.dt.microsecond
    
    ViewColumn.dt.millisecond
    
    ViewColumn.dt.minute
    
    ViewColumn.dt.month
    
    ViewColumn.dt.quarter
    
    ViewColumn.dt.second
    
    ViewColumn.dt.tz_offset
    
    ViewColumn.dt.week
    
    ViewColumn.dt.year
    
    ViewColumn.exp
    
    ViewColumn.fillna
    
    ViewColumn.floor
    
    ViewColumn.isin
    
    ViewColumn.isnull
    
    ViewColumn.log
    
    ViewColumn.notnull
    
    ViewColumn.pow
    
    ViewColumn.sqrt
    
    ViewColumn.str.contains
    
    ViewColumn.str.len
    
    ViewColumn.str.lower
    
    ViewColumn.str.lstrip
    
    ViewColumn.str.pad
    
    ViewColumn.str.replace
    
    ViewColumn.str.rstrip
    
    ViewColumn.str.slice
    
    ViewColumn.str.strip
    
    ViewColumn.str.upper
  - Lags
    Lags
    
    ChangeViewColumn.lag
    
    EventViewColumn.lag
  - Explore
    Explore
    
    ViewColumn.describe
    
    ViewColumn.preview
    
    ViewColumn.sample
  - Info
    Info
    
    ViewColumn.cleaning_operations
    
    ViewColumn.dtype
    
    ViewColumn.is_datetime
    
    ViewColumn.is_numeric
    
    ViewColumn.name
  - Lineage
    Lineage
    
    ViewColumn.feature_store
    
    ViewColumn.preview_sql
- Context
  Context
  - Class Methods
    Class Methods
    
    Context.get
    
    Context.get_by_id
    
    Context.list
  - List
    List
    
    Context.list_observation_tables
  - Create
    Create
    
    Context.create
  - Add Metadata
    Add Metadata
    
    Context.add_observation_table
  - Save
    Save
    
    Context.save
  - Manage
    Manage
    
    Context.update_description
  - Info
    Info
    
    Context.created_at
    
    Context.name
    
    Context.primary_entities
    
    Context.updated_at
  - Lineage
    Lineage
    
    Context.default_eda_table
    
    Context.default_preview_table
    
    Context.id
    
    Context.update_default_eda_table
    
    Context.update_default_preview_table
- UseCase
  UseCase
  - Class Methods
    Class Methods
    
    UseCase.get
    
    UseCase.get_by_id
    
    UseCase.list
  - List
    List
    
    UseCase.list_deployments
    
    UseCase.list_feature_tables
    
    UseCase.list_observation_tables
  - Create
    Create
    
    UseCase.create
  - Add Metadata
    Add Metadata
    
    UseCase.add_observation_table
  - Save
    Save
    
    UseCase.save
  - Manage
    Manage
    
    UseCase.update_description
  - Info
    Info
    
    UseCase.context
    
    UseCase.created_at
    
    UseCase.info
    
    UseCase.name UseCase.name
    Table of contents
    
    Description
    
    Returns
    
    UseCase.target
    
    UseCase.updated_at
  - Lineage
    Lineage
    
    UseCase.default_eda_table
    
    UseCase.default_preview_table
    
    UseCase.id
    
    UseCase.update_default_eda_table
    
    UseCase.update_default_preview_table
- Target
  Target
  - Create
    Create
    
    TargetNamespace.create
  - Save
    Save
    
    Target.save
  - Transform
    Transform
    
    Target.abs
    
    Target.astype
    
    Target.ceil
    
    Target.dt.day
    
    Target.dt.day_of_week
    
    Target.dt.hour
    
    Target.dt.microsecond
    
    Target.dt.millisecond
    
    Target.dt.minute
    
    Target.dt.month
    
    Target.dt.quarter
    
    Target.dt.second
    
    Target.dt.tz_offset
    
    Target.dt.week
    
    Target.dt.year
    
    Target.exp
    
    Target.fillna
    
    Target.floor
    
    Target.isin
    
    Target.isnull
    
    Target.log
    
    Target.notnull
    
    Target.pow
    
    Target.sqrt
    
    Target.str.contains
    
    Target.str.len
    
    Target.str.lower
    
    Target.str.lstrip
    
    Target.str.pad
    
    Target.str.replace
    
    Target.str.rstrip
    
    Target.str.slice
    
    Target.str.strip
    
    Target.str.upper
  - Serve
    Serve
    
    Target.compute_target_table
    
    Target.compute_targets
  - Explore
    Explore
    
    Target.preview
  - Info
    Info
    
    Target.created_at
    
    Target.dtype
    
    Target.info
    
    Target.is_datetime
    
    Target.is_numeric
    
    Target.name
    
    Target.saved
    
    Target.updated_at
    
    Target.version
  - Lineage
    Lineage
    
    Target.catalog_id
    
    Target.definition
    
    Target.entity_ids
    
    Target.feature_store
    
    Target.id
    
    Target.primary_entity
- Feature
  Feature
  - Save
    Save
    
    Feature.save
  - Manage
    Manage
    
    Feature.as_default_version
    
    Feature.create_new_version
    
    Feature.delete
    
    Feature.get_feature_jobs_status
    
    Feature.list_versions
    
    Feature.update_default_version_mode
    
    Feature.update_readiness
  - Transform
    Transform
    
    Feature.abs
    
    Feature.astype
    
    Feature.cd.cosine_similarity
    
    Feature.cd.entropy
    
    Feature.cd.get_rank
    
    Feature.cd.get_relative_frequency
    
    Feature.cd.get_value
    
    Feature.cd.key_with_highest_value
    
    Feature.cd.key_with_lowest_value
    
    Feature.cd.most_frequent
    
    Feature.cd.unique_count
    
    Feature.ceil
    
    Feature.dt.day
    
    Feature.dt.day_of_week
    
    Feature.dt.hour
    
    Feature.dt.microsecond
    
    Feature.dt.millisecond
    
    Feature.dt.minute
    
    Feature.dt.month
    
    Feature.dt.quarter
    
    Feature.dt.second
    
    Feature.dt.tz_offset
    
    Feature.dt.week
    
    Feature.dt.year
    
    Feature.exp
    
    Feature.fillna
    
    Feature.floor
    
    Feature.isin
    
    Feature.isnull
    
    Feature.log
    
    Feature.notnull
    
    Feature.pow
    
    Feature.sqrt
    
    Feature.str.contains
    
    Feature.str.len
    
    Feature.str.lower
    
    Feature.str.lstrip
    
    Feature.str.pad
    
    Feature.str.replace
    
    Feature.str.rstrip
    
    Feature.str.slice
    
    Feature.str.strip
    
    Feature.str.upper
  - Explore
    Explore
    
    Feature.preview
  - Info
    Info
    
    Feature.created_at
    
    Feature.dtype
    
    Feature.info
    
    Feature.is_datetime
    
    Feature.is_default
    
    Feature.is_numeric
    
    Feature.name
    
    Feature.online_enabled
    
    Feature.readiness
    
    Feature.saved
    
    Feature.updated_at
    
    Feature.version
  - Lineage
    Lineage
    
    Feature.catalog_id
    
    Feature.definition
    
    Feature.entity_ids
    
    Feature.feature_list_ids
    
    Feature.feature_store
    
    Feature.id
    
    Feature.primary_entity
    
    Feature.sql
- FeatureGroup
  FeatureGroup
  - Constructor
    Constructor
    
    FeatureGroup
  - Save
    Save
    
    FeatureGroup.save
  - Manage
    Manage
    
    FeatureGroup.drop
  - Explore
    Explore
    
    FeatureGroup.preview
  - Info
    Info
    
    FeatureGroup.feature_names
  - Lineage
    Lineage
    
    FeatureGroup.sql
- FeatureList
  FeatureList
  - List
    List
    
    FeatureList.list_deployments
  - Create Feature Group
    Create Feature Group
    
    FeatureList.drop
  - Constructor
    Constructor
    
    FeatureList
  - Save
    Save
    
    FeatureList.save
  - Manage
    Manage
    
    FeatureList.create_new_version
    
    FeatureList.delete
    
    FeatureList.get_feature_jobs_status
    
    FeatureList.list_versions
    
    FeatureList.update_status
  - Serve
    Serve
    
    FeatureList.compute_historical_feature_table
    
    FeatureList.compute_historical_features
  - Deploy
    Deploy
    
    FeatureList.deploy
  - Explore
    Explore
    
    FeatureList.preview
  - Info
    Info
    
    FeatureList.created_at
    
    FeatureList.default_feature_fraction
    
    FeatureList.feature_names
    
    FeatureList.info
    
    FeatureList.is_default
    
    FeatureList.list_features
    
    FeatureList.name
    
    FeatureList.production_ready_fraction
    
    FeatureList.saved
    
    FeatureList.status
    
    FeatureList.updated_at
    
    FeatureList.version
  - Lineage
    Lineage
    
    FeatureList.catalog_id
    
    FeatureList.feature_ids
    
    FeatureList.id
    
    FeatureList.primary_entity
    
    FeatureList.sql
- ObservationTable
  ObservationTable
  - Create
    Create
    
    ObservationTable.upload
  - Manage
    Manage
    
    ObservationTable.delete
    
    ObservationTable.download
    
    ObservationTable.to_pandas
    
    ObservationTable.update_description
    
    ObservationTable.update_purpose
  - Explore
    Explore
    
    ObservationTable.describe
    
    ObservationTable.preview
    
    ObservationTable.sample
  - Info
    Info
    
    ObservationTable.context_id
    
    ObservationTable.created_at
    
    ObservationTable.name
    
    ObservationTable.primary_entity
    
    ObservationTable.primary_entity_ids
    
    ObservationTable.purpose
    
    ObservationTable.updated_at
    
    ObservationTable.use_case_ids
  - Lineage
    Lineage
    
    ObservationTable.id
- HistoricalFeatureTable
  HistoricalFeatureTable
  - List
    List
    
    HistoricalFeatureTable.list_deployments
  - Manage
    Manage
    
    HistoricalFeatureTable.delete
    
    HistoricalFeatureTable.download
    
    HistoricalFeatureTable.update_description
  - Explore
    Explore
    
    HistoricalFeatureTable.describe
    
    HistoricalFeatureTable.preview
    
    HistoricalFeatureTable.sample
  - Info
    Info
    
    HistoricalFeatureTable.created_at
    
    HistoricalFeatureTable.name
    
    HistoricalFeatureTable.updated_at
  - Lineage
    Lineage
    
    HistoricalFeatureTable.feature_list_id
    
    HistoricalFeatureTable.id
    
    HistoricalFeatureTable.observation_table_id
- Deployment
  Deployment
  - Class Methods
    Class Methods
    
    Deployment.get
    
    Deployment.get_by_id
    
    Deployment.list
  - Manage
    Manage
    
    Deployment.disable
    
    Deployment.enable
    
    Deployment.get_feature_jobs_status
  - Serve
    Serve
    
    Deployment.compute_batch_feature_table
    
    Deployment.get_online_serving_code
  - Info
    Info
    
    Deployment.enabled
    
    Deployment.info
    
    Deployment.name
  - Lineage
    Lineage
    
    Deployment.feature_list_id
- BatchRequestTable
  BatchRequestTable
  - Manage
    Manage
    
    BatchRequestTable.delete
    
    BatchRequestTable.download
    
    BatchRequestTable.to_pandas
  - Explore
    Explore
    
    BatchRequestTable.describe
    
    BatchRequestTable.preview
    
    BatchRequestTable.sample
  - Info
    Info
    
    BatchRequestTable.context_id
    
    BatchRequestTable.created_at
    
    BatchRequestTable.name
    
    BatchRequestTable.updated_at
  - Lineage
    Lineage
    
    BatchRequestTable.id
- BatchFeatureTable
  BatchFeatureTable
  - Manage
    Manage
    
    BatchFeatureTable.delete
    
    BatchFeatureTable.download
  - Explore
    Explore
    
    BatchFeatureTable.describe
    
    BatchFeatureTable.preview
    
    BatchFeatureTable.sample
  - Info
    Info
    
    BatchFeatureTable.created_at
    
    BatchFeatureTable.name
    
    BatchFeatureTable.updated_at
  - Lineage
    Lineage
    
    BatchFeatureTable.batch_request_table_id
    
    BatchFeatureTable.deployment_id
    
    BatchFeatureTable.id
- UserDefinedFunction
  UserDefinedFunction
  - Class Methods
    Class Methods
    
    UserDefinedFunction.create
    
    UserDefinedFunction.get
  - Manage
    Manage
    
    UserDefinedFunction.delete
    
    UserDefinedFunction.update_function_parameters
    
    UserDefinedFunction.update_output_dtype
    
    UserDefinedFunction.update_sql_function_name
  - Info
    Info
    
    UserDefinedFunction.created_at
    
    UserDefinedFunction.function_parameters
    
    UserDefinedFunction.info
    
    UserDefinedFunction.is_global
    
    UserDefinedFunction.name
    
    UserDefinedFunction.output_dtype
    
    UserDefinedFunction.signature
    
    UserDefinedFunction.sql_function_name
- Utility Classes
  Utility Classes
  - Feature Store Details
    Feature Store Details
    
    DatabricksDetails
    
    DatabricksUnityDetails
    
    SnowflakeDetails
    
    SparkDetails
  - Online Store Details
    Online Store Details
    
    MySQLOnlineStoreDetails
    
    RedisOnlineStoreDetails
  - Credential
    
    Credential
    
    AccessTokenCredential
    
    AzureBlobStorageCredential
    
    GCSStorageCredential
    
    S3StorageCredential
    
    UsernamePasswordCredential
  - Feature
    Feature
    
    FeatureVersionInfo
  - Feature Job Setting
    Feature Job Setting
    
    FeatureJobSetting
    
    FeatureJobSettingAnalysis
    
    FeatureJobSettingAnalysis.backtest
    
    FeatureJobSettingAnalysis.display_report
    
    FeatureJobSettingAnalysis.download_report
    
    FeatureJobSettingAnalysis.get_by_id
    
    FeatureJobSettingAnalysis.get_recommendation
    
    FeatureJobSettingAnalysis.info
    
    TableFeatureJobSetting
  - Groupby
    Groupby
    
    view.GroupBy
    
    view.GroupBy.aggregate
    
    view.GroupBy.aggregate_asat
    
    view.GroupBy.aggregate_over
    
    view.GroupBy.forward_aggregate
    
    view.GroupBy.forward_aggregate_asat
  - Enums
    Enums
    
    AggFunc
    
    DefaultVersionMode
    
    FeatureListStatus
    
    Purpose
    
    SourceType
    
    StorageType
    
    TableStatus
    
    enum.DBVarType
  - Cleaning Operation
    Cleaning Operation
    
    ColumnCleaningOperation
    
    DisguisedValueImputation
    
    MissingValueImputation
    
    StringValueImputation
    
    TableCleaningOperation
    
    UnexpectedValueImputation
    
    ValueBeyondEndpointImputation
  - RequestColumn
    RequestColumn
    
    RequestColumn.point_in_time
  - UserDefinedFunction
    UserDefinedFunction
    
    FunctionParameter
- Utility Methods
  Utility Methods
  - List
    List
    
    list_deployments
    
    list_unsaved_features
  - Transform
    Transform
    
    haversine
    
    to_timedelta
Concepts
Roadmap
Roadmap
- Roadmap
- Changelog

Table of contents

Description
Returns

featurebyte.UseCase.name¶

name: Optional[NameStr]

Description¶

Returns the name of the UseCase object.

Returns¶

Optional[NameStr]

Previous UseCase.info

Next UseCase.target

Copyright © 2023 FeatureByte Inc.

Made with Material for MkDocs