From 3ae7650ffd9b02d20dce0d82606b27ca1e339fdc Mon Sep 17 00:00:00 2001 From: Felix Wang Date: Thu, 25 Aug 2022 11:52:45 -0700 Subject: [PATCH] chore: Revert "chore: Delete generated RTD docs (#3126)" (#3141) Revert "chore: Delete generated RTD docs (#3126)" This reverts commit 9af5bc214a141c3013f19d8e8f45bd8f94c5b199. Signed-off-by: Felix Wang Signed-off-by: Felix Wang --- .gitignore | 3 +- sdk/python/docs/source/conf.py | 201 ++++++++++ sdk/python/docs/source/feast.diff.rst | 37 ++ .../docs/source/feast.dqm.profilers.rst | 29 ++ sdk/python/docs/source/feast.dqm.rst | 29 ++ ....infra.materialization.contrib.bytewax.rst | 29 ++ .../feast.infra.materialization.contrib.rst | 10 + .../feast.infra.materialization.lambda.rst | 29 ++ .../source/feast.infra.materialization.rst | 45 +++ ...ne_stores.contrib.athena_offline_store.rst | 37 ++ ...res.contrib.athena_offline_store.tests.rst | 21 + ...ine_stores.contrib.mssql_offline_store.rst | 37 ++ ...ores.contrib.mssql_offline_store.tests.rst | 21 + ..._stores.contrib.postgres_offline_store.rst | 37 ++ ...s.contrib.postgres_offline_store.tests.rst | 21 + .../feast.infra.offline_stores.contrib.rst | 65 +++ ...ine_stores.contrib.spark_offline_store.rst | 37 ++ ...ores.contrib.spark_offline_store.tests.rst | 21 + ...contrib.trino_offline_store.connectors.rst | 21 + ...ine_stores.contrib.trino_offline_store.rst | 55 +++ ...ontrib.trino_offline_store.test_config.rst | 21 + ...ores.contrib.trino_offline_store.tests.rst | 21 + .../source/feast.infra.offline_stores.rst | 101 +++++ ..._stores.contrib.cassandra_online_store.rst | 21 + ...line_stores.contrib.hbase_online_store.rst | 21 + .../feast.infra.online_stores.contrib.rst | 54 +++ .../docs/source/feast.infra.online_stores.rst | 77 ++++ .../docs/source/feast.infra.registry.rst | 69 ++++ .../source/feast.infra.registry_stores.rst | 21 + sdk/python/docs/source/feast.infra.rst | 81 ++++ .../source/feast.infra.utils.postgres.rst | 29 ++ sdk/python/docs/source/feast.infra.utils.rst | 37 ++ sdk/python/docs/source/feast.loaders.rst | 21 + .../docs/source/feast.protos.feast.core.rst | 333 +++++++++++++++ sdk/python/docs/source/feast.protos.feast.rst | 21 + .../source/feast.protos.feast.serving.rst | 61 +++ .../source/feast.protos.feast.storage.rst | 29 ++ .../docs/source/feast.protos.feast.types.rst | 61 +++ sdk/python/docs/source/feast.protos.rst | 18 + sdk/python/docs/source/feast.rst | 378 ++++++++++++++++++ sdk/python/docs/source/feast.ui.rst | 10 + sdk/python/docs/source/index.rst | 353 ++++++++++++++++ sdk/python/docs/source/modules.rst | 7 + 43 files changed, 2628 insertions(+), 2 deletions(-) create mode 100644 sdk/python/docs/source/conf.py create mode 100644 sdk/python/docs/source/feast.diff.rst create mode 100644 sdk/python/docs/source/feast.dqm.profilers.rst create mode 100644 sdk/python/docs/source/feast.dqm.rst create mode 100644 sdk/python/docs/source/feast.infra.materialization.contrib.bytewax.rst create mode 100644 sdk/python/docs/source/feast.infra.materialization.contrib.rst create mode 100644 sdk/python/docs/source/feast.infra.materialization.lambda.rst create mode 100644 sdk/python/docs/source/feast.infra.materialization.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.tests.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.tests.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.tests.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.tests.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.connectors.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.test_config.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.tests.rst create mode 100644 sdk/python/docs/source/feast.infra.offline_stores.rst create mode 100644 sdk/python/docs/source/feast.infra.online_stores.contrib.cassandra_online_store.rst create mode 100644 sdk/python/docs/source/feast.infra.online_stores.contrib.hbase_online_store.rst create mode 100644 sdk/python/docs/source/feast.infra.online_stores.contrib.rst create mode 100644 sdk/python/docs/source/feast.infra.online_stores.rst create mode 100644 sdk/python/docs/source/feast.infra.registry.rst create mode 100644 sdk/python/docs/source/feast.infra.registry_stores.rst create mode 100644 sdk/python/docs/source/feast.infra.rst create mode 100644 sdk/python/docs/source/feast.infra.utils.postgres.rst create mode 100644 sdk/python/docs/source/feast.infra.utils.rst create mode 100644 sdk/python/docs/source/feast.loaders.rst create mode 100644 sdk/python/docs/source/feast.protos.feast.core.rst create mode 100644 sdk/python/docs/source/feast.protos.feast.rst create mode 100644 sdk/python/docs/source/feast.protos.feast.serving.rst create mode 100644 sdk/python/docs/source/feast.protos.feast.storage.rst create mode 100644 sdk/python/docs/source/feast.protos.feast.types.rst create mode 100644 sdk/python/docs/source/feast.protos.rst create mode 100644 sdk/python/docs/source/feast.rst create mode 100644 sdk/python/docs/source/feast.ui.rst create mode 100644 sdk/python/docs/source/index.rst create mode 100644 sdk/python/docs/source/modules.rst diff --git a/.gitignore b/.gitignore index 1edde846ff..6a86eb2682 100644 --- a/.gitignore +++ b/.gitignore @@ -125,8 +125,6 @@ instance/ # Sphinx documentation docs/_build/ -sdk/python/docs/source -sdk/python/docs/html # PyBuilder target/ @@ -186,6 +184,7 @@ dmypy.json *.code-workspace # Protos +sdk/python/docs/html sdk/python/feast/protos/ sdk/go/protos/ go/protos/ diff --git a/sdk/python/docs/source/conf.py b/sdk/python/docs/source/conf.py new file mode 100644 index 0000000000..5e8fd11d16 --- /dev/null +++ b/sdk/python/docs/source/conf.py @@ -0,0 +1,201 @@ +# -*- coding: utf-8 -*- +# +# Feast documentation build configuration file, created by +# sphinx-quickstart on Sat Nov 30 15:06:53 2019. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +import sphinx_rtd_theme + +sys.path.insert(0, os.path.abspath("../../feast")) +sys.path.insert(0, os.path.abspath("../..")) + + +# -- Build protos --------------------------------------------------------- + +# For an unknown reason, the Python protos stopped being built correctly. +# See https://readthedocs.org/projects/feast/builds/17686555/ for an +# example where the Python protos did not build, which subsequently broke +# the RTD build. In order to fix this, we manually compile the protos. +import subprocess + +from pathlib import Path + +# cwd will be feast/sdk/python/docs/source +cwd = Path(os.getcwd()) + +# Change to feast/ +os.chdir(cwd.parent.parent.parent.parent) + +# Compile Python protos +result = subprocess.run(["python", "setup.py", "build_python_protos", "--inplace"], capture_output=True) +stdout = result.stdout.decode("utf-8") +stderr = result.stderr.decode("utf-8") +print(f"Apply stdout:\n{stdout}") +print(f"Apply stderr:\n{stderr}") + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.mathjax", + "sphinx.ext.ifconfig", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", + "sphinx.ext.napoleon", + "sphinx.ext.autodoc", + "sphinx_rtd_theme", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = ".rst" + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = "Feast" +copyright = "2021, Feast Authors" +author = "Feast Authors" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. + +# TODO: Add the below versions back to documentation building. +# version = ( +# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip() +# ) +# The full version, including alpha/beta/rc tags. +# release = ( +# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip() +# ) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "sphinx_rtd_theme" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = "Feastdoc" + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, "Feast.tex", "Feast Documentation", "Feast Authors", "manual") +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "feast", "Feast Documentation", [author], 1)] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "Feast", + "Feast Documentation", + author, + "Feast", + "One line description of project.", + "Miscellaneous", + ) +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {"https://docs.python.org/": None} diff --git a/sdk/python/docs/source/feast.diff.rst b/sdk/python/docs/source/feast.diff.rst new file mode 100644 index 0000000000..e414217171 --- /dev/null +++ b/sdk/python/docs/source/feast.diff.rst @@ -0,0 +1,37 @@ +feast.diff package +================== + +Submodules +---------- + +feast.diff.infra\_diff module +----------------------------- + +.. automodule:: feast.diff.infra_diff + :members: + :undoc-members: + :show-inheritance: + +feast.diff.property\_diff module +-------------------------------- + +.. automodule:: feast.diff.property_diff + :members: + :undoc-members: + :show-inheritance: + +feast.diff.registry\_diff module +-------------------------------- + +.. automodule:: feast.diff.registry_diff + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.diff + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.dqm.profilers.rst b/sdk/python/docs/source/feast.dqm.profilers.rst new file mode 100644 index 0000000000..24f452ada8 --- /dev/null +++ b/sdk/python/docs/source/feast.dqm.profilers.rst @@ -0,0 +1,29 @@ +feast.dqm.profilers package +=========================== + +Submodules +---------- + +feast.dqm.profilers.ge\_profiler module +--------------------------------------- + +.. automodule:: feast.dqm.profilers.ge_profiler + :members: + :undoc-members: + :show-inheritance: + +feast.dqm.profilers.profiler module +----------------------------------- + +.. automodule:: feast.dqm.profilers.profiler + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.dqm.profilers + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.dqm.rst b/sdk/python/docs/source/feast.dqm.rst new file mode 100644 index 0000000000..0c1b82f0fa --- /dev/null +++ b/sdk/python/docs/source/feast.dqm.rst @@ -0,0 +1,29 @@ +feast.dqm package +================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.dqm.profilers + +Submodules +---------- + +feast.dqm.errors module +----------------------- + +.. automodule:: feast.dqm.errors + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.dqm + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.materialization.contrib.bytewax.rst b/sdk/python/docs/source/feast.infra.materialization.contrib.bytewax.rst new file mode 100644 index 0000000000..86fbaa6151 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.materialization.contrib.bytewax.rst @@ -0,0 +1,29 @@ +feast.infra.materialization.contrib.bytewax package +================================================================= + +Submodules +---------- + +feast.infra.materialization.contrib.bytewax.bytewax\_materialization\_engine +---------------------------------------------------------------------- + +.. automodule:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_engine + :members: + :undoc-members: + :show-inheritance: + +feast.infra.materialization.contrib.bytewax.bytewax\_materialization\_job +---------------------------------------------------------------------- + +.. automodule:: feast.infra.materialization.contrib.bytewax.bytewax_materialization_job + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.materialization.contrib.bytewax + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.materialization.contrib.rst b/sdk/python/docs/source/feast.infra.materialization.contrib.rst new file mode 100644 index 0000000000..f9d7700661 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.materialization.contrib.rst @@ -0,0 +1,10 @@ +feast.infra.materialization.contrib package +========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.materialization.contrib.bytewax diff --git a/sdk/python/docs/source/feast.infra.materialization.lambda.rst b/sdk/python/docs/source/feast.infra.materialization.lambda.rst new file mode 100644 index 0000000000..7ca1d44314 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.materialization.lambda.rst @@ -0,0 +1,29 @@ +feast.infra.materialization.lambda package +========================================== + +Submodules +---------- + +feast.infra.materialization.lambda.app module +--------------------------------------------- + +.. automodule:: feast.infra.materialization.lambda.app + :members: + :undoc-members: + :show-inheritance: + +feast.infra.materialization.lambda.lambda\_engine module +-------------------------------------------------------- + +.. automodule:: feast.infra.materialization.lambda.lambda_engine + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.materialization.lambda + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.materialization.rst b/sdk/python/docs/source/feast.infra.materialization.rst new file mode 100644 index 0000000000..6e526c367c --- /dev/null +++ b/sdk/python/docs/source/feast.infra.materialization.rst @@ -0,0 +1,45 @@ +feast.infra.materialization package +=================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.materialization.lambda + +Submodules +---------- + +feast.infra.materialization.batch\_materialization\_engine module +----------------------------------------------------------------- + +.. automodule:: feast.infra.materialization.batch_materialization_engine + :members: + :undoc-members: + :show-inheritance: + +feast.infra.materialization.local\_engine module +------------------------------------------------ + +.. automodule:: feast.infra.materialization.local_engine + :members: + :undoc-members: + :show-inheritance: + +feast.infra.materialization.snowflake\_engine module +---------------------------------------------------- + +.. automodule:: feast.infra.materialization.snowflake_engine + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.materialization + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.rst new file mode 100644 index 0000000000..d2275b2b39 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.rst @@ -0,0 +1,37 @@ +feast.infra.offline\_stores.contrib.athena\_offline\_store package +================================================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib.athena_offline_store.tests + +Submodules +---------- + +feast.infra.offline\_stores.contrib.athena\_offline\_store.athena module +------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.athena_offline_store.athena + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.athena\_offline\_store.athena\_source module +-------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.athena_offline_store.athena_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.athena_offline_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.tests.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.tests.rst new file mode 100644 index 0000000000..47a8f83e2b --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.athena_offline_store.tests.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.athena\_offline\_store.tests package +======================================================================== + +Submodules +---------- + +feast.infra.offline\_stores.contrib.athena\_offline\_store.tests.data\_source module +------------------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.athena_offline_store.tests.data_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.athena_offline_store.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.rst new file mode 100644 index 0000000000..8fb0b966bf --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.rst @@ -0,0 +1,37 @@ +feast.infra.offline\_stores.contrib.mssql\_offline\_store package +================================================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib.mssql_offline_store.tests + +Submodules +---------- + +feast.infra.offline\_stores.contrib.mssql\_offline\_store.mssql module +---------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.mssql + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.mssql\_offline\_store.mssqlserver\_source module +------------------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.mssqlserver_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.tests.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.tests.rst new file mode 100644 index 0000000000..2f01ddd091 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.mssql_offline_store.tests.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.mssql\_offline\_store.tests package +======================================================================= + +Submodules +---------- + +feast.infra.offline\_stores.contrib.mssql\_offline\_store.tests.data\_source module +----------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.tests.data_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.mssql_offline_store.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.rst new file mode 100644 index 0000000000..a80690fe85 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.rst @@ -0,0 +1,37 @@ +feast.infra.offline\_stores.contrib.postgres\_offline\_store package +==================================================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib.postgres_offline_store.tests + +Submodules +---------- + +feast.infra.offline\_stores.contrib.postgres\_offline\_store.postgres module +---------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.postgres\_offline\_store.postgres\_source module +------------------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.tests.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.tests.rst new file mode 100644 index 0000000000..35e60d2998 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.postgres_offline_store.tests.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.postgres\_offline\_store.tests package +========================================================================== + +Submodules +---------- + +feast.infra.offline\_stores.contrib.postgres\_offline\_store.tests.data\_source module +-------------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.tests.data_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.rst new file mode 100644 index 0000000000..ec74ddab05 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.rst @@ -0,0 +1,65 @@ +feast.infra.offline\_stores.contrib package +=========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib.athena_offline_store + feast.infra.offline_stores.contrib.mssql_offline_store + feast.infra.offline_stores.contrib.postgres_offline_store + feast.infra.offline_stores.contrib.spark_offline_store + feast.infra.offline_stores.contrib.trino_offline_store + +Submodules +---------- + +feast.infra.offline\_stores.contrib.athena\_repo\_configuration module +---------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.athena_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.mssql\_repo\_configuration module +--------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.mssql_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.postgres\_repo\_configuration module +------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.postgres_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.spark\_repo\_configuration module +--------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.spark_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.trino\_repo\_configuration module +--------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.rst new file mode 100644 index 0000000000..b8b79bb48e --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.rst @@ -0,0 +1,37 @@ +feast.infra.offline\_stores.contrib.spark\_offline\_store package +================================================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib.spark_offline_store.tests + +Submodules +---------- + +feast.infra.offline\_stores.contrib.spark\_offline\_store.spark module +---------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.spark\_offline\_store.spark\_source module +------------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.tests.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.tests.rst new file mode 100644 index 0000000000..8b0f9bd88b --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.spark_offline_store.tests.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.spark\_offline\_store.tests package +======================================================================= + +Submodules +---------- + +feast.infra.offline\_stores.contrib.spark\_offline\_store.tests.data\_source module +----------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.tests.data_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.connectors.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.connectors.rst new file mode 100644 index 0000000000..a0ee8dceab --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.connectors.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.trino\_offline\_store.connectors package +============================================================================ + +Submodules +---------- + +feast.infra.offline\_stores.contrib.trino\_offline\_store.connectors.upload module +---------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.connectors.upload + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.connectors + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.rst new file mode 100644 index 0000000000..857326003f --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.rst @@ -0,0 +1,55 @@ +feast.infra.offline\_stores.contrib.trino\_offline\_store package +================================================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib.trino_offline_store.connectors + feast.infra.offline_stores.contrib.trino_offline_store.test_config + feast.infra.offline_stores.contrib.trino_offline_store.tests + +Submodules +---------- + +feast.infra.offline\_stores.contrib.trino\_offline\_store.trino module +---------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_queries module +------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_queries + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_source module +------------------------------------------------------------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.contrib.trino\_offline\_store.trino\_type\_map module +--------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_type_map + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.test_config.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.test_config.rst new file mode 100644 index 0000000000..ef43a191d0 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.test_config.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.trino\_offline\_store.test\_config package +============================================================================== + +Submodules +---------- + +feast.infra.offline\_stores.contrib.trino\_offline\_store.test\_config.manual\_tests module +------------------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.test_config.manual_tests + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.test_config + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.tests.rst b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.tests.rst new file mode 100644 index 0000000000..9102f1f8d6 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.contrib.trino_offline_store.tests.rst @@ -0,0 +1,21 @@ +feast.infra.offline\_stores.contrib.trino\_offline\_store.tests package +======================================================================= + +Submodules +---------- + +feast.infra.offline\_stores.contrib.trino\_offline\_store.tests.data\_source module +----------------------------------------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.tests.data_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.tests + :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 new file mode 100644 index 0000000000..7949c9efb3 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.offline_stores.rst @@ -0,0 +1,101 @@ +feast.infra.offline\_stores package +=================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.offline_stores.contrib + +Submodules +---------- + +feast.infra.offline\_stores.bigquery module +------------------------------------------- + +.. automodule:: feast.infra.offline_stores.bigquery + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.bigquery\_source module +--------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.bigquery_source + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.file module +--------------------------------------- + +.. automodule:: feast.infra.offline_stores.file + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.file\_source module +----------------------------------------------- + +.. automodule:: feast.infra.offline_stores.file_source + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.offline\_store module +------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.offline_store + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.offline\_utils module +------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.offline_utils + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.redshift module +------------------------------------------- + +.. automodule:: feast.infra.offline_stores.redshift + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.redshift\_source module +--------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.redshift_source + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.snowflake module +-------------------------------------------- + +.. automodule:: feast.infra.offline_stores.snowflake + :members: + :undoc-members: + :show-inheritance: + +feast.infra.offline\_stores.snowflake\_source module +---------------------------------------------------- + +.. automodule:: feast.infra.offline_stores.snowflake_source + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.offline_stores + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.online_stores.contrib.cassandra_online_store.rst b/sdk/python/docs/source/feast.infra.online_stores.contrib.cassandra_online_store.rst new file mode 100644 index 0000000000..3770cc8af7 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.online_stores.contrib.cassandra_online_store.rst @@ -0,0 +1,21 @@ +feast.infra.online\_stores.contrib.cassandra\_online\_store package +=================================================================== + +Submodules +---------- + +feast.infra.online\_stores.contrib.cassandra\_online\_store.cassandra\_online\_store module +------------------------------------------------------------------------------------------- + +.. automodule:: feast.infra.online_stores.contrib.cassandra_online_store.cassandra_online_store + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.online_stores.contrib.cassandra_online_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.online_stores.contrib.hbase_online_store.rst b/sdk/python/docs/source/feast.infra.online_stores.contrib.hbase_online_store.rst new file mode 100644 index 0000000000..ce24902304 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.online_stores.contrib.hbase_online_store.rst @@ -0,0 +1,21 @@ +feast.infra.online\_stores.contrib.hbase\_online\_store package +=============================================================== + +Submodules +---------- + +feast.infra.online\_stores.contrib.hbase\_online\_store.hbase module +-------------------------------------------------------------------- + +.. automodule:: feast.infra.online_stores.contrib.hbase_online_store.hbase + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.online_stores.contrib.hbase_online_store + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.online_stores.contrib.rst b/sdk/python/docs/source/feast.infra.online_stores.contrib.rst new file mode 100644 index 0000000000..6afe9071ac --- /dev/null +++ b/sdk/python/docs/source/feast.infra.online_stores.contrib.rst @@ -0,0 +1,54 @@ +feast.infra.online\_stores.contrib package +========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.online_stores.contrib.cassandra_online_store + feast.infra.online_stores.contrib.hbase_online_store + +Submodules +---------- + +feast.infra.online\_stores.contrib.cassandra\_repo\_configuration module +------------------------------------------------------------------------ + +.. automodule:: feast.infra.online_stores.contrib.cassandra_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.contrib.hbase\_repo\_configuration module +-------------------------------------------------------------------- + +.. automodule:: feast.infra.online_stores.contrib.hbase_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.contrib.postgres module +-------------------------------------------------- + +.. automodule:: feast.infra.online_stores.contrib.postgres + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.contrib.postgres\_repo\_configuration module +----------------------------------------------------------------------- + +.. automodule:: feast.infra.online_stores.contrib.postgres_repo_configuration + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.online_stores.contrib + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.online_stores.rst b/sdk/python/docs/source/feast.infra.online_stores.rst new file mode 100644 index 0000000000..65758c409c --- /dev/null +++ b/sdk/python/docs/source/feast.infra.online_stores.rst @@ -0,0 +1,77 @@ +feast.infra.online\_stores package +================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.online_stores.contrib + +Submodules +---------- + +feast.infra.online\_stores.datastore module +------------------------------------------- + +.. automodule:: feast.infra.online_stores.datastore + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.dynamodb module +------------------------------------------ + +.. automodule:: feast.infra.online_stores.dynamodb + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.helpers module +----------------------------------------- + +.. automodule:: feast.infra.online_stores.helpers + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.online\_store module +----------------------------------------------- + +.. automodule:: feast.infra.online_stores.online_store + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.redis module +--------------------------------------- + +.. automodule:: feast.infra.online_stores.redis + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.snowflake module +------------------------------------------- + +.. automodule:: feast.infra.online_stores.snowflake + :members: + :undoc-members: + :show-inheritance: + +feast.infra.online\_stores.sqlite module +---------------------------------------- + +.. automodule:: feast.infra.online_stores.sqlite + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.online_stores + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.registry.rst b/sdk/python/docs/source/feast.infra.registry.rst new file mode 100644 index 0000000000..7a2d968997 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.registry.rst @@ -0,0 +1,69 @@ +feast.infra.registry package +============================ + +Submodules +---------- + +feast.infra.registry.base\_registry module +------------------------------------------ + +.. automodule:: feast.infra.registry.base_registry + :members: + :undoc-members: + :show-inheritance: + +feast.infra.registry.file module +-------------------------------- + +.. automodule:: feast.infra.registry.file + :members: + :undoc-members: + :show-inheritance: + +feast.infra.registry.gcs module +------------------------------- + +.. automodule:: feast.infra.registry.gcs + :members: + :undoc-members: + :show-inheritance: + +feast.infra.registry.registry module +------------------------------------ + +.. automodule:: feast.infra.registry.registry + :members: + :undoc-members: + :show-inheritance: + +feast.infra.registry.registry\_store module +------------------------------------------- + +.. automodule:: feast.infra.registry.registry_store + :members: + :undoc-members: + :show-inheritance: + +feast.infra.registry.s3 module +------------------------------ + +.. automodule:: feast.infra.registry.s3 + :members: + :undoc-members: + :show-inheritance: + +feast.infra.registry.sql module +------------------------------- + +.. automodule:: feast.infra.registry.sql + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.registry + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.registry_stores.rst b/sdk/python/docs/source/feast.infra.registry_stores.rst new file mode 100644 index 0000000000..cff02fa338 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.registry_stores.rst @@ -0,0 +1,21 @@ +feast.infra.registry\_stores package +==================================== + +Submodules +---------- + +feast.infra.registry\_stores.sql module +--------------------------------------- + +.. automodule:: feast.infra.registry_stores.sql + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.registry_stores + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.rst b/sdk/python/docs/source/feast.infra.rst new file mode 100644 index 0000000000..96c0828451 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.rst @@ -0,0 +1,81 @@ +feast.infra package +=================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.materialization + feast.infra.offline_stores + feast.infra.online_stores + feast.infra.registry + feast.infra.utils + +Submodules +---------- + +feast.infra.aws module +---------------------- + +.. automodule:: feast.infra.aws + :members: + :undoc-members: + :show-inheritance: + +feast.infra.gcp module +---------------------- + +.. automodule:: feast.infra.gcp + :members: + :undoc-members: + :show-inheritance: + +feast.infra.infra\_object module +-------------------------------- + +.. automodule:: feast.infra.infra_object + :members: + :undoc-members: + :show-inheritance: + +feast.infra.key\_encoding\_utils module +--------------------------------------- + +.. automodule:: feast.infra.key_encoding_utils + :members: + :undoc-members: + :show-inheritance: + +feast.infra.local module +------------------------ + +.. automodule:: feast.infra.local + :members: + :undoc-members: + :show-inheritance: + +feast.infra.passthrough\_provider module +---------------------------------------- + +.. automodule:: feast.infra.passthrough_provider + :members: + :undoc-members: + :show-inheritance: + +feast.infra.provider module +--------------------------- + +.. automodule:: feast.infra.provider + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.utils.postgres.rst b/sdk/python/docs/source/feast.infra.utils.postgres.rst new file mode 100644 index 0000000000..119c8c1dee --- /dev/null +++ b/sdk/python/docs/source/feast.infra.utils.postgres.rst @@ -0,0 +1,29 @@ +feast.infra.utils.postgres package +================================== + +Submodules +---------- + +feast.infra.utils.postgres.connection\_utils module +--------------------------------------------------- + +.. automodule:: feast.infra.utils.postgres.connection_utils + :members: + :undoc-members: + :show-inheritance: + +feast.infra.utils.postgres.postgres\_config module +-------------------------------------------------- + +.. automodule:: feast.infra.utils.postgres.postgres_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.utils.postgres + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.infra.utils.rst b/sdk/python/docs/source/feast.infra.utils.rst new file mode 100644 index 0000000000..e4116e7a17 --- /dev/null +++ b/sdk/python/docs/source/feast.infra.utils.rst @@ -0,0 +1,37 @@ +feast.infra.utils package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.infra.utils.postgres + +Submodules +---------- + +feast.infra.utils.aws\_utils module +----------------------------------- + +.. automodule:: feast.infra.utils.aws_utils + :members: + :undoc-members: + :show-inheritance: + +feast.infra.utils.hbase\_utils module +------------------------------------- + +.. automodule:: feast.infra.utils.hbase_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.infra.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.loaders.rst b/sdk/python/docs/source/feast.loaders.rst new file mode 100644 index 0000000000..d4968a2999 --- /dev/null +++ b/sdk/python/docs/source/feast.loaders.rst @@ -0,0 +1,21 @@ +feast.loaders package +===================== + +Submodules +---------- + +feast.loaders.yaml module +------------------------- + +.. automodule:: feast.loaders.yaml + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.loaders + :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 new file mode 100644 index 0000000000..aaed49cd73 --- /dev/null +++ b/sdk/python/docs/source/feast.protos.feast.core.rst @@ -0,0 +1,333 @@ +feast.protos.feast.core package +=============================== + +Submodules +---------- + +feast.protos.feast.core.Aggregation\_pb2 module +----------------------------------------------- + +.. automodule:: feast.protos.feast.core.Aggregation_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Aggregation\_pb2\_grpc module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.core.Aggregation_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.DataFormat\_pb2 module +---------------------------------------------- + +.. automodule:: feast.protos.feast.core.DataFormat_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.DataFormat\_pb2\_grpc module +---------------------------------------------------- + +.. automodule:: feast.protos.feast.core.DataFormat_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.DataSource\_pb2 module +---------------------------------------------- + +.. automodule:: feast.protos.feast.core.DataSource_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.DataSource\_pb2\_grpc module +---------------------------------------------------- + +.. automodule:: feast.protos.feast.core.DataSource_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.DatastoreTable\_pb2 module +-------------------------------------------------- + +.. automodule:: feast.protos.feast.core.DatastoreTable_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.DatastoreTable\_pb2\_grpc module +-------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.DatastoreTable_pb2_grpc + :members: + :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 +------------------------------------------ + +.. automodule:: feast.protos.feast.core.Entity_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Entity\_pb2\_grpc module +------------------------------------------------ + +.. automodule:: feast.protos.feast.core.Entity_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureService\_pb2 module +-------------------------------------------------- + +.. automodule:: feast.protos.feast.core.FeatureService_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureService\_pb2\_grpc module +-------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.FeatureService_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureTable\_pb2 module +------------------------------------------------ + +.. automodule:: feast.protos.feast.core.FeatureTable_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureTable\_pb2\_grpc module +------------------------------------------------------ + +.. automodule:: feast.protos.feast.core.FeatureTable_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureViewProjection\_pb2 module +--------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.FeatureViewProjection_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureViewProjection\_pb2\_grpc module +--------------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.FeatureViewProjection_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureView\_pb2 module +----------------------------------------------- + +.. automodule:: feast.protos.feast.core.FeatureView_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.FeatureView\_pb2\_grpc module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.core.FeatureView_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Feature\_pb2 module +------------------------------------------- + +.. automodule:: feast.protos.feast.core.Feature_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Feature\_pb2\_grpc module +------------------------------------------------- + +.. automodule:: feast.protos.feast.core.Feature_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.InfraObject\_pb2 module +----------------------------------------------- + +.. automodule:: feast.protos.feast.core.InfraObject_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.InfraObject\_pb2\_grpc module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.core.InfraObject_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.OnDemandFeatureView\_pb2 module +------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.OnDemandFeatureView_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.OnDemandFeatureView\_pb2\_grpc module +------------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.OnDemandFeatureView_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Registry\_pb2 module +-------------------------------------------- + +.. automodule:: feast.protos.feast.core.Registry_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Registry\_pb2\_grpc module +-------------------------------------------------- + +.. automodule:: feast.protos.feast.core.Registry_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.RequestFeatureView\_pb2 module +------------------------------------------------------ + +.. automodule:: feast.protos.feast.core.RequestFeatureView_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.RequestFeatureView\_pb2\_grpc module +------------------------------------------------------------ + +.. automodule:: feast.protos.feast.core.RequestFeatureView_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.SavedDataset\_pb2 module +------------------------------------------------ + +.. automodule:: feast.protos.feast.core.SavedDataset_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.SavedDataset\_pb2\_grpc module +------------------------------------------------------ + +.. automodule:: feast.protos.feast.core.SavedDataset_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.SqliteTable\_pb2 module +----------------------------------------------- + +.. automodule:: feast.protos.feast.core.SqliteTable_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.SqliteTable\_pb2\_grpc module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.core.SqliteTable_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Store\_pb2 module +----------------------------------------- + +.. automodule:: feast.protos.feast.core.Store_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.Store\_pb2\_grpc module +----------------------------------------------- + +.. automodule:: feast.protos.feast.core.Store_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.StreamFeatureView\_pb2 module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.core.StreamFeatureView_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.StreamFeatureView\_pb2\_grpc module +----------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.StreamFeatureView_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.ValidationProfile\_pb2 module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.core.ValidationProfile_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.core.ValidationProfile\_pb2\_grpc module +----------------------------------------------------------- + +.. automodule:: feast.protos.feast.core.ValidationProfile_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.protos.feast.core + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.protos.feast.rst b/sdk/python/docs/source/feast.protos.feast.rst new file mode 100644 index 0000000000..f519165db8 --- /dev/null +++ b/sdk/python/docs/source/feast.protos.feast.rst @@ -0,0 +1,21 @@ +feast.protos.feast package +========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.protos.feast.core + feast.protos.feast.serving + feast.protos.feast.storage + feast.protos.feast.types + +Module contents +--------------- + +.. automodule:: feast.protos.feast + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.protos.feast.serving.rst b/sdk/python/docs/source/feast.protos.feast.serving.rst new file mode 100644 index 0000000000..792335b189 --- /dev/null +++ b/sdk/python/docs/source/feast.protos.feast.serving.rst @@ -0,0 +1,61 @@ +feast.protos.feast.serving package +================================== + +Submodules +---------- + +feast.protos.feast.serving.Connector\_pb2 module +------------------------------------------------ + +.. automodule:: feast.protos.feast.serving.Connector_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.serving.Connector\_pb2\_grpc module +------------------------------------------------------ + +.. automodule:: feast.protos.feast.serving.Connector_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.serving.ServingService\_pb2 module +----------------------------------------------------- + +.. automodule:: feast.protos.feast.serving.ServingService_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.serving.ServingService\_pb2\_grpc module +----------------------------------------------------------- + +.. automodule:: feast.protos.feast.serving.ServingService_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.serving.TransformationService\_pb2 module +------------------------------------------------------------ + +.. automodule:: feast.protos.feast.serving.TransformationService_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.serving.TransformationService\_pb2\_grpc module +------------------------------------------------------------------ + +.. automodule:: feast.protos.feast.serving.TransformationService_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.protos.feast.serving + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.protos.feast.storage.rst b/sdk/python/docs/source/feast.protos.feast.storage.rst new file mode 100644 index 0000000000..90bc1adc9b --- /dev/null +++ b/sdk/python/docs/source/feast.protos.feast.storage.rst @@ -0,0 +1,29 @@ +feast.protos.feast.storage package +================================== + +Submodules +---------- + +feast.protos.feast.storage.Redis\_pb2 module +-------------------------------------------- + +.. automodule:: feast.protos.feast.storage.Redis_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.storage.Redis\_pb2\_grpc module +-------------------------------------------------- + +.. automodule:: feast.protos.feast.storage.Redis_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.protos.feast.storage + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.protos.feast.types.rst b/sdk/python/docs/source/feast.protos.feast.types.rst new file mode 100644 index 0000000000..aeb31bc9ad --- /dev/null +++ b/sdk/python/docs/source/feast.protos.feast.types.rst @@ -0,0 +1,61 @@ +feast.protos.feast.types package +================================ + +Submodules +---------- + +feast.protos.feast.types.EntityKey\_pb2 module +---------------------------------------------- + +.. automodule:: feast.protos.feast.types.EntityKey_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.types.EntityKey\_pb2\_grpc module +---------------------------------------------------- + +.. automodule:: feast.protos.feast.types.EntityKey_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.types.Field\_pb2 module +------------------------------------------ + +.. automodule:: feast.protos.feast.types.Field_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.types.Field\_pb2\_grpc module +------------------------------------------------ + +.. automodule:: feast.protos.feast.types.Field_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.types.Value\_pb2 module +------------------------------------------ + +.. automodule:: feast.protos.feast.types.Value_pb2 + :members: + :undoc-members: + :show-inheritance: + +feast.protos.feast.types.Value\_pb2\_grpc module +------------------------------------------------ + +.. automodule:: feast.protos.feast.types.Value_pb2_grpc + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast.protos.feast.types + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.protos.rst b/sdk/python/docs/source/feast.protos.rst new file mode 100644 index 0000000000..7bec91eb03 --- /dev/null +++ b/sdk/python/docs/source/feast.protos.rst @@ -0,0 +1,18 @@ +feast.protos package +==================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.protos.feast + +Module contents +--------------- + +.. automodule:: feast.protos + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.rst b/sdk/python/docs/source/feast.rst new file mode 100644 index 0000000000..b0ed92c4cc --- /dev/null +++ b/sdk/python/docs/source/feast.rst @@ -0,0 +1,378 @@ +feast package +============= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + feast.diff + feast.dqm + feast.infra + feast.loaders + feast.protos + feast.ui + +Submodules +---------- + +feast.aggregation module +------------------------ + +.. automodule:: feast.aggregation + :members: + :undoc-members: + :show-inheritance: + +feast.base\_feature\_view module +-------------------------------- + +.. automodule:: feast.base_feature_view + :members: + :undoc-members: + :show-inheritance: + +feast.batch\_feature\_view module +--------------------------------- + +.. automodule:: feast.batch_feature_view + :members: + :undoc-members: + :show-inheritance: + +feast.cli module +---------------- + +.. automodule:: feast.cli + :members: + :undoc-members: + :show-inheritance: + +feast.constants module +---------------------- + +.. automodule:: feast.constants + :members: + :undoc-members: + :show-inheritance: + +feast.data\_format module +------------------------- + +.. automodule:: feast.data_format + :members: + :undoc-members: + :show-inheritance: + +feast.data\_source module +------------------------- + +.. automodule:: feast.data_source + :members: + :undoc-members: + :show-inheritance: + +feast.driver\_test\_data module +------------------------------- + +.. automodule:: feast.driver_test_data + :members: + :undoc-members: + :show-inheritance: + +feast.entity module +------------------- + +.. automodule:: feast.entity + :members: + :undoc-members: + :show-inheritance: + +feast.errors module +------------------- + +.. automodule:: feast.errors + :members: + :undoc-members: + :show-inheritance: + +feast.feast\_object module +-------------------------- + +.. automodule:: feast.feast_object + :members: + :undoc-members: + :show-inheritance: + +feast.feature module +-------------------- + +.. automodule:: feast.feature + :members: + :undoc-members: + :show-inheritance: + +feast.feature\_logging module +----------------------------- + +.. automodule:: feast.feature_logging + :members: + :undoc-members: + :show-inheritance: + +feast.feature\_server module +---------------------------- + +.. automodule:: feast.feature_server + :members: + :undoc-members: + :show-inheritance: + +feast.feature\_service module +----------------------------- + +.. automodule:: feast.feature_service + :members: + :undoc-members: + :show-inheritance: + +feast.feature\_store module +--------------------------- + +.. automodule:: feast.feature_store + :members: + :undoc-members: + :show-inheritance: + +feast.feature\_view module +-------------------------- + +.. automodule:: feast.feature_view + :members: + :undoc-members: + :show-inheritance: + +feast.feature\_view\_projection module +-------------------------------------- + +.. automodule:: feast.feature_view_projection + :members: + :undoc-members: + :show-inheritance: + +feast.field module +------------------ + +.. automodule:: feast.field + :members: + :undoc-members: + :show-inheritance: + +feast.file\_utils module +------------------------ + +.. automodule:: feast.file_utils + :members: + :undoc-members: + :show-inheritance: + +feast.flags\_helper module +-------------------------- + +.. automodule:: feast.flags_helper + :members: + :undoc-members: + :show-inheritance: + +feast.importer module +--------------------- + +.. automodule:: feast.importer + :members: + :undoc-members: + :show-inheritance: + +feast.inference module +---------------------- + +.. automodule:: feast.inference + :members: + :undoc-members: + :show-inheritance: + +feast.names module +------------------ + +.. automodule:: feast.names + :members: + :undoc-members: + :show-inheritance: + +feast.on\_demand\_feature\_view module +-------------------------------------- + +.. automodule:: feast.on_demand_feature_view + :members: + :undoc-members: + :show-inheritance: + +feast.online\_response module +----------------------------- + +.. automodule:: feast.online_response + :members: + :undoc-members: + :show-inheritance: + +feast.project\_metadata module +------------------------------ + +.. automodule:: feast.project_metadata + :members: + :undoc-members: + :show-inheritance: + +feast.proto\_json module +------------------------ + +.. automodule:: feast.proto_json + :members: + :undoc-members: + :show-inheritance: + +feast.repo\_config module +------------------------- + +.. automodule:: feast.repo_config + :members: + :undoc-members: + :show-inheritance: + +feast.repo\_contents module +--------------------------- + +.. automodule:: feast.repo_contents + :members: + :undoc-members: + :show-inheritance: + +feast.repo\_operations module +----------------------------- + +.. automodule:: feast.repo_operations + :members: + :undoc-members: + :show-inheritance: + +feast.repo\_upgrade module +-------------------------- + +.. automodule:: feast.repo_upgrade + :members: + :undoc-members: + :show-inheritance: + +feast.request\_feature\_view module +----------------------------------- + +.. automodule:: feast.request_feature_view + :members: + :undoc-members: + :show-inheritance: + +feast.saved\_dataset module +--------------------------- + +.. automodule:: feast.saved_dataset + :members: + :undoc-members: + :show-inheritance: + +feast.stream\_feature\_view module +---------------------------------- + +.. automodule:: feast.stream_feature_view + :members: + :undoc-members: + :show-inheritance: + +feast.transformation\_server module +----------------------------------- + +.. automodule:: feast.transformation_server + :members: + :undoc-members: + :show-inheritance: + +feast.type\_map module +---------------------- + +.. automodule:: feast.type_map + :members: + :undoc-members: + :show-inheritance: + +feast.types module +------------------ + +.. automodule:: feast.types + :members: + :undoc-members: + :show-inheritance: + +feast.ui\_server module +----------------------- + +.. automodule:: feast.ui_server + :members: + :undoc-members: + :show-inheritance: + +feast.usage module +------------------ + +.. automodule:: feast.usage + :members: + :undoc-members: + :show-inheritance: + +feast.utils module +------------------ + +.. automodule:: feast.utils + :members: + :undoc-members: + :show-inheritance: + +feast.value\_type module +------------------------ + +.. automodule:: feast.value_type + :members: + :undoc-members: + :show-inheritance: + +feast.version module +-------------------- + +.. automodule:: feast.version + :members: + :undoc-members: + :show-inheritance: + +feast.wait module +----------------- + +.. automodule:: feast.wait + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: feast + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/feast.ui.rst b/sdk/python/docs/source/feast.ui.rst new file mode 100644 index 0000000000..01b16cb0a6 --- /dev/null +++ b/sdk/python/docs/source/feast.ui.rst @@ -0,0 +1,10 @@ +feast.ui package +================ + +Module contents +--------------- + +.. automodule:: feast.ui + :members: + :undoc-members: + :show-inheritance: diff --git a/sdk/python/docs/source/index.rst b/sdk/python/docs/source/index.rst new file mode 100644 index 0000000000..58823d2fe1 --- /dev/null +++ b/sdk/python/docs/source/index.rst @@ -0,0 +1,353 @@ +Feast Python API Documentation +============================== + + +Feature Store +================== + +.. automodule:: feast.feature_store + :members: + :undoc-members: + :show-inheritance: + +Config +================== + +.. automodule:: feast.repo_config + :members: + :exclude-members: load_repo_config, FeastBaseModel + +Data Source +================== + +.. automodule:: feast.data_source + :inherited-members: + :members: + :exclude-members: KafkaOptions, KafkaSource, KinesisOptions, KinesisSource, PushSource, RequestSource, RequestDataSource + +Request Source +------------------ + +.. automodule:: feast.data_source + :members: RequestSource + +Push Source +------------------ + +.. automodule:: feast.data_source + :members: PushSource + +BigQuery Source +------------------ + +.. automodule:: feast.infra.offline_stores.bigquery_source + :members: + :exclude-members: BigQueryOptions + +Redshift Source +------------------ + +.. automodule:: feast.infra.offline_stores.redshift_source + :members: + :exclude-members: RedshiftOptions + +Snowflake Source +------------------ + +.. automodule:: feast.infra.offline_stores.snowflake_source + :members: + :exclude-members: SnowflakeOptions + +Spark Source +------------------ + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark_source + :members: + :exclude-members: SparkOptions + +Trino Source +------------------ + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino_source + :members: + :exclude-members: TrinoOptions + +PostgreSQL Source +------------------ + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres_source + :members: + :exclude-members: PostgreSQLOptions + +File Source +------------------ + +.. automodule:: feast.infra.offline_stores.file_source + :members: + :exclude-members: FileOptions + +Entity +================== + +.. automodule:: feast.entity + :inherited-members: + :members: + +Feature View +================== + +.. automodule:: feast.base_feature_view + :members: + +Feature View +---------------------- + +.. automodule:: feast.feature_view + :members: + +On Demand Feature View +---------------------- + +.. automodule:: feast.on_demand_feature_view + :members: + +Stream Feature View +---------------------- + +.. automodule:: feast.stream_feature_view + :members: + +Feature +================== + +.. automodule:: feast.feature + :inherited-members: + :members: + +Feature Service +================== + +.. automodule:: feast.feature_service + :inherited-members: + :members: + +Registry +================== + +.. automodule:: feast.infra.registry.base_registry + :inherited-members: + :members: + +Registry +---------------------- + +.. automodule:: feast.infra.registry.registry + :inherited-members: + :members: + +SQL Registry +---------------------- + +.. automodule:: feast.infra.registry.sql + :inherited-members: + :members: + +Registry Store +================== + +.. automodule:: feast.infra.registry.registry_store + :inherited-members: + :members: + :exclude-members: NoopRegistryStore + +File Registry Store +----------------------- + +.. automodule:: feast.infra.registry.file + :members: + :noindex: + +GCS Registry Store +----------------------- + +.. automodule:: feast.infra.registry.gcs + :members: + :noindex: + +S3 Registry Store +----------------------- + +.. automodule:: feast.infra.registry.s3 + :members: + :noindex: + +PostgreSQL Registry Store +----------------------- + +.. automodule:: feast.infra.registry.contrib.postgres.postgres_registry_store + :members: + :noindex: + +Provider +================== + +.. automodule:: feast.infra.provider + :inherited-members: + :members: + +Passthrough Provider +-------------------- + +.. automodule:: feast.infra.passthrough_provider + :members: + +Local Provider +------------------ + +.. automodule:: feast.infra.local + :members: + +GCP Provider +------------------ + +.. automodule:: feast.infra.gcp + :members: + +AWS Provider +------------------ + +.. automodule:: feast.infra.aws + :members: + +Offline Store +================== + +.. automodule:: feast.infra.offline_stores.offline_store + :members: + +File Offline Store +------------------ + +.. automodule:: feast.infra.offline_stores.file + :members: + +BigQuery Offline Store +---------------------- + +.. automodule:: feast.infra.offline_stores.bigquery + :members: + +Redshift Offline Store +---------------------- + +.. automodule:: feast.infra.offline_stores.redshift + :members: + +Snowflake Offline Store +----------------------- + +.. automodule:: feast.infra.offline_stores.snowflake + :members: + +Spark Offline Store +------------------- + +.. automodule:: feast.infra.offline_stores.contrib.spark_offline_store.spark + :members: + +Trino Offline Store +------------------- + +.. automodule:: feast.infra.offline_stores.contrib.trino_offline_store.trino + :members: + +PostgreSQL Offline Store +------------------------ + +.. automodule:: feast.infra.offline_stores.contrib.postgres_offline_store.postgres + :members: + + +Online Store +================== + +.. automodule:: feast.infra.online_stores.online_store + :inherited-members: + :members: + +Sqlite Online Store +------------------- + +.. automodule:: feast.infra.online_stores.sqlite + :members: + :noindex: + +Datastore Online Store +---------------------- + +.. automodule:: feast.infra.online_stores.datastore + :members: + :noindex: + +DynamoDB Online Store +--------------------- + +.. automodule:: feast.infra.online_stores.dynamodb + :members: + :noindex: + +Redis Online Store +------------------ + +.. automodule:: feast.infra.online_stores.redis + :members: + :noindex: + +PostgreSQL Online Store +----------------------- + +.. automodule:: feast.infra.online_stores.contrib.postgres + :members: + :noindex: + +HBase Online Store +----------------------- + +.. automodule:: feast.infra.online_stores.contrib.hbase_online_store.hbase + :members: + :noindex: + +Cassandra Online Store +----------------------- + +.. automodule:: feast.infra.online_stores.contrib.cassandra_online_store.cassandra_online_store + :members: + :noindex: + + +Batch Materialization Engine +============================ + +.. automodule:: feast.infra.materialization + :members: BatchMaterializationEngine, MaterializationJob, MaterializationTask + +Local Engine +------------ +.. autoclass:: feast.infra.materialization.LocalMaterializationEngine + :members: + :noindex: + +(Alpha) Lambda Based Engine +--------------------------- + +.. automodule:: feast.infra.materialization.lambda.lambda_engine + :members: + :noindex: + + +Bytewax Engine +--------------------------- + +.. automodule:: feast.infra.materialization.contrib.bytewax + :members: + :noindex: diff --git a/sdk/python/docs/source/modules.rst b/sdk/python/docs/source/modules.rst new file mode 100644 index 0000000000..3a6f8333ab --- /dev/null +++ b/sdk/python/docs/source/modules.rst @@ -0,0 +1,7 @@ +feast +===== + +.. toctree:: + :maxdepth: 4 + + feast