Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit caf1d4f

Browse files
ntkatholentkathole
authored
chore: Updated python documentation (#5347)
chore: updated python documentation Signed-off-by: ntkathole <[email protected]>
1 parent 9740fd1 commit caf1d4f

16 files changed

+579
-25
lines changed

‎infra/templates/README.md.jinja2‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[![PyPI - Downloads](https://img.shields.io/pypi/dm/feast)](https://pypi.org/project/feast/)
99
[![GitHub contributors](https://img.shields.io/github/contributors/feast-dev/feast)](https://github.com/feast-dev/feast/graphs/contributors)
10-
[![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)
10+
[![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)
1111
[![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)
1212
[![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)
1313
[![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)
@@ -19,6 +19,8 @@
1919
## Join us on Slack!
2020
👋👋👋 [Come say hi on Slack!](https://communityinviter.com/apps/feastopensource/feast-the-open-source-feature-store)
2121

22+
[Check out our DeepWiki!](https://deepwiki.com/feast-dev/feast)
23+
2224
## Overview
2325

2426
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.
@@ -181,3 +183,4 @@ Thanks goes to these incredible people:
181183
<a href="https://github.com/feast-dev/feast/graphs/contributors">
182184
<img src="https://contrib.rocks/image?repo=feast-dev/feast" />
183185
</a>
186+

‎sdk/python/docs/source/conf.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
import os
2020
import sys
2121

22+
import sphinx_rtd_theme
23+
2224
sys.path.insert(0, os.path.abspath("../../feast"))
2325
sys.path.insert(0, os.path.abspath("../.."))
2426

@@ -30,6 +32,7 @@
3032
# example where the Python protos did not build, which subsequently broke
3133
# the RTD build. In order to fix this, we manually compile the protos.
3234
import subprocess
35+
3336
from pathlib import Path
3437

3538
# cwd will be feast/sdk/python/docs/source

‎sdk/python/docs/source/feast.api.registry.rest.rst‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
feast.api.registry.rest package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
feast.api.registry.rest.data\_sources module
8+
--------------------------------------------
9+
10+
.. automodule:: feast.api.registry.rest.data_sources
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.api.registry.rest.entities module
16+
---------------------------------------
17+
18+
.. automodule:: feast.api.registry.rest.entities
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.api.registry.rest.feature\_services module
24+
------------------------------------------------
25+
26+
.. automodule:: feast.api.registry.rest.feature_services
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
feast.api.registry.rest.feature\_views module
32+
---------------------------------------------
33+
34+
.. automodule:: feast.api.registry.rest.feature_views
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
feast.api.registry.rest.permissions module
40+
------------------------------------------
41+
42+
.. automodule:: feast.api.registry.rest.permissions
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
feast.api.registry.rest.projects module
48+
---------------------------------------
49+
50+
.. automodule:: feast.api.registry.rest.projects
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
feast.api.registry.rest.rest\_registry\_server module
56+
-----------------------------------------------------
57+
58+
.. automodule:: feast.api.registry.rest.rest_registry_server
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
feast.api.registry.rest.rest\_utils module
64+
------------------------------------------
65+
66+
.. automodule:: feast.api.registry.rest.rest_utils
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
feast.api.registry.rest.saved\_datasets module
72+
----------------------------------------------
73+
74+
.. automodule:: feast.api.registry.rest.saved_datasets
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
Module contents
80+
---------------
81+
82+
.. automodule:: feast.api.registry.rest
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:

‎sdk/python/docs/source/feast.api.registry.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
feast.api.registry package
2+
==========================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.api.registry.rest
11+
12+
Module contents
13+
---------------
14+
15+
.. automodule:: feast.api.registry
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

‎sdk/python/docs/source/feast.api.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
feast.api package
2+
=================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.api.registry
11+
12+
Module contents
13+
---------------
14+
15+
.. automodule:: feast.api
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

‎sdk/python/docs/source/feast.cli.rst‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
feast.cli package
2+
=================
3+
4+
Submodules
5+
----------
6+
7+
feast.cli.cli module
8+
--------------------
9+
10+
.. automodule:: feast.cli.cli
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.cli.cli\_options module
16+
-----------------------------
17+
18+
.. automodule:: feast.cli.cli_options
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.cli.cli\_utils module
24+
---------------------------
25+
26+
.. automodule:: feast.cli.cli_utils
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
feast.cli.data\_sources module
32+
------------------------------
33+
34+
.. automodule:: feast.cli.data_sources
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
feast.cli.entities module
40+
-------------------------
41+
42+
.. automodule:: feast.cli.entities
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
feast.cli.feature\_services module
48+
----------------------------------
49+
50+
.. automodule:: feast.cli.feature_services
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
feast.cli.feature\_views module
56+
-------------------------------
57+
58+
.. automodule:: feast.cli.feature_views
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
feast.cli.features module
64+
-------------------------
65+
66+
.. automodule:: feast.cli.features
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
feast.cli.on\_demand\_feature\_views module
72+
-------------------------------------------
73+
74+
.. automodule:: feast.cli.on_demand_feature_views
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
feast.cli.permissions module
80+
----------------------------
81+
82+
.. automodule:: feast.cli.permissions
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
feast.cli.projects module
88+
-------------------------
89+
90+
.. automodule:: feast.cli.projects
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
feast.cli.saved\_datasets module
96+
--------------------------------
97+
98+
.. automodule:: feast.cli.saved_datasets
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
feast.cli.serve module
104+
----------------------
105+
106+
.. automodule:: feast.cli.serve
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
110+
111+
feast.cli.stream\_feature\_views module
112+
---------------------------------------
113+
114+
.. automodule:: feast.cli.stream_feature_views
115+
:members:
116+
:undoc-members:
117+
:show-inheritance:
118+
119+
feast.cli.ui module
120+
-------------------
121+
122+
.. automodule:: feast.cli.ui
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
127+
feast.cli.validation\_references module
128+
---------------------------------------
129+
130+
.. automodule:: feast.cli.validation_references
131+
:members:
132+
:undoc-members:
133+
:show-inheritance:
134+
135+
Module contents
136+
---------------
137+
138+
.. automodule:: feast.cli
139+
:members:
140+
:undoc-members:
141+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.common.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
feast.infra.common package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.common.materialization\_job module
8+
----------------------------------------------
9+
10+
.. automodule:: feast.infra.common.materialization_job
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.infra.common.retrieval\_task module
16+
-----------------------------------------
17+
18+
.. automodule:: feast.infra.common.retrieval_task
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.infra.common.serde module
24+
-------------------------------
25+
26+
.. automodule:: feast.infra.common.serde
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: feast.infra.common
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎sdk/python/docs/source/feast.infra.compute_engines.local.backends.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
feast.infra.compute\_engines.local.backends package
2+
===================================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.compute\_engines.local.backends.base module
8+
-------------------------------------------------------
9+
10+
.. automodule:: feast.infra.compute_engines.local.backends.base
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.infra.compute\_engines.local.backends.factory module
16+
----------------------------------------------------------
17+
18+
.. automodule:: feast.infra.compute_engines.local.backends.factory
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.infra.compute\_engines.local.backends.pandas\_backend module
24+
------------------------------------------------------------------
25+
26+
.. automodule:: feast.infra.compute_engines.local.backends.pandas_backend
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
feast.infra.compute\_engines.local.backends.polars\_backend module
32+
------------------------------------------------------------------
33+
34+
.. automodule:: feast.infra.compute_engines.local.backends.polars_backend
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: feast.infra.compute_engines.local.backends
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

0 commit comments

Comments
 (0)