Skip to content

chore: Updated python documentation #5347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
franciscojavierarceo merged 1 commit into from
May 13, 2025
Merged

chore: Updated python documentation #5347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion infra/templates/README.md.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

[![PyPI - Downloads](https://img.shields.io/pypi/dm/feast)](https://pypi.org/project/feast/)
[![GitHub contributors](https://img.shields.io/github/contributors/feast-dev/feast)](https://github.com/feast-dev/feast/graphs/contributors)
[![unit-tests](https://github.com/feast-dev/feast/actions/workflows/unit_tests.yml/badge.svg?branch=master)](https://github.com/feast-dev/feast/actions/workflows/unit_tests.yml)
[![unit-tests](https://github.com/feast-dev/feast/actions/workflows/unit_tests.yml/badge.svg?branch=master&event=pull_request)](https://github.com/feast-dev/feast/actions/workflows/unit_tests.yml)
[![integration-tests-and-build](https://github.com/feast-dev/feast/actions/workflows/master_only.yml/badge.svg?branch=master&event=push)](https://github.com/feast-dev/feast/actions/workflows/master_only.yml)
[![java-integration-tests](https://github.com/feast-dev/feast/actions/workflows/java_master_only.yml/badge.svg?branch=master&event=push)](https://github.com/feast-dev/feast/actions/workflows/java_master_only.yml)
[![linter](https://github.com/feast-dev/feast/actions/workflows/linter.yml/badge.svg?branch=master&event=push)](https://github.com/feast-dev/feast/actions/workflows/linter.yml)
Expand All @@ -19,6 +19,8 @@
## Join us on Slack!
👋👋👋 [Come say hi on Slack!](https://communityinviter.com/apps/feastopensource/feast-the-open-source-feature-store)

[Check out our DeepWiki!](https://deepwiki.com/feast-dev/feast)

## Overview

Feast (**Fea**ture **St**ore) is an open source feature store for machine learning. Feast is the fastest path to manage existing infrastructure to productionize analytic data for model training and online inference.
Expand Down Expand Up @@ -181,3 +183,4 @@ Thanks goes to these incredible people:
<a href="https://github.com/feast-dev/feast/graphs/contributors">
<img src="https://contrib.rocks/image?repo=feast-dev/feast" />
</a>

3 changes: 3 additions & 0 deletions sdk/python/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import os
import sys

import sphinx_rtd_theme

sys.path.insert(0, os.path.abspath("../../feast"))
sys.path.insert(0, os.path.abspath("../.."))

Expand All @@ -30,6 +32,7 @@
# 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
Expand Down
85 changes: 85 additions & 0 deletions sdk/python/docs/source/feast.api.registry.rest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
feast.api.registry.rest package
===============================

Submodules
----------

feast.api.registry.rest.data\_sources module
--------------------------------------------

.. automodule:: feast.api.registry.rest.data_sources
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.entities module
---------------------------------------

.. automodule:: feast.api.registry.rest.entities
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.feature\_services module
------------------------------------------------

.. automodule:: feast.api.registry.rest.feature_services
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.feature\_views module
---------------------------------------------

.. automodule:: feast.api.registry.rest.feature_views
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.permissions module
------------------------------------------

.. automodule:: feast.api.registry.rest.permissions
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.projects module
---------------------------------------

.. automodule:: feast.api.registry.rest.projects
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.rest\_registry\_server module
-----------------------------------------------------

.. automodule:: feast.api.registry.rest.rest_registry_server
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.rest\_utils module
------------------------------------------

.. automodule:: feast.api.registry.rest.rest_utils
:members:
:undoc-members:
:show-inheritance:

feast.api.registry.rest.saved\_datasets module
----------------------------------------------

.. automodule:: feast.api.registry.rest.saved_datasets
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.api.registry.rest
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions sdk/python/docs/source/feast.api.registry.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
feast.api.registry package
==========================

Subpackages
-----------

.. toctree::
:maxdepth: 4

feast.api.registry.rest

Module contents
---------------

.. automodule:: feast.api.registry
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions sdk/python/docs/source/feast.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
feast.api package
=================

Subpackages
-----------

.. toctree::
:maxdepth: 4

feast.api.registry

Module contents
---------------

.. automodule:: feast.api
:members:
:undoc-members:
:show-inheritance:
141 changes: 141 additions & 0 deletions sdk/python/docs/source/feast.cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
feast.cli package
=================

Submodules
----------

feast.cli.cli module
--------------------

.. automodule:: feast.cli.cli
:members:
:undoc-members:
:show-inheritance:

feast.cli.cli\_options module
-----------------------------

.. automodule:: feast.cli.cli_options
:members:
:undoc-members:
:show-inheritance:

feast.cli.cli\_utils module
---------------------------

.. automodule:: feast.cli.cli_utils
:members:
:undoc-members:
:show-inheritance:

feast.cli.data\_sources module
------------------------------

.. automodule:: feast.cli.data_sources
:members:
:undoc-members:
:show-inheritance:

feast.cli.entities module
-------------------------

.. automodule:: feast.cli.entities
:members:
:undoc-members:
:show-inheritance:

feast.cli.feature\_services module
----------------------------------

.. automodule:: feast.cli.feature_services
:members:
:undoc-members:
:show-inheritance:

feast.cli.feature\_views module
-------------------------------

.. automodule:: feast.cli.feature_views
:members:
:undoc-members:
:show-inheritance:

feast.cli.features module
-------------------------

.. automodule:: feast.cli.features
:members:
:undoc-members:
:show-inheritance:

feast.cli.on\_demand\_feature\_views module
-------------------------------------------

.. automodule:: feast.cli.on_demand_feature_views
:members:
:undoc-members:
:show-inheritance:

feast.cli.permissions module
----------------------------

.. automodule:: feast.cli.permissions
:members:
:undoc-members:
:show-inheritance:

feast.cli.projects module
-------------------------

.. automodule:: feast.cli.projects
:members:
:undoc-members:
:show-inheritance:

feast.cli.saved\_datasets module
--------------------------------

.. automodule:: feast.cli.saved_datasets
:members:
:undoc-members:
:show-inheritance:

feast.cli.serve module
----------------------

.. automodule:: feast.cli.serve
:members:
:undoc-members:
:show-inheritance:

feast.cli.stream\_feature\_views module
---------------------------------------

.. automodule:: feast.cli.stream_feature_views
:members:
:undoc-members:
:show-inheritance:

feast.cli.ui module
-------------------

.. automodule:: feast.cli.ui
:members:
:undoc-members:
:show-inheritance:

feast.cli.validation\_references module
---------------------------------------

.. automodule:: feast.cli.validation_references
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.cli
:members:
:undoc-members:
:show-inheritance:
37 changes: 37 additions & 0 deletions sdk/python/docs/source/feast.infra.common.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
feast.infra.common package
==========================

Submodules
----------

feast.infra.common.materialization\_job module
----------------------------------------------

.. automodule:: feast.infra.common.materialization_job
:members:
:undoc-members:
:show-inheritance:

feast.infra.common.retrieval\_task module
-----------------------------------------

.. automodule:: feast.infra.common.retrieval_task
:members:
:undoc-members:
:show-inheritance:

feast.infra.common.serde module
-------------------------------

.. automodule:: feast.infra.common.serde
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.infra.common
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions sdk/python/docs/source/feast.infra.compute_engines.local.backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
feast.infra.compute\_engines.local.backends package
===================================================

Submodules
----------

feast.infra.compute\_engines.local.backends.base module
-------------------------------------------------------

.. automodule:: feast.infra.compute_engines.local.backends.base
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.local.backends.factory module
----------------------------------------------------------

.. automodule:: feast.infra.compute_engines.local.backends.factory
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.local.backends.pandas\_backend module
------------------------------------------------------------------

.. automodule:: feast.infra.compute_engines.local.backends.pandas_backend
:members:
:undoc-members:
:show-inheritance:

feast.infra.compute\_engines.local.backends.polars\_backend module
------------------------------------------------------------------

.. automodule:: feast.infra.compute_engines.local.backends.polars_backend
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: feast.infra.compute_engines.local.backends
:members:
:undoc-members:
:show-inheritance:
Loading