docs: added architecture section

radicalbit · Aug 5, 2024 · c88034b · c88034b
1 parent ea26f7c
commit c88034b
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/docs/l7_architecture.md b/docs/docs/l7_architecture.md
@@ -0,0 +1,27 @@
+---
+sidebar_position: 1
+---
+
+# Architecture
+
+In this section we'll explore the architecture of the Radicalbit AI platform.
+The image below show all the components of the platform:
+
+![Alt text](/img/architecture/architecture.png "Architecture")
+
+## 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.
+To store all dataset files a distributes storage is used.
+REST APIs could be used via user interface or using the provided Python SDK.
+
+## 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.
+
+## SDK
+
+To interact with API programmatically, a Python SDK is provided.
+SDK implements all functionalities exposed via REST API.
diff --git a/docs/docs/l7_support.md → docs/docs/l8_support.md b/docs/docs/l7_support.md → docs/docs/l8_support.md
diff --git a/docs/static/img/architecture/architecture.png b/docs/static/img/architecture/architecture.png