Skip to content

Commit

Permalink
Shorten tutorial titles in docs for readability (#553)
Browse files Browse the repository at this point in the history
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com>
  • Loading branch information
ulya-tkch and jwmueller committed Dec 2, 2022
1 parent 5a8619a commit a14d810
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions docs/README.md
Expand Up @@ -75,7 +75,7 @@ pip install -r docs/requirements.txt

2. move the notebook to ignore from local build to the newly created folder
```
mv docs/source/tutorials/audio.ipynb ../ignore_notebooks
mv docs/source/tutorials/audio.ipynb ../ignore_notebooks
```

3. build the docs locally, using `sphinx-build` as it does not require you to commit your changes
Expand Down Expand Up @@ -282,9 +282,9 @@ instead of containing your own virtualenv in there. CI will FAIL if you instead
- Add a comment in hidden cell not displayed on docs.cleanlab.ai stating which version of dependencies you used.
- Think carefully whether each dependency is really necessary and if its future versions will be stable / compatible with future versions of existing dependencies.

6. Don't forget to update **docs/source/index.rst** and **docs/source/tutorials/index.rst** to ensure your tutorial properly linked. Otherwise it will not appear on docs.cleanlab.ai!
6. Don't forget to update **docs/source/index.rst** with a short title and **docs/source/tutorials/index.rst** to ensure your tutorial properly linked. Otherwise it will not appear on docs.cleanlab.ai!

7. Ask yourself:
7. Ask yourself:
- How can I make this tutorial run faster without sacrificing educational value? Perhaps use smaller subsample of the dataset, smaller/pretrained model, etc.
- What sections of this tutorial are least vital? Consider creating a separate [Examples](https://github.com/cleanlab/examples) notebook that features those.

Expand Down
28 changes: 14 additions & 14 deletions docs/source/index.rst
Expand Up @@ -97,7 +97,7 @@ The example below shows how to view all dataset-level issues in one line of code
health_summary(labels, pred_probs, class_names=class_names)
Contributing
Contributing
------------

As cleanlab is an open-source project, we welcome contributions from the community.
Expand All @@ -114,18 +114,18 @@ Please see our `contributing guidelines <https://github.com/cleanlab/cleanlab/bl
:hidden:
:caption: Tutorials

tutorials/indepth_overview
tutorials/image
tutorials/text
tutorials/tabular
tutorials/audio
tutorials/dataset_health
tutorials/outliers
tutorials/multiannotator
tutorials/multilabel_classification
tutorials/token_classification
tutorials/pred_probs_cross_val
tutorials/faq
Workflows of Data-Centric AI <tutorials/indepth_overview>
Image Classification (pytorch) <tutorials/image>
Text Classification (tensorflow) <tutorials/text>
Tabular Classification (sklearn) <tutorials/tabular>
Audio Classification (speechbrain) <tutorials/audio>
Find Dataset-level Issues <tutorials/dataset_health>
Identifying Outliers (pytorch) <tutorials/outliers>
Improving Consensus Labels for Multiannotator Data <tutorials/multiannotator>
Multi-Label Classification <tutorials/multilabel_classification>
Token Classification (text) <tutorials/token_classification>
Predicted Probabilities via Cross Validation <tutorials/pred_probs_cross_val>
FAQ <tutorials/faq>

.. toctree::
:caption: API Reference
Expand All @@ -148,7 +148,7 @@ Please see our `contributing guidelines <https://github.com/cleanlab/cleanlab/bl
.. toctree::
:caption: Guides
:hidden:

How to contribute <https://github.com/cleanlab/cleanlab/blob/master/CONTRIBUTING.md>
Migrating to v2.x <migrating/migrate_v2>

Expand Down

0 comments on commit a14d810

Please sign in to comment.