docs: adding a quickstart for binary classification (#62)

* docs: adding a quickstart for binary classification * docs: set the sdk with the stable version * docs: specify the sdk version --------- Co-authored-by: Mauro Mariniello <[email protected]>
radicalbit · Jul 3, 2024 · 367243f · 367243f
1 parent 509c2b2
commit 367243f
Show file tree

Hide file tree

Showing 6 changed files with 8,560 additions and 0 deletions.
diff --git a/docs/quickstarts/README.md b/docs/quickstarts/README.md
@@ -0,0 +1,23 @@
+# Radicalbit Platform Python SDK Examples
+
+Here will be available some tutorials to start to play with the Radicalbit Platform through the Python SDK.
+
+### How to set up ###
+
+The project is based on poetry for managing dependencies.
+
+You should have poetry installed on your local machine. You can follow the instruction on https://python-poetry.org.
+
+After you have poetry installed you can install the project's dependencies run:
+
+```bash
+poetry install
+```
+
+### Tutorials ###
+
+| Task                  | Tutorial Name                                     | Dataset to use                                                                                  | Description                                                                                                               |
+|-----------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
+| Binary Classification | notebooks/binary-classification-income-data.ipynb | data/binary_classification/reference-income.csv,  data/binary_classification/current1-income.csv| In this tutorial we monitor data and performance of a ML used to classify if the income is > 50K given a set of features. |
+
+