Skip to content
FeatureByte User Documentation
Deployment.enabled
Initializing search
ㅤ
Overview
Get Started
SDK Reference
Glossary
FeatureByte User Documentation
ㅤ
Overview
Overview
Workflow
System Architecture
Data Flows
SDK overview
Roadmap
Community
Get Started
Get Started
Installation
Tutorials
Tutorials
Overview
Quick-Start Tutorials
Quick-Start Tutorials
Feature Engineering
Reusing Features
Feature Management
Model Training
End-to-End
Deep Dive Tutorials
Deep Dive Tutorials
Data Modeling
Feature Engineering
Materializing Features
Playgrounds
Playgrounds
Credit Card
Healthcare
Connecting to your Data Warehouse
Connecting to your Data Warehouse
Databricks
Snowflake
Spark
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
Catalog
Catalog
Class Methods
Class Methods
Catalog.activate
Catalog.create
Catalog.get
Catalog.get_active
Catalog.get_by_id
Catalog.list
List
List
Catalog.list_batch_feature_tables
Catalog.list_batch_request_tables
Catalog.list_deployments
Catalog.list_entities
Catalog.list_feature_lists
Catalog.list_features
Catalog.list_historical_feature_tables
Catalog.list_observation_tables
Catalog.list_relationships
Catalog.list_tables
Get
Get
Catalog.get_batch_feature_table
Catalog.get_batch_feature_table_by_id
Catalog.get_batch_request_table
Catalog.get_batch_request_table_by_id
Catalog.get_data_source
Catalog.get_deployment
Catalog.get_deployment_by_id
Catalog.get_entity
Catalog.get_entity_by_id
Catalog.get_feature
Catalog.get_feature_by_id
Catalog.get_feature_job_setting_analysis_by_id
Catalog.get_feature_list
Catalog.get_feature_list_by_id
Catalog.get_historical_feature_table
Catalog.get_historical_feature_table_by_id
Catalog.get_observation_table
Catalog.get_observation_table_by_id
Catalog.get_relationship
Catalog.get_relationship_by_id
Catalog.get_table
Catalog.get_table_by_id
Catalog.get_view
Create
Create
Catalog.create_entity
Manage
Manage
Catalog.update_name
Info
Info
Catalog.created_at
Catalog.info
Catalog.name
Catalog.updated_at
Lineage
Lineage
Catalog.id
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.catalog_id
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.entity_ids
Table.feature_store
Table.id
Table.preview_sql
TableColumn
TableColumn
Add Metadata
Add Metadata
TableColumn.as_entity
TableColumn.update_critical_data_info
Explore
Explore
TableColumn.describe
TableColumn.preview
TableColumn.sample
Info
Info
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.id
Relationship
Relationship
Manage
Manage
Relationship.disable
Relationship.enable
Info
Info
Relationship.created_at
Relationship.info
Relationship.name
Relationship.updated_at
Lineage
Lineage
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.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
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.dtype
ViewColumn.is_datetime
ViewColumn.is_numeric
ViewColumn.name
Lineage
Lineage
ViewColumn.feature_store
ViewColumn.preview_sql
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.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.readiness
Feature.saved
Feature.updated_at
Feature.version
Lineage
Lineage
Feature.catalog_id
Feature.definition
Feature.entity_ids
Feature.feature_list_ids
Feature.feature_namespace_id
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
Create Feature Group
Create Feature Group
FeatureList.drop
Constructor
Constructor
FeatureList
Save
Save
FeatureList.save
Manage
Manage
FeatureList.as_default_version
FeatureList.create_new_version
FeatureList.delete
FeatureList.get_feature_jobs_status
FeatureList.list_versions
FeatureList.update_default_version_mode
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.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
Manage
Manage
ObservationTable.delete
ObservationTable.download
ObservationTable.to_pandas
Explore
Explore
ObservationTable.describe
ObservationTable.preview
ObservationTable.sample
Info
Info
ObservationTable.context_id
ObservationTable.created_at
ObservationTable.name
ObservationTable.updated_at
Lineage
Lineage
ObservationTable.id
HistoricalFeatureTable
HistoricalFeatureTable
Manage
Manage
HistoricalFeatureTable.delete
HistoricalFeatureTable.download
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
Serve
Serve
Deployment.compute_batch_feature_table
Deployment.get_online_serving_code
Info
Info
Deployment.enabled
Deployment.enabled
Table of contents
Description
Returns
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
Utility Classes
Utility Classes
Credential
Credential
AccessTokenCredential
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
Enums
Enums
AggFunc
DefaultVersionMode
FeatureListStatus
SourceType
StorageType
TableStatus
Cleaning Operation
Cleaning Operation
ColumnCleaningOperation
DisguisedValueImputation
MissingValueImputation
StringValueImputation
TableCleaningOperation
UnexpectedValueImputation
ValueBeyondEndpointImputation
Warehouse
Warehouse
DatabricksDetails
SnowflakeDetails
SparkDetails
RequestColumn
RequestColumn
RequestColumn.point_in_time
Utility Methods
Utility Methods
List
List
list_unsaved_features
Transform
Transform
to_timedelta
Glossary
Table of contents
Description
Returns
featurebyte.Deployment.enabled
¶
enabled
:
bool
Description
¶
Deployment enabled status
Returns
¶
bool