Merge remote-tracking branch 'origin/dev' into dev-rag-evaluation

Author: andreacerasani

md-docs/api/examples.md

@@ -1,4 +1,4 @@
-We wrote for you a set of notebooks that can help you to understand how to use ML cube Platform SDK:
+We prepared for you a set of notebooks that can help you to understand how to use ML cube Platform SDK:
 
 - [0 - Company and Project]
 - [1 - Task and Model]

md-docs/api/index.md

@@ -1,11 +1,23 @@
-# Client SDK
+# ML cube Platform API
 
+ML cube Platform is an API-first application that provides full coverage of its functionalities both as Web Application and as API.
+In particular, we provide a Python SDK facilitating the interaction using high-level objects and automated procedures.
 
-ML cube Platform allows interaction through REST APIs:
+<div class="grid cards" markdown>
 
-- :fontawesome-brands-python: __[Python]__ – Install Python Client on your environment
-- :material-api: __[REST]__ – Use directly the API
-- :simple-jupyter: __[EXAMPLES]__ - Jupyer Notebook examples
-  [Python]: python/index.md
-  [REST]: rest/index.md
-  [EXAMPLES]: examples.md
+-   :fontawesome-brands-python:{ .lg .middle } **Python SDK**
+
+    ---
+
+    Documentation page of Python SDK with low level details of available methods.
+
+    [:octicons-arrow-right-24: More info](python/index.md)
+
+-   :simple-jupyter:{ .lg .middle } **Notebook Examples**
+
+    ---
+
+    Jupyter notebooks examples showing most of the basic usage of ML cube Platform.
+
+    [:octicons-arrow-right-24: More info](examples.md)
+</div>

md-docs/api/python/index.md

@@ -1,9 +1,19 @@
 # ML3 platform client SDK
 
+ML cube Platform SDK is a Python client that helps you interacting with ML cube Platform using high-level objects.
+The available sections are:
+
+- [Client:](client.md)
+    the Client is the main class to use the SDK, it is initialized with the application url (https://api.platform.mlcube.com) and with the user API Key.
+    It exposes all the methods to use ML cube Platform programmatically.
+- [Models:](models.md)
+    Pydantic models used as support objects in the SDK.
+- [Enums:](enums.md)
+    Enumerations available in the SDK.
+- [Exceptions:](exceptions.md)
+    Exceptions raised by the Client.
+
 ## Installation
 ```bash
 pip install ml3-platform-sdk
 ```
-
-## Usage
-Please refer to the [documentation](https://ml-cube.github.io/ml3-platform-docs/)

md-docs/imgs/add_target_labels.png

@@ -1,13 +1,73 @@
 # ML cube Platform
 
-Welcome to the official [ML cube Platform] documentation site.
-Here you can find everything you need to start using the product.
+Welcome to the ML cube Platform documentation!
 
-This site contains two sections:
+This website is designed to help you get the most out of ML cube Platform by providing clear, detailed explanations about the main concepts of the product and guidance on setup, configuration and usage.
+You will find definitions, tutorials, practical examples and everything you need to make full use of our product.
 
-- [User Guide] provides high overview of ML cube Platform and describes its main components.
-- [API] provides details about the API to interact with ML cube Platform.
+Dive in to explore everything ML cube Platform has to offer, and feel free to reach out if you need further assistance. Let’s get started!
 
-[ML cube Platform]: https://mlcube.com/platform
-[User Guide]: user_guide/index.md
-[API]: api/index.md
+
+<div class="grid cards" markdown>
+
+-   :material-sign-direction:{ .lg .middle } **Basic concepts**
+
+    ---
+
+    Are you new to the ML cube Platform and don't know where to start?
+
+    Start reading the Company page.
+
+    [:octicons-arrow-right-24: More info](user_guide/company.md)
+
+-   :simple-hive_blockchain:{ .lg .middle } **Modules**
+
+    ---
+
+    Do you want to learn what ML cube Platform can offer?
+
+    Go to the Modules page.
+
+    [:octicons-arrow-right-24: More info](user_guide/modules/index.md)
+
+-   :material-database:{ .lg .middle } **Data**
+
+    ---
+
+    Data are not all the same! 
+    
+    Discover how ML cube Platform handles data in the Data page.
+
+    [:octicons-arrow-right-24: More info](user_guide/data.md)
+
+-   :material-connection:{ .lg .middle } **Integrations**
+
+    ---
+
+    ML cube Platform is natively integrated with cloud solutions!
+
+    Check how to configure them.
+
+    [:octicons-arrow-right-24: More info](user_guide/integrations/index.md)
+
+-   :material-file-code:{ .lg .middle } **API**
+
+    ---
+
+    ML cube Platform has been developed with the API first mind!
+
+    Explore how to use our SDK.
+
+    [:octicons-arrow-right-24: More info](api/index.md)
+
+-  :simple-jupyter:{ .lg .middle } **Notebook Examples**
+
+    ---
+
+    First time using our SDK?
+
+    Check the Examples page to learn from them.
+
+    [:octicons-arrow-right-24: More info](api/examples.md)
+
+</div>

md-docs/imgs/data_batches_examples.png

@@ -10,4 +10,24 @@
 
 .green-icon {
   color: #98BE59;
+}
+
+/* Maximum space for text block */
+.md-grid {
+  max-width: 100%; /* or 100%, if you want to stretch to full-width */
+}
+
+.md-typeset .admonition.code-block,
+.md-typeset details.code-block {
+  border-color: rgb(43, 155, 70);
+}
+.md-typeset .code-block > .admonition-title,
+.md-typeset .code-block > summary {
+  background-color: rgba(43, 155, 70, 0.1);
+}
+.md-typeset .code-block > .admonition-title::before,
+.md-typeset .code-block > summary::before {
+  background-color: rgb(43, 155, 70);
+  -webkit-mask-image: var(--md-admonition-icon--code-block);
+          mask-image: var(--md-admonition-icon--code-block);
 }