docs: Codebase structure #3050
Merged
docs: Codebase structure #3050
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
felixwang9817
force-pushed
the
codebase_structure_docs
branch
2 times, most recently
from
082778d to
31b1d47
Compare
Codecov Report
@@ Coverage Diff @@
## master #3050 +/- ##
==========================================
+ Coverage 67.44% 75.72% +8.27%
==========================================
Files 169 203 +34
Lines 14936 16856 +1920
==========================================
+ Hits 10074 12764 +2690
+ Misses 4862 4092 -770
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
felixwang9817
force-pushed
the
codebase_structure_docs
branch
from
31b1d47 to
2ffebcb
Compare
achals
reviewed
Aug 9, 2022
docs/reference/codebase-structure.md
Outdated
| The majority of Feast logic lives in these Python files: | ||
| * The core Feast objects ([entities](../getting-started/concepts/entity.md), [feature views](../getting-started/concepts/feature-view.md), [data sources](../getting-started/concepts/dataset.md), etc.) are defined in their respective Python files, such as `entity.py`, `feature_view.py`, and `data_source.py`. | ||
| * The feature store object is defined in `feature_store.py` and the associated configuration objects are defined in `repo_config.py`. | ||
| * The registry is defined in `registry.py`. |
There was a problem hiding this comment.
nit, the regsitry interface (BaseRegistry) and the file based implementation (Regsitry) lives here. The SQL regisry is in infra/regsitry_stores (which is probably not the best name or place.
docs/reference/codebase-structure.md
Outdated
| * The Python feature server is defined in `feature_server.py`. | ||
|
|
||
| There are also several important submodules: | ||
| * `infra/` contains all the infrastructure components, such as offline and online stores. |
docs/reference/codebase-structure.md
Outdated
| There are also several important submodules: | ||
| * `infra/` contains all the infrastructure components, such as offline and online stores. | ||
| * `dqm/` covers data quality monitoring. | ||
| * `diff/` covers the logic for creating plans. |
docs/reference/codebase-structure.md
Outdated
| * `ui/` contains the embedded Web UI, to be launched on the `feast ui` command. | ||
|
|
||
| Of these submodules, `infra/` is the most important. | ||
| It contains the interfaces for the [provider](getting-started/architecture-and-components/provider.md), [offline store](getting-started/architecture-and-components/offline-store.md), [online store](getting-started/architecture-and-components/online-store.md), and [batch materialization engine](getting-started/architecture-and-components/batch-materialization-engine.md), as well as all of their individual implementations. |
adchia
reviewed
Aug 9, 2022
docs/reference/codebase-structure.md
Outdated
| $ cd sdk/python/feast | ||
| $ tree -L 1 | ||
| . | ||
| ├── __init__.py |
There was a problem hiding this comment.
this one might be a bit excessive :P
docs/reference/codebase-structure.md
Outdated
| There are also several important submodules: | ||
| * `infra/` contains all the infrastructure components, such as offline and online stores. | ||
| * `dqm/` covers data quality monitoring. | ||
| * `diff/` covers the logic for creating plans. |
There was a problem hiding this comment.
plans is ambiguous. explain that?
docs/reference/codebase-structure.md
Outdated
| * The registry is defined in `registry.py`. | ||
| * The CLI and other core feature store logic are defined in `cli.py` and `repo_operations.py`. | ||
| * The type system that is used to manage conversion between Feast types and external typing systems is managed in `type_map.py`. | ||
| * The Python feature server is defined in `feature_server.py`. |
There was a problem hiding this comment.
maybe call out that this is what is launched with feast serve?
docs/reference/codebase-structure.md
Outdated
| It contains the interfaces for the [provider](getting-started/architecture-and-components/provider.md), [offline store](getting-started/architecture-and-components/offline-store.md), [online store](getting-started/architecture-and-components/online-store.md), and [batch materialization engine](getting-started/architecture-and-components/batch-materialization-engine.md), as well as all of their individual implementations. | ||
|
|
||
| ``` | ||
| $ tree -L 1 infra |
There was a problem hiding this comment.
maybe instead: tree --dirsfirst -L 1 -C infra so directories show up first?
docs/reference/codebase-structure.md
Outdated
|
|
||
| The majority of Feast logic lives in these Python files: | ||
| * The core Feast objects ([entities](../getting-started/concepts/entity.md), [feature views](../getting-started/concepts/feature-view.md), [data sources](../getting-started/concepts/dataset.md), etc.) are defined in their respective Python files, such as `entity.py`, `feature_view.py`, and `data_source.py`. | ||
| * The feature store object is defined in `feature_store.py` and the associated configuration objects are defined in `repo_config.py`. |
There was a problem hiding this comment.
map this to what users know about? aka this is what feature_store.yaml configuration maps to in memory
felixwang9817
force-pushed
the
codebase_structure_docs
branch
3 times, most recently
from
10b8f94 to
34f91cc
Compare
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
felixwang9817
force-pushed
the
codebase_structure_docs
branch
from
34f91cc to
c2ab2a6
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: adchia, felixwang9817 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
franciscojavierarceo
pushed a commit
to franciscojavierarceo/feast
that referenced
this pull request
Aug 13, 2022
* Codebase structure docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Address code review Signed-off-by: Felix Wang <wangfelix98@gmail.com> Signed-off-by: Felix Wang <wangfelix98@gmail.com> Signed-off-by: Francisco Javier Arceo <arceofrancisco@gmail.com>
adchia
pushed a commit
that referenced
this pull request
Aug 15, 2022
* Codebase structure docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Address code review Signed-off-by: Felix Wang <wangfelix98@gmail.com> Signed-off-by: Felix Wang <wangfelix98@gmail.com>
adchia
pushed a commit
that referenced
this pull request
Aug 15, 2022
* Codebase structure docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Address code review Signed-off-by: Felix Wang <wangfelix98@gmail.com> Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Felix Wang wangfelix98@gmail.com
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #