diff --git a/docs/docs/l6_all_metrics.md b/docs/docs/all-metrics.md similarity index 99% rename from docs/docs/l6_all_metrics.md rename to docs/docs/all-metrics.md index 6cfb88f7..60633910 100644 --- a/docs/docs/l6_all_metrics.md +++ b/docs/docs/all-metrics.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 5 --- # All metrics diff --git a/docs/docs/architecture.md b/docs/docs/architecture.md new file mode 100644 index 00000000..20a5485f --- /dev/null +++ b/docs/docs/architecture.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 6 +--- + +# Architecture + +In this section we explore the architecture of the Radicalbit AI platform. +The image below shows 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 requires a PostgreSQL database to store data and a Kubernetes cluster to run Spark jobs for metrics evaluations. +To store all dataset files a distributed 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 model creation and ending with all metrics visualization. + +## SDK + +To interact with API programmatically, a [_Python SDK_](/python-sdk) is provided. +The SDK implements all functionalities exposed via REST API. \ No newline at end of file diff --git a/docs/docs/l3_model_sections/_category_.json b/docs/docs/model-sections/_category_.json similarity index 93% rename from docs/docs/l3_model_sections/_category_.json rename to docs/docs/model-sections/_category_.json index 91b1b5c7..280dd5c4 100644 --- a/docs/docs/l3_model_sections/_category_.json +++ b/docs/docs/model-sections/_category_.json @@ -1,6 +1,6 @@ { "label": "Model sections", - "position": 1, + "position": 4, "link": { "type": "generated-index", "description": "Each created models has three main sections: Overview, Reference, and Current. In this document we are thoroughly explaining each of them." diff --git a/docs/docs/l3_model_sections/current.md b/docs/docs/model-sections/current.md similarity index 100% rename from docs/docs/l3_model_sections/current.md rename to docs/docs/model-sections/current.md diff --git a/docs/docs/l3_model_sections/overview.md b/docs/docs/model-sections/overview.md similarity index 100% rename from docs/docs/l3_model_sections/overview.md rename to docs/docs/model-sections/overview.md diff --git a/docs/docs/l3_model_sections/reference.md b/docs/docs/model-sections/reference.md similarity index 100% rename from docs/docs/l3_model_sections/reference.md rename to docs/docs/model-sections/reference.md diff --git a/docs/docs/l5_python_sdk.md b/docs/docs/python-sdk.md similarity index 99% rename from docs/docs/l5_python_sdk.md rename to docs/docs/python-sdk.md index 1a041b55..7a42b9cd 100644 --- a/docs/docs/l5_python_sdk.md +++ b/docs/docs/python-sdk.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 4 --- # Python SDK diff --git a/docs/docs/l1_quickstart.md b/docs/docs/quickstart.md similarity index 99% rename from docs/docs/l1_quickstart.md rename to docs/docs/quickstart.md index c1eb2c2a..390cf118 100644 --- a/docs/docs/l1_quickstart.md +++ b/docs/docs/quickstart.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 --- # Quickstart diff --git a/docs/docs/l7_support.md b/docs/docs/support.md similarity index 98% rename from docs/docs/l7_support.md rename to docs/docs/support.md index 8114c103..43bc9a60 100644 --- a/docs/docs/l7_support.md +++ b/docs/docs/support.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 7 --- # Community Support diff --git a/docs/docs/l2_user_guide/_category_.json b/docs/docs/user-guide/_category_.json similarity index 96% rename from docs/docs/l2_user_guide/_category_.json rename to docs/docs/user-guide/_category_.json index 9de891b1..65f7e7af 100644 --- a/docs/docs/l2_user_guide/_category_.json +++ b/docs/docs/user-guide/_category_.json @@ -1,6 +1,6 @@ { "label": "User Guide", - "position": 1, + "position": 3, "link": { "type": "generated-index", "description": "Welcome to the «radicalbit-ai-monitoring» user guide. This document is designed to help you get started with our platform, understand its core concepts and make the most out of its features. Whether you are a new user or an experienced professional, this guide will provide you with the necessary information to effectively monitor and manage your AI systems." diff --git a/docs/docs/l2_user_guide/how_to.md b/docs/docs/user-guide/how-to.md similarity index 100% rename from docs/docs/l2_user_guide/how_to.md rename to docs/docs/user-guide/how-to.md diff --git a/docs/docs/l2_user_guide/user-guide-installation.md b/docs/docs/user-guide/installation.md similarity index 100% rename from docs/docs/l2_user_guide/user-guide-installation.md rename to docs/docs/user-guide/installation.md diff --git a/docs/docs/l2_user_guide/user-guide-keyconcepts.md b/docs/docs/user-guide/key-concepts.md similarity index 100% rename from docs/docs/l2_user_guide/user-guide-keyconcepts.md rename to docs/docs/user-guide/key-concepts.md diff --git a/docs/static/img/architecture/architecture.png b/docs/static/img/architecture/architecture.png new file mode 100644 index 00000000..87d61717 Binary files /dev/null and b/docs/static/img/architecture/architecture.png differ