improve formatting of the quickstart tutorial (#240)

* tutorial data fetch formatting * mention cloud dataset * Fixed formatting in notebook * Added hidden tag --------- Co-authored-by: Sanjana Garg <[email protected]>
cleanlab · Nov 20, 2023 · 9de8f33 · 9de8f33
1 parent 1bef81a
commit 9de8f33
Showing 1 changed file with 13 additions and 25 deletions.
diff --git a/docs/source/tutorials/tutorial.ipynb b/docs/source/tutorials/tutorial.ipynb
@@ -30,13 +30,13 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {
-    "nbsphinx": "hidden",
-    "tags": []
+    "nbsphinx": "hidden"
    },
    "source": [
+    "Use `pip install cleanvision` to install a stable release of the package.\n",
+    "\n",
     "**After you install these packages, you may need to restart your notebook runtime before running the rest of this notebook.**"
    ]
   },
@@ -72,38 +72,26 @@
     "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"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {
-    "nbsphinx": "hidden",
-    "tags": []
+    "nbsphinx": "hidden"
    },
    "outputs": [],
    "source": [
-    "!wget - nc 'https://cleanlab-public.s3.amazonaws.com/CleanVision/image_files.zip'"
+    "!wget - nc 'https://cleanlab-public.s3.amazonaws.com/CleanVision/image_files.zip'\n",
+    "!unzip -q image_files.zip"
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "nbsphinx": "hidden",
-    "tags": []
-   },
-   "outputs": [],
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
-    "!unzip -q image_files.zip"
+    "```shell\n",
+    "wget - nc 'https://cleanlab-public.s3.amazonaws.com/CleanVision/image_files.zip'\n",
+    "unzip -q image_files.zip\n",
+    "```"
    ]
   },
   {
@@ -804,7 +792,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), [torchvision datasets](https://github.com/cleanlab/cleanvision/blob/main/docs/source/tutorials/torchvision_dataset.ipynb), as well as [files in cloud storage buckets like S3, GCS, or Azure](https://github.com/cleanlab/cleanvision-examples/blob/main/cloud_dataset.ipynb)."
    ]
   }
  ],