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.

Sign up for GitHub

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

docs: added architecture section #156

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c88034b
docs: added architecture section
maocorte Aug 5, 2024
f5f54a3
docs: refactor docs positioning and namings
maocorte Aug 5, 2024
355cd2b
fix typo
maocorte Aug 5, 2024
859dbad
fix typos
maocorte Aug 5, 2024
ea2cd71
added suggestions
maocorte Aug 5, 2024
839c93e
Merge branch 'docs_refactor' into docs_add_solution_arch
maocorte Aug 5, 2024
90d10ba
renamed doc files
maocorte Aug 5, 2024
336eabd
updated arch documentation
maocorte Aug 5, 2024
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
27 changes: 27 additions & 0 deletions docs/docs/l7_architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maocorte there's a typo.
Errata: The image below show;
Corrige: The image below shows


![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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maocorte there's a typo.
Errata: It require;
Corrig: It requires

To store all dataset files a distributes storage is used.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maocorte there's a typo.
Errata: distributes;
Corrige: distributed

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maocorte
I suggest adding an "and": " starting from models creation AND ending with all metrics visualization"


## SDK

To interact with API programmatically, a Python SDK is provided.
SDK implements all functionalities exposed via REST API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maocorte
I suggest adding a "The" at the beginning of the sentence: "The SDK implements all..."

0 docs/docs/l7_support.md → docs/docs/l8_support.md
View file
Open in desktop
File renamed without changes.
Binary file added docs/static/img/architecture/architecture.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.