From 0add6a4f6d078c42b6456f4c13465bee9bdc8a8c Mon Sep 17 00:00:00 2001 From: Felix Wang Date: Thu, 25 Aug 2022 12:22:18 -0700 Subject: [PATCH] chore: Add missing docs (#3143) Add missing docs Signed-off-by: Felix Wang Signed-off-by: Felix Wang --- sdk/python/docs/source/feast.infra.rst | 2 +- .../feast.infra.transformation_servers.rst | 21 ++ sdk/python/docs/source/index.rst | 296 ++++++++++++------ 3 files changed, 214 insertions(+), 105 deletions(-) create mode 100644 sdk/python/docs/source/feast.infra.transformation_servers.rst diff --git a/sdk/python/docs/source/feast.infra.rst b/sdk/python/docs/source/feast.infra.rst index 96c0828451..50e1f37f1c 100644 --- a/sdk/python/docs/source/feast.infra.rst +++ b/sdk/python/docs/source/feast.infra.rst @@ -7,10 +7,10 @@ Subpackages .. toctree:: :maxdepth: 4 - feast.infra.materialization feast.infra.offline_stores feast.infra.online_stores feast.infra.registry + feast.infra.transformation_servers feast.infra.utils Submodules diff --git a/sdk/python/docs/source/feast.infra.transformation_servers.rst b/sdk/python/docs/source/feast.infra.transformation_servers.rst new file mode 100644 index 0000000000..7de2dc79f2 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.transformation_servers.rst @@ -0,0 +1,21 @@ +feast.infra.transformation\_servers package +=========================================== + +Submodules +---------- + +feast.infra.transformation\_servers.app module +---------------------------------------------- + +.. automodule:: feast.infra.transformation_servers.app + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.transformation_servers + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/index.rst b/sdk/python/docs/source/index.rst index 58823d2fe1..beca384137 100644 --- a/sdk/python/docs/source/index.rst +++ b/sdk/python/docs/source/index.rst @@ -1,353 +1,441 @@ 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 ================== -.. automodule:: feast.feature_store - :members: - :undoc-members: - :show-inheritance: +.. autoclass:: feast.feature_store.FeatureStore + :members: Config ================== -.. automodule:: feast.repo_config +.. autoclass:: feast.repo_config.RepoConfig + :members: + +.. autoclass:: feast.repo_config.RegistryConfig :members: - :exclude-members: load_repo_config, FeastBaseModel Data Source ================== -.. automodule:: feast.data_source - :inherited-members: +.. autoclass:: feast.data_source.DataSource :members: - :exclude-members: KafkaOptions, KafkaSource, KinesisOptions, KinesisSource, PushSource, RequestSource, RequestDataSource -Request Source +File Source ------------------ -.. automodule:: feast.data_source - :members: RequestSource +.. autoclass:: feast.infra.offline_stores.file_source.FileSource + :members: -Push Source +Snowflake Source ------------------ -.. automodule:: feast.data_source - :members: PushSource +.. autoclass:: feast.infra.offline_stores.snowflake_source.SnowflakeSource + :members: BigQuery Source ------------------ -.. automodule:: feast.infra.offline_stores.bigquery_source +.. autoclass:: feast.infra.offline_stores.bigquery_source.BigQuerySource :members: - :exclude-members: BigQueryOptions Redshift Source ------------------ -.. automodule:: feast.infra.offline_stores.redshift_source +.. autoclass:: feast.infra.offline_stores.redshift_source.RedshiftSource :members: - :exclude-members: RedshiftOptions -Snowflake Source +Spark Source ------------------ -.. automodule:: feast.infra.offline_stores.snowflake_source +.. autoclass:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source.SparkSource :members: - :exclude-members: SnowflakeOptions -Spark Source +Trino Source ------------------ -.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source +.. autoclass:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source.TrinoSource :members: - :exclude-members: SparkOptions -Trino Source +PostgreSQL Source ------------------ -.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source +.. autoclass:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres_source.PostgreSQLSource :members: - :exclude-members: TrinoOptions -PostgreSQL Source +Request Source ------------------ -.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres_source +.. autoclass:: feast.data_source.RequestSource :members: - :exclude-members: PostgreSQLOptions -File Source +Push Source +------------------ + +.. autoclass:: feast.data_source.PushSource + :members: + +Kafka Source +------------------ + +.. autoclass:: feast.data_source.KafkaSource + :members: + +Kinesis Source ------------------ -.. automodule:: feast.infra.offline_stores.file_source +.. autoclass:: feast.data_source.KinesisSource :members: - :exclude-members: FileOptions Entity ================== -.. automodule:: feast.entity - :inherited-members: +.. autoclass:: feast.entity.Entity :members: Feature View ================== -.. automodule:: feast.base_feature_view +.. autoclass:: feast.base_feature_view.BaseFeatureView :members: Feature View ---------------------- -.. automodule:: feast.feature_view +.. autoclass:: feast.feature_view.FeatureView :members: On Demand Feature View ---------------------- -.. automodule:: feast.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 ---------------------- -.. automodule:: feast.stream_feature_view +.. autoclass:: feast.stream_feature_view.StreamFeatureView :members: -Feature +Field ================== -.. automodule:: feast.feature - :inherited-members: +.. autoclass:: feast.field.Field :members: Feature Service ================== -.. automodule:: feast.feature_service - :inherited-members: +.. autoclass:: feast.feature_service.FeatureService :members: Registry ================== -.. automodule:: feast.infra.registry.base_registry - :inherited-members: +.. autoclass:: feast.infra.registry.base_registry.BaseRegistry :members: Registry ---------------------- -.. automodule:: feast.infra.registry.registry - :inherited-members: +.. autoclass:: feast.infra.registry.registry.Registry :members: SQL Registry ---------------------- -.. automodule:: feast.infra.registry.sql - :inherited-members: +.. autoclass:: feast.infra.registry.sql.SqlRegistry :members: Registry Store ================== -.. automodule:: feast.infra.registry.registry_store - :inherited-members: +.. autoclass:: feast.infra.registry.registry_store.RegistryStore :members: - :exclude-members: NoopRegistryStore File Registry Store ----------------------- -.. automodule:: feast.infra.registry.file +.. autoclass:: feast.infra.registry.file.FileRegistryStore :members: - :noindex: GCS Registry Store ----------------------- -.. automodule:: feast.infra.registry.gcs +.. autoclass:: feast.infra.registry.gcs.GCSRegistryStore :members: - :noindex: S3 Registry Store ----------------------- -.. automodule:: feast.infra.registry.s3 +.. autoclass:: feast.infra.registry.s3.S3RegistryStore :members: - :noindex: PostgreSQL Registry Store ----------------------- -.. automodule:: feast.infra.registry.contrib.postgres.postgres_registry_store +.. autoclass:: feast.infra.registry.contrib.postgres.postgres_registry_store.PostgreSQLRegistryStore :members: - :noindex: Provider ================== -.. automodule:: feast.infra.provider - :inherited-members: +.. autoclass:: feast.infra.provider.Provider :members: Passthrough Provider -------------------- -.. automodule:: feast.infra.passthrough_provider +.. autoclass:: feast.infra.passthrough_provider.PassthroughProvider :members: Local Provider ------------------ -.. automodule:: feast.infra.local +.. autoclass:: feast.infra.local.LocalProvider :members: GCP Provider ------------------ -.. automodule:: feast.infra.gcp +.. autoclass:: feast.infra.gcp.GcpProvider :members: AWS Provider ------------------ -.. automodule:: feast.infra.aws +.. autoclass:: feast.infra.aws.AwsProvider :members: Offline Store ================== -.. automodule:: feast.infra.offline_stores.offline_store +.. autoclass:: feast.infra.offline_stores.offline_store.OfflineStore + :members: + +.. autoclass:: feast.infra.offline_stores.offline_store.RetrievalJob :members: File Offline Store ------------------ -.. automodule:: feast.infra.offline_stores.file +.. 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 ---------------------- -.. automodule:: feast.infra.offline_stores.bigquery +.. 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 ---------------------- -.. automodule:: feast.infra.offline_stores.redshift +.. autoclass:: feast.infra.offline_stores.redshift.RedshiftOfflineStore :members: -Snowflake Offline Store ------------------------ +.. autoclass:: feast.infra.offline_stores.redshift.RedshiftOfflineStoreConfig + :members: -.. automodule:: feast.infra.offline_stores.snowflake +.. autoclass:: feast.infra.offline_stores.redshift.RedshiftRetrievalJob :members: Spark Offline Store ------------------- -.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark +.. 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 ------------------- -.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino +.. 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 ------------------------ -.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres +.. 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 ================== -.. automodule:: feast.infra.online_stores.online_store - :inherited-members: +.. autoclass:: feast.infra.online_stores.online_store.OnlineStore :members: Sqlite Online Store ------------------- -.. automodule:: feast.infra.online_stores.sqlite +.. autoclass:: feast.infra.online_stores.sqlite.SqliteOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.sqlite.SqliteOnlineStoreConfig :members: - :noindex: Datastore Online Store ---------------------- -.. automodule:: feast.infra.online_stores.datastore +.. autoclass:: feast.infra.online_stores.datastore.DatastoreOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.datastore.DatastoreOnlineStoreConfig :members: - :noindex: DynamoDB Online Store --------------------- -.. automodule:: feast.infra.online_stores.dynamodb +.. autoclass:: feast.infra.online_stores.dynamodb.DynamoDBOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.dynamodb.DynamoDBOnlineStoreConfig :members: - :noindex: Redis Online Store ------------------ -.. automodule:: feast.infra.online_stores.redis +.. autoclass:: feast.infra.online_stores.redis.RedisOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.redis.RedisOnlineStoreConfig :members: - :noindex: PostgreSQL Online Store ----------------------- -.. automodule:: feast.infra.online_stores.contrib.postgres +.. autoclass:: feast.infra.online_stores.contrib.postgres.PostgreSQLOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.contrib.postgres.PostgreSQLOnlineStoreConfig :members: - :noindex: HBase Online Store ----------------------- -.. automodule:: feast.infra.online_stores.contrib.hbase_online_store.hbase +.. autoclass:: feast.infra.online_stores.contrib.hbase_online_store.hbase.HbaseOnlineStore + :members: + +.. autoclass:: feast.infra.online_stores.contrib.hbase_online_store.hbase.HbaseOnlineStoreConfig :members: - :noindex: Cassandra Online Store ----------------------- -.. automodule:: feast.infra.online_stores.contrib.cassandra_online_store.cassandra_online_store +.. autoclass:: feast.infra.online_stores.contrib.cassandra_online_store.cassandra_online_store.CassandraOnlineStore :members: - :noindex: +.. autoclass:: feast.infra.online_stores.contrib.cassandra_online_store.cassandra_online_store.CassandraOnlineStoreConfig + :members: Batch Materialization Engine ============================ -.. automodule:: feast.infra.materialization - :members: BatchMaterializationEngine, MaterializationJob, MaterializationTask +.. 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.LocalMaterializationEngine + +.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationEngine + :members: + +.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationEngineConfig :members: - :noindex: -(Alpha) Lambda Based Engine +.. autoclass:: feast.infra.materialization.local_engine.LocalMaterializationJob + :members: + +Bytewax Engine --------------------------- -.. automodule:: feast.infra.materialization.lambda.lambda_engine +.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine.BytewaxMaterializationEngine :members: - :noindex: +.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine.BytewaxMaterializationEngineConfig + :members: -Bytewax Engine +.. autoclass:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_job.BytewaxMaterializationJob + :members: + +Snowflake Engine --------------------------- -.. automodule:: feast.infra.materialization.contrib.bytewax +.. 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: - :noindex: