diff --git a/doc/choosing_the_right_algorithm.rst b/doc/choosing_the_right_algorithm.rst new file mode 100644 index 000000000..1979c0e42 --- /dev/null +++ b/doc/choosing_the_right_algorithm.rst @@ -0,0 +1,20 @@ +############################################ +Choosing the right algorithm +############################################ + +Following are simple decision trees to help you you getting started quickly with MAPIE. + +Reality is of course a bit more complex, so feel free to browse the documentation for nuanced explanations. + + +1. Regression +================================== + +.. image:: images/decision_tree_regression.png + :align: center + +2. Classification +===================== + +.. image:: images/decision_tree_classification.png + :align: center diff --git a/doc/choosing_the_right_algorithm_classification.rst b/doc/choosing_the_right_algorithm_classification.rst new file mode 100644 index 000000000..11f4596f6 --- /dev/null +++ b/doc/choosing_the_right_algorithm_classification.rst @@ -0,0 +1,10 @@ +############################################ +Choosing the right algorithm +############################################ + +Following is a simple decision tree to help you you getting started quickly with MAPIE. + +Reality is of course a bit more complex, so feel free to browse the documentation for nuanced explanations. + +.. image:: images/decision_tree_classification.png + :align: center \ No newline at end of file diff --git a/doc/choosing_the_right_algorithm_regression.rst b/doc/choosing_the_right_algorithm_regression.rst new file mode 100644 index 000000000..e48b441a9 --- /dev/null +++ b/doc/choosing_the_right_algorithm_regression.rst @@ -0,0 +1,10 @@ +############################################ +Choosing the right algorithm +############################################ + +Following is a simple decision trees to help you you getting started quickly with MAPIE. + +Reality is of course a bit more complex, so feel free to browse the documentation for nuanced explanations. + +.. image:: images/decision_tree_regression.png + :align: center \ No newline at end of file diff --git a/doc/images/decision_tree_classification.png b/doc/images/decision_tree_classification.png new file mode 100644 index 000000000..c03d05446 Binary files /dev/null and b/doc/images/decision_tree_classification.png differ diff --git a/doc/images/decision_tree_regression.png b/doc/images/decision_tree_regression.png new file mode 100644 index 000000000..bfe0fdd08 Binary files /dev/null and b/doc/images/decision_tree_regression.png differ diff --git a/doc/index.rst b/doc/index.rst index 9d0dffc13..ed5b864b6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,6 +7,7 @@ quick_start split_cross_conformal + choosing_the_right_algorithm v1_migration_guide .. toctree:: diff --git a/doc/index_classification.rst b/doc/index_classification.rst index bc3eb5e5e..2d8e76f5f 100644 --- a/doc/index_classification.rst +++ b/doc/index_classification.rst @@ -4,6 +4,7 @@ Prediction sets (classification) .. toctree:: :maxdepth: 2 + choosing_the_right_algorithm_classification examples_classification/4-tutorials/plot_main-tutorial-classification examples_classification/4-tutorials/plot_crossconformal examples_classification/index diff --git a/doc/index_regression.rst b/doc/index_regression.rst index 2141b24c9..6fe1bbef5 100644 --- a/doc/index_regression.rst +++ b/doc/index_regression.rst @@ -4,6 +4,7 @@ Prediction intervals (regression) .. toctree:: :maxdepth: 2 + choosing_the_right_algorithm_regression examples_regression/4-tutorials/plot_main-tutorial-regression examples_regression/4-tutorials/plot_cqr_tutorial examples_regression/4-tutorials/plot_ts-tutorial