Skip to content

Commit d8ee3fc

Browse files
authored
DOC fix mistakes in the machine learning map (scikit-learn#29123)
1 parent f316f4c commit d8ee3fc

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

doc/images/ml_map.svg

Lines changed: 1 addition & 1 deletion
Loading

doc/tutorial/machine_learning_map/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ https://peekaboo-vision.blogspot.de/2013/01/machine-learning-cheat-sheet-for-sci
33

44
The current version of the chart is located at `doc/images/ml_map.svg` in SVG+XML
55
format, created using [draw.io](https://draw.io/). To edit the chart, open the file in
6-
draw.io, make changes, and export as SVG with the same filename. Export configurations
7-
are:
6+
draw.io, make changes, and save. This should update the chart in-place. Another option
7+
would be to re-export the chart as SVG and replace the existing file. The options used
8+
for exporting the chart are:
89

910
- Zoom: 100%
1011
- Border width: 15
@@ -13,5 +14,7 @@ are:
1314
- Appearance: Light
1415

1516
Each node in the chart that contains an estimator should have a link, where the root
16-
directory is at `../../`. Note that after exporting the SVG, the links may be prefixed
17-
with e.g. `https://app.diagrams.net/`. Remember to check and remove them.
17+
directory is at `../../`. Note that after updating or re-exporting the SVG, the links
18+
may be prefixed with e.g. `https://app.diagrams.net/`. Remember to check and remove
19+
them, for instance by replacing all occurrences of `https://app.diagrams.net/../../`
20+
with `../../`.

doc/tutorial/machine_learning_map/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ data and different problems.
1111

1212
The flowchart below is designed to give users a bit of a rough guide on how to approach
1313
problems with regard to which estimators to try on your data. Click on any estimator in
14-
the chart below to see its documentation. Use scroll wheel to zoom in and out, and click
15-
and drag to pan around. You can also download the chart:
16-
:download:`ml_map.svg <../../images/ml_map.svg>`.
14+
the chart below to see its documentation. The 😭 emoji is to be read as "if this
15+
estimator does not achieve the desired outcome, then follow the arrow and try the next
16+
one". Use scroll wheel to zoom in and out, and click and drag to pan around. You can
17+
also download the chart: :download:`ml_map.svg <../../images/ml_map.svg>`.
1718

1819
.. raw:: html
1920

0 commit comments

Comments
 (0)