docs: added architecture section #156
Conversation
docs/docs/l7_architecture.md
Outdated
| ## API | ||
|
|
||
| API is the core of the platform, it exposes all the functionalities via REST APIs. | ||
| It require a PostgreSQL database to store data and a Kubernetes cluster to run Spark jobs for metrics evaluations. |
There was a problem hiding this comment.
@maocorte there's a typo.
Errata: It require;
Corrig: It requires
docs/docs/l7_architecture.md
Outdated
| # Architecture | ||
|
|
||
| In this section we'll explore the architecture of the Radicalbit AI platform. | ||
| The image below show all the components of the platform: |
There was a problem hiding this comment.
@maocorte there's a typo.
Errata: The image below show;
Corrige: The image below shows
docs/docs/l7_architecture.md
Outdated
|
|
||
| API is the core of the platform, it exposes all the functionalities via REST APIs. | ||
| It require a PostgreSQL database to store data and a Kubernetes cluster to run Spark jobs for metrics evaluations. | ||
| To store all dataset files a distributes storage is used. |
There was a problem hiding this comment.
@maocorte there's a typo.
Errata: distributes;
Corrige: distributed
docs/docs/l7_architecture.md
Outdated
| ## UI | ||
|
|
||
| To use REST APIs with a human friendly interface, a UI is provided. | ||
| It covers all the implemented APIs, starting from models creation ending with all metrics visualization. |
There was a problem hiding this comment.
@maocorte
I suggest adding an "and": " starting from models creation AND ending with all metrics visualization"
docs/docs/l7_architecture.md
Outdated
| ## SDK | ||
|
|
||
| To interact with API programmatically, a Python SDK is provided. | ||
| SDK implements all functionalities exposed via REST API. |
There was a problem hiding this comment.
@maocorte
I suggest adding a "The" at the beginning of the sentence: "The SDK implements all..."
docs/docs/architecture.md
Outdated
|
|
||
| # Architecture | ||
|
|
||
| In this section we'll explore the architecture of the Radicalbit AI platform. |
docs/docs/architecture.md
Outdated
| ## UI | ||
|
|
||
| To use REST APIs with a human friendly interface, a UI is provided. | ||
| It covers all the implemented APIs, starting from models creation and ending with all metrics visualization. |
There was a problem hiding this comment.
@maocorte «model creation», not «models creation».
docs/docs/architecture.md
Outdated
|
|
||
| ## SDK | ||
|
|
||
| To interact with API programmatically, a Python SDK is provided. |
There was a problem hiding this comment.
@maocorte Write Python SDK in italics to show it is an entry in the documentation to keep it consistent with other files.
sidebar_positioninstead of file names