improve formatting of the quickstart tutorial #240
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
| "\n", | ||
| "unzip -q image_files.zip" | ||
| ] | ||
| }, |
There was a problem hiding this comment.
I did not understand why there was these commands in the markdown cell and then again in hidden code cell. These commands did not look good in the markdown cell on our website:
There was a problem hiding this comment.
I put it in a hidden cell to hide this output.
There was a problem hiding this comment.
There's no tag in nbsphinx that hides just the output, it's either whole cell or nothing
There was a problem hiding this comment.
oh then can you make it look like code in the markdown cell? on the current website, this just doesn't look like code, which is suboptimal formatting. I agree hiding the output is good
There was a problem hiding this comment.
at the very top of the notebook in the hidden cell that'll be visible in colab that installs cleanvision from master branch, can you also put a comment:
pip install cleanvision to use the stable release of the package instead.
docs/source/tutorials/tutorial.ipynb
Outdated
| @@ -804,7 +788,7 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "**Beyond the collection of image files demonstrated here, you can alternatively run CleanVision on: [Hugging Face datasets](https://github.com/cleanlab/cleanvision/blob/main/docs/source/tutorials/huggingface_dataset.ipynb) and [torchvision datasets](https://github.com/cleanlab/cleanvision/blob/main/docs/source/tutorials/torchvision_dataset.ipynb).**" | |||
| "Beyond the collection of image files demonstrated here, you can alternatively run CleanVision on: [Hugging Face datasets](https://github.com/cleanlab/cleanvision/blob/main/docs/source/tutorials/huggingface_dataset.ipynb) and [torchvision datasets](https://github.com/cleanlab/cleanvision/blob/main/docs/source/tutorials/torchvision_dataset.ipynb)." | |||
There was a problem hiding this comment.
the formatting here was broken on our website:
Maybe you have better ideas on how to make this even better looking
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #240 +/- ##
==========================================
- Coverage 96.04% 95.84% -0.21%
==========================================
Files 16 16
Lines 986 986
Branches 194 194
==========================================
- Hits 947 945 -2
- Misses 20 21 +1
- Partials 19 20 +1 ☔ View full report in Codecov by Sentry. |
to review this please build docs and see that the improvements look good to you too