diff --git a/docs/dev_guide/feathr-core-code-structure.md b/docs/dev_guide/feathr-core-code-structure.md new file mode 100644 index 000000000..ab812f32e --- /dev/null +++ b/docs/dev_guide/feathr-core-code-structure.md @@ -0,0 +1,20 @@ +--- +layout: default +title: Documentation Guideline +parent: Developer Guides +--- + +# Feathr Code Structure + + +## Code Structure for get_offline_features() and materialize_features() API calls + +Credit goes to https://github.com/csruiliu for creating those diagrams below: + +### Feathr get_offline_features() diagram + +![Feathr get_offline_features() diagram](../images/feathr-get-offline-features-flow.png) + +### Feathr materialize_features() diagram + +![Feathr materialize_features() diagram](../images/feathr-feature-materliazation-flow.png) diff --git a/docs/images/feathr-feature-materliazation-flow.png b/docs/images/feathr-feature-materliazation-flow.png new file mode 100644 index 000000000..72ea2556f Binary files /dev/null and b/docs/images/feathr-feature-materliazation-flow.png differ diff --git a/docs/images/feathr-get-offline-features-flow.png b/docs/images/feathr-get-offline-features-flow.png new file mode 100644 index 000000000..0c812aa49 Binary files /dev/null and b/docs/images/feathr-get-offline-features-flow.png differ