Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added architecture section #156

Merged
merged 8 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/l6_all_metrics.md → docs/docs/all-metrics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 5
---

# All metrics
Expand Down
27 changes: 27 additions & 0 deletions docs/docs/architecture.md
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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."
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/l5_python_sdk.md → docs/docs/python-sdk.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 4
---

# Python SDK
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/l1_quickstart.md → docs/docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 2
---

# Quickstart
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/l7_support.md → docs/docs/support.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 7
---

# Community Support
Expand Down
Original file line number Diff line number Diff line change
@@ -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."
Expand Down
File renamed without changes.
Binary file added docs/static/img/architecture/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.