diff --git a/sdk/python/docs/source/feast.api.registry.rest.rst b/sdk/python/docs/source/feast.api.registry.rest.rst index af69e22dd41..aa98ce69169 100644 --- a/sdk/python/docs/source/feast.api.registry.rest.rst +++ b/sdk/python/docs/source/feast.api.registry.rest.rst @@ -4,6 +4,14 @@ feast.api.registry.rest package Submodules ---------- +feast.api.registry.rest.codegen\_utils module +--------------------------------------------- + +.. automodule:: feast.api.registry.rest.codegen_utils + :members: + :undoc-members: + :show-inheritance: + feast.api.registry.rest.data\_sources module -------------------------------------------- @@ -36,6 +44,30 @@ feast.api.registry.rest.feature\_views module :undoc-members: :show-inheritance: +feast.api.registry.rest.features module +--------------------------------------- + +.. automodule:: feast.api.registry.rest.features + :members: + :undoc-members: + :show-inheritance: + +feast.api.registry.rest.lineage module +-------------------------------------- + +.. automodule:: feast.api.registry.rest.lineage + :members: + :undoc-members: + :show-inheritance: + +feast.api.registry.rest.metrics module +-------------------------------------- + +.. automodule:: feast.api.registry.rest.metrics + :members: + :undoc-members: + :show-inheritance: + feast.api.registry.rest.permissions module ------------------------------------------ diff --git a/sdk/python/docs/source/feast.infra.compute_engines.algorithms.rst b/sdk/python/docs/source/feast.infra.compute_engines.algorithms.rst new file mode 100644 index 00000000000..52caa7127d3 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.compute_engines.algorithms.rst @@ -0,0 +1,21 @@ +feast.infra.compute\_engines.algorithms package +=============================================== + +Submodules +---------- + +feast.infra.compute\_engines.algorithms.topo module +--------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.algorithms.topo + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.compute_engines.algorithms + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.compute_engines.kubernetes.rst b/sdk/python/docs/source/feast.infra.compute_engines.kubernetes.rst new file mode 100644 index 00000000000..625b6d93cc3 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.compute_engines.kubernetes.rst @@ -0,0 +1,45 @@ +feast.infra.compute\_engines.kubernetes package +=============================================== + +Submodules +---------- + +feast.infra.compute\_engines.kubernetes.k8s\_engine module +---------------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.kubernetes.k8s_engine + :members: + :undoc-members: + :show-inheritance: + +feast.infra.compute\_engines.kubernetes.k8s\_materialization\_job module +------------------------------------------------------------------------ + +.. automodule:: feast.infra.compute_engines.kubernetes.k8s_materialization_job + :members: + :undoc-members: + :show-inheritance: + +feast.infra.compute\_engines.kubernetes.k8s\_materialization\_task module +------------------------------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.kubernetes.k8s_materialization_task + :members: + :undoc-members: + :show-inheritance: + +feast.infra.compute\_engines.kubernetes.main module +--------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.kubernetes.main + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.compute_engines.kubernetes + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.compute_engines.rst b/sdk/python/docs/source/feast.infra.compute_engines.rst index 00813edbb3b..440ec4d1016 100644 --- a/sdk/python/docs/source/feast.infra.compute_engines.rst +++ b/sdk/python/docs/source/feast.infra.compute_engines.rst @@ -7,7 +7,10 @@ Subpackages .. toctree:: :maxdepth: 4 + feast.infra.compute_engines.algorithms + feast.infra.compute_engines.kubernetes feast.infra.compute_engines.local + feast.infra.compute_engines.snowflake feast.infra.compute_engines.spark Submodules @@ -29,6 +32,22 @@ feast.infra.compute\_engines.feature\_builder module :undoc-members: :show-inheritance: +feast.infra.compute\_engines.feature\_resolver module +----------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.feature_resolver + :members: + :undoc-members: + :show-inheritance: + +feast.infra.compute\_engines.utils module +----------------------------------------- + +.. automodule:: feast.infra.compute_engines.utils + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/sdk/python/docs/source/feast.infra.compute_engines.snowflake.rst b/sdk/python/docs/source/feast.infra.compute_engines.snowflake.rst new file mode 100644 index 00000000000..b4f15e4c33b --- /dev/null +++ b/sdk/python/docs/source/feast.infra.compute_engines.snowflake.rst @@ -0,0 +1,29 @@ +feast.infra.compute\_engines.snowflake package +============================================== + +Submodules +---------- + +feast.infra.compute\_engines.snowflake.snowflake\_engine module +--------------------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.snowflake.snowflake_engine + :members: + :undoc-members: + :show-inheritance: + +feast.infra.compute\_engines.snowflake.snowflake\_materialization\_job module +----------------------------------------------------------------------------- + +.. automodule:: feast.infra.compute_engines.snowflake.snowflake_materialization_job + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.compute_engines.snowflake + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.compute_engines.spark.rst b/sdk/python/docs/source/feast.infra.compute_engines.spark.rst index c49d4a5c49e..c3b826f0afd 100644 --- a/sdk/python/docs/source/feast.infra.compute_engines.spark.rst +++ b/sdk/python/docs/source/feast.infra.compute_engines.spark.rst @@ -12,14 +12,6 @@ feast.infra.compute\_engines.spark.compute module :undoc-members: :show-inheritance: -feast.infra.compute\_engines.spark.config module ------------------------------------------------- - -.. automodule:: feast.infra.compute_engines.spark.config - :members: - :undoc-members: - :show-inheritance: - feast.infra.compute\_engines.spark.feature\_builder module ---------------------------------------------------------- diff --git a/sdk/python/docs/source/feast.infra.mcp_servers.rst b/sdk/python/docs/source/feast.infra.mcp_servers.rst new file mode 100644 index 00000000000..5d905d68ecf --- /dev/null +++ b/sdk/python/docs/source/feast.infra.mcp_servers.rst @@ -0,0 +1,29 @@ +feast.infra.mcp\_servers package +================================ + +Submodules +---------- + +feast.infra.mcp\_servers.mcp\_config module +------------------------------------------- + +.. automodule:: feast.infra.mcp_servers.mcp_config + :members: + :undoc-members: + :show-inheritance: + +feast.infra.mcp\_servers.mcp\_server module +------------------------------------------- + +.. automodule:: feast.infra.mcp_servers.mcp_server + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.mcp_servers + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.rst b/sdk/python/docs/source/feast.infra.offline_stores.rst index c770e5c13b0..cb36fd72d5e 100644 --- a/sdk/python/docs/source/feast.infra.offline_stores.rst +++ b/sdk/python/docs/source/feast.infra.offline_stores.rst @@ -52,6 +52,14 @@ feast.infra.offline\_stores.file\_source module :undoc-members: :show-inheritance: +feast.infra.offline\_stores.hybrid\_offline\_store module +--------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.hybrid_offline_store + :members: + :undoc-members: + :show-inheritance: + feast.infra.offline\_stores.ibis module --------------------------------------- diff --git a/sdk/python/docs/source/feast.infra.rst b/sdk/python/docs/source/feast.infra.rst index 4e23f35b311..1d25664b205 100644 --- a/sdk/python/docs/source/feast.infra.rst +++ b/sdk/python/docs/source/feast.infra.rst @@ -11,7 +11,7 @@ Subpackages feast.infra.compute_engines feast.infra.contrib feast.infra.feature_servers - feast.infra.materialization + feast.infra.mcp_servers feast.infra.offline_stores feast.infra.online_stores feast.infra.registry diff --git a/sdk/python/docs/source/feast.lineage.rst b/sdk/python/docs/source/feast.lineage.rst new file mode 100644 index 00000000000..d5c91f68bb1 --- /dev/null +++ b/sdk/python/docs/source/feast.lineage.rst @@ -0,0 +1,21 @@ +feast.lineage package +===================== + +Submodules +---------- + +feast.lineage.registry\_lineage module +-------------------------------------- + +.. automodule:: feast.lineage.registry_lineage + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.lineage + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.protos.feast.core.rst b/sdk/python/docs/source/feast.protos.feast.core.rst index 78398e54dcb..b2fa998509c 100644 --- a/sdk/python/docs/source/feast.protos.feast.core.rst +++ b/sdk/python/docs/source/feast.protos.feast.core.rst @@ -68,22 +68,6 @@ feast.protos.feast.core.DatastoreTable\_pb2\_grpc module :undoc-members: :show-inheritance: -feast.protos.feast.core.DynamoDBTable\_pb2 module -------------------------------------------------- - -.. automodule:: feast.protos.feast.core.DynamoDBTable_pb2 - :members: - :undoc-members: - :show-inheritance: - -feast.protos.feast.core.DynamoDBTable\_pb2\_grpc module -------------------------------------------------------- - -.. automodule:: feast.protos.feast.core.DynamoDBTable_pb2_grpc - :members: - :undoc-members: - :show-inheritance: - feast.protos.feast.core.Entity\_pb2 module ------------------------------------------ diff --git a/sdk/python/docs/source/feast.rst b/sdk/python/docs/source/feast.rst index ac47b1f952b..ffb8a2eb580 100644 --- a/sdk/python/docs/source/feast.rst +++ b/sdk/python/docs/source/feast.rst @@ -13,6 +13,7 @@ Subpackages feast.dqm feast.embedded_go feast.infra + feast.lineage feast.loaders feast.permissions feast.protos @@ -78,6 +79,14 @@ feast.data\_source module :undoc-members: :show-inheritance: +feast.document\_labeling module +------------------------------- + +.. automodule:: feast.document_labeling + :members: + :undoc-members: + :show-inheritance: + feast.driver\_test\_data module ------------------------------- @@ -278,6 +287,14 @@ feast.proto\_json module :undoc-members: :show-inheritance: +feast.rag\_retriever module +--------------------------- + +.. automodule:: feast.rag_retriever + :members: + :undoc-members: + :show-inheritance: + feast.registry\_server module ----------------------------- @@ -342,6 +359,14 @@ feast.stream\_feature\_view module :undoc-members: :show-inheritance: +feast.torch\_wrapper module +--------------------------- + +.. automodule:: feast.torch_wrapper + :members: + :undoc-members: + :show-inheritance: + feast.transformation\_server module ----------------------------------- @@ -390,6 +415,14 @@ feast.value\_type module :undoc-members: :show-inheritance: +feast.vector\_store module +-------------------------- + +.. automodule:: feast.vector_store + :members: + :undoc-members: + :show-inheritance: + feast.version module -------------------- diff --git a/sdk/python/docs/source/index.rst b/sdk/python/docs/source/index.rst index 14af6a6d9ef..d285ef9a19a 100644 --- a/sdk/python/docs/source/index.rst +++ b/sdk/python/docs/source/index.rst @@ -1,512 +1,512 @@ -Feast Python API Documentation -============================== - -.. We prefer 'autoclass' instead of 'autoclass' as 'autoclass' can specify a class, whereas - 'autoclass' will pull in all public classes and methods from that module, which we typically - do not want. - -Feature Store -================== - -.. autoclass:: feast.feature_store.FeatureStore - :members: - -Config -================== - -.. autoclass:: feast.repo_config.RepoConfig - :members: - -.. autoclass:: feast.repo_config.RegistryConfig - :members: - -Data Source -================== - -.. autoclass:: feast.data_source.DataSource - :members: - -File Source ------------------- - -.. autoclass:: feast.infra.offline_stores.file_source.FileSource - :members: - -Snowflake Source ------------------- - -.. autoclass:: feast.infra.offline_stores.snowflake_source.SnowflakeSource - :members: - -BigQuery Source ------------------- - -.. autoclass:: feast.infra.offline_stores.bigquery_source.BigQuerySource - :members: - -Redshift Source ------------------- - -.. autoclass:: feast.infra.offline_stores.redshift_source.RedshiftSource - :members: - -Spark Source ------------------- - -.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source.SparkSource - :members: - -Trino Source ------------------- - -.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source.TrinoSource - :members: - -PostgreSQL Source ------------------- - -.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres_source.PostgreSQLSource - :members: - -Request Source ------------------- - -.. autoclass:: feast.data_source.RequestSource - :members: - -Push Source ------------------- - -.. autoclass:: feast.data_source.PushSource - :members: - -Kafka Source ------------------- - -.. autoclass:: feast.data_source.KafkaSource - :members: - -Kinesis Source ------------------- - -.. autoclass:: feast.data_source.KinesisSource - :members: - -Entity -================== - -.. autoclass:: feast.entity.Entity - :members: - -Feature View -================== - -.. autoclass:: feast.base_feature_view.BaseFeatureView - :members: - -Feature View ----------------------- - -.. autoclass:: feast.feature_view.FeatureView - :members: - -On Demand Feature View ----------------------- - -.. autoclass:: feast.on_demand_feature_view.OnDemandFeatureView - :members: - -Batch Feature View ----------------------- - -.. autoclass:: feast.batch_feature_view.BatchFeatureView - :members: - -Stream Feature View ----------------------- - -.. autoclass:: feast.stream_feature_view.StreamFeatureView - :members: - -Field -================== - -.. autoclass:: feast.field.Field - :members: - -Feature Service -================== - -.. autoclass:: feast.feature_service.FeatureService - :members: - -Registry -================== - -.. autoclass:: feast.infra.registry.base_registry.BaseRegistry - :members: - -Registry ----------------------- - -.. autoclass:: feast.infra.registry.registry.Registry - :members: - -SQL Registry ----------------------- - -.. autoclass:: feast.infra.registry.sql.SqlRegistry - :members: - -Registry Store -================== - -.. autoclass:: feast.infra.registry.registry_store.RegistryStore - :members: - -File Registry Store ------------------------ - -.. autoclass:: feast.infra.registry.file.FileRegistryStore - :members: - -GCS Registry Store ------------------------ - -.. autoclass:: feast.infra.registry.gcs.GCSRegistryStore - :members: - -S3 Registry Store ------------------------ - -.. autoclass:: feast.infra.registry.s3.S3RegistryStore - :members: - -Provider -================== - -.. autoclass:: feast.infra.provider.Provider - :members: - -Passthrough Provider --------------------- - -.. autoclass:: feast.infra.passthrough_provider.PassthroughProvider - :members: - -Local Provider ------------------- - -.. autoclass:: feast.infra.local.LocalProvider - :members: - -GCP Provider ------------------- - -.. autoclass:: feast.infra.gcp.GcpProvider - :members: - -AWS Provider ------------------- - -.. autoclass:: feast.infra.aws.AwsProvider - :members: - -Offline Store -================== - -.. autoclass:: feast.infra.offline_stores.offline_store.OfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.offline_store.RetrievalJob - :members: - -File Offline Store ------------------- - -.. autoclass:: feast.infra.offline_stores.file.FileOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.file.FileOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.file.FileRetrievalJob - :members: - -Snowflake Offline Store ------------------------ - -.. autoclass:: feast.infra.offline_stores.snowflake.SnowflakeOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.snowflake.SnowflakeOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.snowflake.SnowflakeRetrievalJob - :members: - -BigQuery Offline Store ----------------------- - -.. autoclass:: feast.infra.offline_stores.bigquery.BigQueryOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.bigquery.BigQueryOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.bigquery.BigQueryRetrievalJob - :members: - -Redshift Offline Store ----------------------- - -.. autoclass:: feast.infra.offline_stores.redshift.RedshiftOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.redshift.RedshiftOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.redshift.RedshiftRetrievalJob - :members: - -Spark Offline Store -------------------- - -.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkRetrievalJob - :members: - -Trino Offline Store -------------------- - -.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoRetrievalJob - :members: - -PostgreSQL Offline Store ------------------------- - -.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLOfflineStore - :members: - -.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLOfflineStoreConfig - :members: - -.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLRetrievalJob - :members: - -Online Store -================== - -.. autoclass:: feast.infra.online_stores.online_store.OnlineStore - :members: - -Sqlite Online Store -------------------- - -.. autoclass:: feast.infra.online_stores.sqlite.SqliteOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.sqlite.SqliteOnlineStoreConfig - :members: - -Datastore Online Store ----------------------- - -.. autoclass:: feast.infra.online_stores.datastore.DatastoreOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.datastore.DatastoreOnlineStoreConfig - :members: - -DynamoDB Online Store ---------------------- - -.. autoclass:: feast.infra.online_stores.dynamodb.DynamoDBOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.dynamodb.DynamoDBOnlineStoreConfig - :members: - -Redis Online Store ------------------- - -.. autoclass:: feast.infra.online_stores.redis.RedisOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.redis.RedisOnlineStoreConfig - :members: - -Snowflake Online Store ------------------- - -.. autoclass:: feast.infra.online_stores.snowflake.SnowflakeOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.snowflake.SnowflakeOnlineStoreConfig - :members: - -PostgreSQL Online Store ------------------------ - -.. autoclass:: feast.infra.online_stores.postgres_online_store.PostgreSQLOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.postgres_online_store.PostgreSQLOnlineStoreConfig - :members: - -HBase Online Store ------------------------ - -.. autoclass:: feast.infra.online_stores.hbase_online_store.hbase.HbaseOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.hbase_online_store.hbase.HbaseOnlineStoreConfig - :members: - -Cassandra Online Store ------------------------ - -.. autoclass:: feast.infra.online_stores.cassandra_online_store.cassandra_online_store.CassandraOnlineStore - :members: - -.. autoclass:: feast.infra.online_stores.cassandra_online_store.cassandra_online_store.CassandraOnlineStoreConfig - :members: - -Batch Materialization Engine -============================ - -.. autoclass:: feast.infra.materialization.batch_materialization_engine.BatchMaterializationEngine - :members: - -.. autoclass:: feast.infra.materialization.batch_materialization_engine.MaterializationJob - :members: - -.. autoclass:: feast.infra.materialization.batch_materialization_engine.MaterializationTask - :members: - -Local Engine ------------- - -.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationEngine - :members: - -.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationEngineConfig - :members: - -.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationJob - :members: - -Bytewax Engine ---------------------------- - -.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine.BytewaxMaterializationEngine - :members: - -.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine.BytewaxMaterializationEngineConfig - :members: - -.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_job.BytewaxMaterializationJob - :members: - -Snowflake Engine ---------------------------- - -.. autoclass:: feast.infra.materialization.snowflake_engine.SnowflakeMaterializationEngine - :members: - -.. autoclass:: feast.infra.materialization.snowflake_engine.SnowflakeMaterializationEngineConfig - :members: - -.. autoclass:: feast.infra.materialization.snowflake_engine.SnowflakeMaterializationJob - :members: - -(Alpha) AWS Lambda Engine ---------------------------- - -.. autoclass:: feast.infra.materialization.aws_lambda.lambda_engine.LambdaMaterializationEngine - :members: - -.. autoclass:: feast.infra.materialization.aws_lambda.lambda_engine.LambdaMaterializationEngineConfig - :members: - -.. autoclass:: feast.infra.materialization.aws_lambda.lambda_engine.LambdaMaterializationJob - :members: - -(Alpha) Spark Engine ---------------------------- - -.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationEngine - :members: - -.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationEngineConfig - :members: - -.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob - :members: - -Permission -============================ - -.. autoclass:: feast.permissions.permission.Permission - :members: - -.. autoclass:: feast.permissions.action.AuthzedAction - :members: - -.. autoclass:: feast.permissions.policy.Policy - :members: - -.. autofunction:: feast.permissions.enforcer.enforce_policy - -Auth Config ---------------------------- - -.. autoclass:: feast.permissions.auth_model.AuthConfig - :members: - -.. autoclass:: feast.permissions.auth_model.KubernetesAuthConfig - :members: - -.. autoclass:: feast.permissions.auth_model.OidcAuthConfig - :members: - -Auth Manager ---------------------------- - -.. autoclass:: feast.permissions.auth.AuthManager - :members: - -.. autoclass:: feast.permissions.auth.token_parser.TokenParser - :members: - -.. autoclass:: feast.permissions.auth.token_extractor.TokenExtractor - :members: - -.. autoclass:: feast.permissions.auth.kubernetes_token_parser.KubernetesTokenParser - :members: - -.. autoclass:: feast.permissions.auth.oidc_token_parser.OidcTokenParser - :members: - -Auth Client Manager ---------------------------- - -.. autoclass:: feast.permissions.client.auth_client_manager.AuthenticationClientManager - :members: - -.. autoclass:: feast.permissions.client.kubernetes_auth_client_manager.KubernetesAuthClientManager - :members: - -.. autoclass:: feast.permissions.client.oidc_authentication_client_manager.OidcAuthClientManager - :members: +Feast Python API Documentation +============================== + +.. We prefer 'autoclass' instead of 'autoclass' as 'autoclass' can specify a class, whereas + 'autoclass' will pull in all public classes and methods from that module, which we typically + do not want. + +Feature Store +================== + +.. autoclass:: feast.feature_store.FeatureStore + :members: + +Config +================== + +.. autoclass:: feast.repo_config.RepoConfig + :members: + +.. autoclass:: feast.repo_config.RegistryConfig + :members: + +Data Source +================== + +.. autoclass:: feast.data_source.DataSource + :members: + +File Source +------------------ + +.. autoclass:: feast.infra.offline_stores.file_source.FileSource + :members: + +Snowflake Source +------------------ + +.. autoclass:: feast.infra.offline_stores.snowflake_source.SnowflakeSource + :members: + +BigQuery Source +------------------ + +.. autoclass:: feast.infra.offline_stores.bigquery_source.BigQuerySource + :members: + +Redshift Source +------------------ + +.. autoclass:: feast.infra.offline_stores.redshift_source.RedshiftSource + :members: + +Spark Source +------------------ + +.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source.SparkSource + :members: + +Trino Source +------------------ + +.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source.TrinoSource + :members: + +PostgreSQL Source +------------------ + +.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres_source.PostgreSQLSource + :members: + +Request Source +------------------ + +.. autoclass:: feast.data_source.RequestSource + :members: + +Push Source +------------------ + +.. autoclass:: feast.data_source.PushSource + :members: + +Kafka Source +------------------ + +.. autoclass:: feast.data_source.KafkaSource + :members: + +Kinesis Source +------------------ + +.. autoclass:: feast.data_source.KinesisSource + :members: + +Entity +================== + +.. autoclass:: feast.entity.Entity + :members: + +Feature View +================== + +.. autoclass:: feast.base_feature_view.BaseFeatureView + :members: + +Feature View +---------------------- + +.. autoclass:: feast.feature_view.FeatureView + :members: + +On Demand Feature View +---------------------- + +.. autoclass:: feast.on_demand_feature_view.OnDemandFeatureView + :members: + +Batch Feature View +---------------------- + +.. autoclass:: feast.batch_feature_view.BatchFeatureView + :members: + +Stream Feature View +---------------------- + +.. autoclass:: feast.stream_feature_view.StreamFeatureView + :members: + +Field +================== + +.. autoclass:: feast.field.Field + :members: + +Feature Service +================== + +.. autoclass:: feast.feature_service.FeatureService + :members: + +Registry +================== + +.. autoclass:: feast.infra.registry.base_registry.BaseRegistry + :members: + +Registry +---------------------- + +.. autoclass:: feast.infra.registry.registry.Registry + :members: + +SQL Registry +---------------------- + +.. autoclass:: feast.infra.registry.sql.SqlRegistry + :members: + +Registry Store +================== + +.. autoclass:: feast.infra.registry.registry_store.RegistryStore + :members: + +File Registry Store +----------------------- + +.. autoclass:: feast.infra.registry.file.FileRegistryStore + :members: + +GCS Registry Store +----------------------- + +.. autoclass:: feast.infra.registry.gcs.GCSRegistryStore + :members: + +S3 Registry Store +----------------------- + +.. autoclass:: feast.infra.registry.s3.S3RegistryStore + :members: + +Provider +================== + +.. autoclass:: feast.infra.provider.Provider + :members: + +Passthrough Provider +-------------------- + +.. autoclass:: feast.infra.passthrough_provider.PassthroughProvider + :members: + +Local Provider +------------------ + +.. autoclass:: feast.infra.local.LocalProvider + :members: + +GCP Provider +------------------ + +.. autoclass:: feast.infra.gcp.GcpProvider + :members: + +AWS Provider +------------------ + +.. autoclass:: feast.infra.aws.AwsProvider + :members: + +Offline Store +================== + +.. autoclass:: feast.infra.offline_stores.offline_store.OfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.offline_store.RetrievalJob + :members: + +File Offline Store +------------------ + +.. autoclass:: feast.infra.offline_stores.file.FileOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.file.FileOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.file.FileRetrievalJob + :members: + +Snowflake Offline Store +----------------------- + +.. autoclass:: feast.infra.offline_stores.snowflake.SnowflakeOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.snowflake.SnowflakeOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.snowflake.SnowflakeRetrievalJob + :members: + +BigQuery Offline Store +---------------------- + +.. autoclass:: feast.infra.offline_stores.bigquery.BigQueryOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.bigquery.BigQueryOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.bigquery.BigQueryRetrievalJob + :members: + +Redshift Offline Store +---------------------- + +.. autoclass:: feast.infra.offline_stores.redshift.RedshiftOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.redshift.RedshiftOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.redshift.RedshiftRetrievalJob + :members: + +Spark Offline Store +------------------- + +.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkRetrievalJob + :members: + +Trino Offline Store +------------------- + +.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoRetrievalJob + :members: + +PostgreSQL Offline Store +------------------------ + +.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLOfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLOfflineStoreConfig + :members: + +.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLRetrievalJob + :members: + +Online Store +================== + +.. autoclass:: feast.infra.online_stores.online_store.OnlineStore + :members: + +Sqlite Online Store +------------------- + +.. autoclass:: feast.infra.online_stores.sqlite.SqliteOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.sqlite.SqliteOnlineStoreConfig + :members: + +Datastore Online Store +---------------------- + +.. autoclass:: feast.infra.online_stores.datastore.DatastoreOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.datastore.DatastoreOnlineStoreConfig + :members: + +DynamoDB Online Store +--------------------- + +.. autoclass:: feast.infra.online_stores.dynamodb.DynamoDBOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.dynamodb.DynamoDBOnlineStoreConfig + :members: + +Redis Online Store +------------------ + +.. autoclass:: feast.infra.online_stores.redis.RedisOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.redis.RedisOnlineStoreConfig + :members: + +Snowflake Online Store +------------------ + +.. autoclass:: feast.infra.online_stores.snowflake.SnowflakeOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.snowflake.SnowflakeOnlineStoreConfig + :members: + +PostgreSQL Online Store +----------------------- + +.. autoclass:: feast.infra.online_stores.postgres_online_store.PostgreSQLOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.postgres_online_store.PostgreSQLOnlineStoreConfig + :members: + +HBase Online Store +----------------------- + +.. autoclass:: feast.infra.online_stores.hbase_online_store.hbase.HbaseOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.hbase_online_store.hbase.HbaseOnlineStoreConfig + :members: + +Cassandra Online Store +----------------------- + +.. autoclass:: feast.infra.online_stores.cassandra_online_store.cassandra_online_store.CassandraOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.cassandra_online_store.cassandra_online_store.CassandraOnlineStoreConfig + :members: + +Batch Materialization Engine +============================ + +.. autoclass:: feast.infra.materialization.batch_materialization_engine.BatchMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.batch_materialization_engine.MaterializationJob + :members: + +.. autoclass:: feast.infra.materialization.batch_materialization_engine.MaterializationTask + :members: + +Local Engine +------------ + +.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationEngineConfig + :members: + +.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationJob + :members: + +Bytewax Engine +--------------------------- + +.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine.BytewaxMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine.BytewaxMaterializationEngineConfig + :members: + +.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_job.BytewaxMaterializationJob + :members: + +Snowflake Engine +--------------------------- + +.. autoclass:: feast.infra.materialization.snowflake_engine.SnowflakeMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.snowflake_engine.SnowflakeMaterializationEngineConfig + :members: + +.. autoclass:: feast.infra.materialization.snowflake_engine.SnowflakeMaterializationJob + :members: + +(Alpha) AWS Lambda Engine +--------------------------- + +.. autoclass:: feast.infra.materialization.aws_lambda.lambda_engine.LambdaMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.aws_lambda.lambda_engine.LambdaMaterializationEngineConfig + :members: + +.. autoclass:: feast.infra.materialization.aws_lambda.lambda_engine.LambdaMaterializationJob + :members: + +(Alpha) Spark Engine +--------------------------- + +.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationEngineConfig + :members: + +.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob + :members: + +Permission +============================ + +.. autoclass:: feast.permissions.permission.Permission + :members: + +.. autoclass:: feast.permissions.action.AuthzedAction + :members: + +.. autoclass:: feast.permissions.policy.Policy + :members: + +.. autofunction:: feast.permissions.enforcer.enforce_policy + +Auth Config +--------------------------- + +.. autoclass:: feast.permissions.auth_model.AuthConfig + :members: + +.. autoclass:: feast.permissions.auth_model.KubernetesAuthConfig + :members: + +.. autoclass:: feast.permissions.auth_model.OidcAuthConfig + :members: + +Auth Manager +--------------------------- + +.. autoclass:: feast.permissions.auth.AuthManager + :members: + +.. autoclass:: feast.permissions.auth.token_parser.TokenParser + :members: + +.. autoclass:: feast.permissions.auth.token_extractor.TokenExtractor + :members: + +.. autoclass:: feast.permissions.auth.kubernetes_token_parser.KubernetesTokenParser + :members: + +.. autoclass:: feast.permissions.auth.oidc_token_parser.OidcTokenParser + :members: + +Auth Client Manager +--------------------------- + +.. autoclass:: feast.permissions.client.auth_client_manager.AuthenticationClientManager + :members: + +.. autoclass:: feast.permissions.client.kubernetes_auth_client_manager.KubernetesAuthClientManager + :members: + +.. autoclass:: feast.permissions.client.oidc_authentication_client_manager.OidcAuthClientManager + :members: diff --git a/sdk/python/feast/protos/feast/core/DataFormat_pb2.pyi b/sdk/python/feast/protos/feast/core/DataFormat_pb2.pyi index 1f904e9886a..cc31a9e0c80 100644 --- a/sdk/python/feast/protos/feast/core/DataFormat_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/DataFormat_pb2.pyi @@ -1,19 +1,19 @@ """ @generated by mypy-protobuf. Do not edit manually! isort:skip_file - -Copyright 2020 The Feast Authors - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and + +Copyright 2020 The Feast Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and limitations under the License. """ import builtins @@ -81,7 +81,7 @@ class StreamFormat(google.protobuf.message.Message): CLASS_PATH_FIELD_NUMBER: builtins.int class_path: builtins.str - """Classpath to the generated Java Protobuf class that can be used to decode + """Classpath to the generated Java Protobuf class that can be used to decode Feature data from the obtained stream message """ def __init__( @@ -98,7 +98,7 @@ class StreamFormat(google.protobuf.message.Message): SCHEMA_JSON_FIELD_NUMBER: builtins.int schema_json: builtins.str - """Optional if used in a File DataSource as schema is embedded in avro file. + """Optional if used in a File DataSource as schema is embedded in avro file. Specifies the schema of the Avro message as JSON string. """ def __init__( diff --git a/sdk/python/feast/protos/feast/core/DatastoreTable_pb2.pyi b/sdk/python/feast/protos/feast/core/DatastoreTable_pb2.pyi index 6339a97536e..7b5a629eb7a 100644 --- a/sdk/python/feast/protos/feast/core/DatastoreTable_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/DatastoreTable_pb2.pyi @@ -1,19 +1,19 @@ """ @generated by mypy-protobuf. Do not edit manually! isort:skip_file - -* Copyright 2021 The Feast Authors -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* https://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and + +* Copyright 2021 The Feast Authors +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* https://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and * limitations under the License. """ import builtins diff --git a/sdk/python/feast/protos/feast/core/Entity_pb2.pyi b/sdk/python/feast/protos/feast/core/Entity_pb2.pyi index 025817edfee..a5924a13451 100644 --- a/sdk/python/feast/protos/feast/core/Entity_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/Entity_pb2.pyi @@ -1,19 +1,19 @@ """ @generated by mypy-protobuf. Do not edit manually! isort:skip_file - -* Copyright 2020 The Feast Authors -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* https://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and + +* Copyright 2020 The Feast Authors +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* https://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and * limitations under the License. """ import builtins diff --git a/sdk/python/feast/protos/feast/core/FeatureViewProjection_pb2.pyi b/sdk/python/feast/protos/feast/core/FeatureViewProjection_pb2.pyi index 6b44ad4a931..72426f55c9f 100644 --- a/sdk/python/feast/protos/feast/core/FeatureViewProjection_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/FeatureViewProjection_pb2.pyi @@ -19,7 +19,7 @@ else: DESCRIPTOR: google.protobuf.descriptor.FileDescriptor class FeatureViewProjection(google.protobuf.message.Message): - """A projection to be applied on top of a FeatureView. + """A projection to be applied on top of a FeatureView. Contains the modifications to a FeatureView such as the features subset to use. """ diff --git a/sdk/python/feast/protos/feast/core/OnDemandFeatureView_pb2.pyi b/sdk/python/feast/protos/feast/core/OnDemandFeatureView_pb2.pyi index c9fca2f550d..06d85d807a9 100644 --- a/sdk/python/feast/protos/feast/core/OnDemandFeatureView_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/OnDemandFeatureView_pb2.pyi @@ -1,19 +1,19 @@ """ @generated by mypy-protobuf. Do not edit manually! isort:skip_file - -Copyright 2020 The Feast Authors - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and + +Copyright 2020 The Feast Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and limitations under the License. """ import builtins diff --git a/sdk/python/feast/protos/feast/core/Project_pb2.pyi b/sdk/python/feast/protos/feast/core/Project_pb2.pyi index e3cce2ec425..3196304a19b 100644 --- a/sdk/python/feast/protos/feast/core/Project_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/Project_pb2.pyi @@ -1,19 +1,19 @@ """ @generated by mypy-protobuf. Do not edit manually! isort:skip_file - -* Copyright 2020 The Feast Authors -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* https://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and + +* Copyright 2020 The Feast Authors +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* https://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and * limitations under the License. """ import builtins diff --git a/sdk/python/feast/protos/feast/core/Registry_pb2.pyi b/sdk/python/feast/protos/feast/core/Registry_pb2.pyi index fca49c75481..ad09878b77f 100644 --- a/sdk/python/feast/protos/feast/core/Registry_pb2.pyi +++ b/sdk/python/feast/protos/feast/core/Registry_pb2.pyi @@ -1,19 +1,19 @@ """ @generated by mypy-protobuf. Do not edit manually! isort:skip_file - -* Copyright 2020 The Feast Authors -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* https://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and + +* Copyright 2020 The Feast Authors +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* https://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and * limitations under the License. """ import builtins