update README

Author: BirkhoffG

README.md

@@ -12,19 +12,21 @@ License](https://img.shields.io/github/license/BirkhoffG/jax-dataloader.svg)
 
 ## Overview
 
-`jax_dataloader` provides a high-level *pytorch-like* dataloader API for
-`jax`. It supports
-
-- **downloading and pre-processing datasets** via [huggingface
-  datasets](https://github.com/huggingface/datasets), [pytorch
-  Dataset](https://pytorch.org/docs/stable/data.html#torch.utils.data.Dataset),
-  and [tensorflow dataset](www.tensorflow.org/datasets);
-
-- **iteratively loading batches** via (vanillla) [jax
-  dataloader](https://birkhoffg.github.io/jax-dataloader/core.html#jax-dataloader),
-  [pytorch
-  dataloader](https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader)
-  and [tensorflow dataset](www.tensorflow.org/datasets).
+`jax_dataloader` brings *pytorch-like* dataloader API to `jax`. It
+supports
+
+- **4 datasets to download and pre-process data**:
+  - [jax dataset](https://birkhoffg.github.io/jax-dataloader/dataset/)
+  - [huggingface datasets](https://github.com/huggingface/datasets)
+  - [pytorch
+    Dataset](https://pytorch.org/docs/stable/data.html#torch.utils.data.Dataset)
+  - [tensorflow dataset](www.tensorflow.org/datasets)
+- **3 backends to iteratively load batches**:
+  - [jax
+    dataloader](https://birkhoffg.github.io/jax-dataloader/core.html#jax-dataloader)
+  - [pytorch
+    dataloader](https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader)
+  - [tensorflow dataset](www.tensorflow.org/datasets)
 
 A minimum `jax-dataloader` example:
 
@@ -57,9 +59,11 @@ pip install git+https://github.com/BirkhoffG/jax-dataloader.git
 
 > **Note**
 >
-> We will only install `jax`-related dependencies. If you wish to use
-> integration of `pytorch`, huggingface `datasets`, or `tensorflow`, we
-> recommend manually install those dependencies.
+> We keep `jax-dataloader`’s dependencies minimum, which only install
+> `jax`-related dependencies, and `plum-dispatch` for backend
+> dispatching. If you wish to use integration of `pytorch`, huggingface
+> `datasets`, or `tensorflow`, we recommend manually install those
+> dependencies.
 >
 > You can also run `pip install jax-dataloader[all]` to install
 > everything (not recommended).

nbs/index.ipynb

@@ -28,12 +28,19 @@
    "source": [
     "## Overview\n",
     "\n",
-    "`jax_dataloader` provides a high-level *pytorch-like* dataloader API for `jax`. \n",
+    "`jax_dataloader` brings *pytorch-like* dataloader API to `jax`. \n",
     "It supports\n",
     "\n",
-    "* **downloading and pre-processing datasets** via [huggingface datasets](https://github.com/huggingface/datasets), [pytorch Dataset](https://pytorch.org/docs/stable/data.html#torch.utils.data.Dataset), and [tensorflow dataset](www.tensorflow.org/datasets);\n",
+    "* **4 datasets to download and pre-process data**: \n",
+    "    * [jax dataset](https://birkhoffg.github.io/jax-dataloader/dataset/)\n",
+    "    * [huggingface datasets](https://github.com/huggingface/datasets) \n",
+    "    * [pytorch Dataset](https://pytorch.org/docs/stable/data.html#torch.utils.data.Dataset)\n",
+    "    * [tensorflow dataset](www.tensorflow.org/datasets)\n",
     "\n",
-    "* **iteratively loading batches** via (vanillla) [jax dataloader](https://birkhoffg.github.io/jax-dataloader/core.html#jax-dataloader), [pytorch dataloader](https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader) and [tensorflow dataset](www.tensorflow.org/datasets).\n",
+    "* **3 backends to iteratively load batches**: \n",
+    "    * [jax dataloader](https://birkhoffg.github.io/jax-dataloader/core.html#jax-dataloader)\n",
+    "    * [pytorch dataloader](https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader) \n",
+    "    * [tensorflow dataset](www.tensorflow.org/datasets)\n",
     "\n",
     "\n",
     "A minimum `jax-dataloader` example:\n",
@@ -71,7 +78,7 @@
     "\n",
     ":::{.callout-note} \n",
     "\n",
-    "We will only install `jax`-related dependencies. \n",
+    "We keep `jax-dataloader`'s dependencies minimum, which only install `jax`-related dependencies, and `plum-dispatch` for backend dispatching.\n",
     "If you wish to use integration of `pytorch`, huggingface `datasets`, or `tensorflow`,\n",
     "we recommend manually install those dependencies.\n",
     "\n",
@@ -420,6 +427,10 @@
    "display_name": "python3",
    "language": "python",
    "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,