Skip to content

Commit 318c758

Browse files
committed
better api
1 parent 85674d0 commit 318c758

File tree

4 files changed

+35
-13
lines changed

4 files changed

+35
-13
lines changed

md-docs/api/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
We wrote for you a set of notebooks that can help you to understand how to use ML cube Platform SDK:
1+
We prepared for you a set of notebooks that can help you to understand how to use ML cube Platform SDK:
22

33
- [0 - Company and Project]
44
- [1 - Task and Model]

md-docs/api/index.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
1-
# Client SDK
1+
# ML cube Platform API
22

3+
ML cube Platform is an API-first application that provides full coverage of its functionalities both as Web Application and as API.
4+
In particular, we provide a Python SDK facilitating the interaction using high-level objects and automated procedures.
35

4-
ML cube Platform allows interaction through REST APIs:
6+
<div class="grid cards" markdown>
57

6-
- :fontawesome-brands-python: __[Python]__ – Install Python Client on your environment
7-
- :material-api: __[REST]__ – Use directly the API
8-
- :simple-jupyter: __[EXAMPLES]__ - Jupyer Notebook examples
9-
[Python]: python/index.md
10-
[REST]: rest/index.md
11-
[EXAMPLES]: examples.md
8+
- :fontawesome-brands-python:{ .lg .middle } **Python SDK**
9+
10+
---
11+
12+
Documentation page of Python SDK with low level details of available methods.
13+
14+
[:octicons-arrow-right-24: More info](python/index.md)
15+
16+
- :simple-jupyter:{ .lg .middle } **Notebook Examples**
17+
18+
---
19+
20+
Jupyter notebooks examples showing most of the basic usage of ML cube Platform.
21+
22+
[:octicons-arrow-right-24: More info](examples.md)
23+
</div>

md-docs/api/python/index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# ML3 platform client SDK
22

3+
ML cube Platform SDK is a Python client that helps you interacting with ML cube Platform using high-level objects.
4+
The available sections are:
5+
6+
- [Client:](client.md)
7+
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.
8+
It exposes all the methods to use ML cube Platform programmatically.
9+
- [Models:](models.md)
10+
Pydantic models used as support objects in the SDK.
11+
- [Enums:](enums.md)
12+
Enumerations available in the SDK.
13+
- [Exceptions:](exceptions.md)
14+
Exceptions raised by the Client.
15+
316
## Installation
417
```bash
518
pip install ml3-platform-sdk
619
```
7-
8-
## Usage
9-
Please refer to the [documentation](https://ml-cube.github.io/ml3-platform-docs/)

md-docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Dive in to explore everything ML cube Platform has to offer, and feel free to re
6060

6161
[:octicons-arrow-right-24: More info](api/index.md)
6262

63-
- :material-notebook:{ .lg .middle } **Notebook Examples**
63+
- :simple-jupyter:{ .lg .middle } **Notebook Examples**
6464

6565
---
6666

0 commit comments

Comments
 (0)