Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve formatting of the quickstart tutorial #240

Merged
merged 4 commits into from
Nov 20, 2023
Merged

improve formatting of the quickstart tutorial #240

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63a17a0
tutorial data fetch formatting
jwmueller Nov 17, 2023
29eccde
mention cloud dataset
jwmueller Nov 17, 2023
88857ce
Fixed formatting in notebook
sanjanag Nov 20, 2023
ff68f9b
Added hidden tag
sanjanag Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 3 additions & 19 deletions docs/source/tutorials/tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,23 +72,10 @@
"This notebook uses an example dataset, that you can download using these commands."
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"wget - nc 'https://cleanlab-public.s3.amazonaws.com/CleanVision/image_files.zip'\n",
"\n",
"unzip -q image_files.zip"
]
},
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Screen Shot 2023-11-16 at 7 58 52 PM

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2023-11-17 at 9 32 38 AM
I put it in a hidden cell to hide this output.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no tag in nbsphinx that hides just the output, it's either whole cell or nothing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay

{
"cell_type": "code",
"execution_count": null,
"metadata": {
"nbsphinx": "hidden",
"tags": []
},
"metadata": {},
"outputs": [],
"source": [
"!wget - nc 'https://cleanlab-public.s3.amazonaws.com/CleanVision/image_files.zip'"
Expand All @@ -97,10 +84,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"nbsphinx": "hidden",
"tags": []
},
"metadata": {},
"outputs": [],
"source": [
"!unzip -q image_files.zip"
Expand Down Expand Up @@ -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)."
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the formatting here was broken on our website:

Screen Shot 2023-11-16 at 7 59 15 PM

Maybe you have better ideas on how to make this even better looking

]
}
],
Expand Down