From 9cbc538a14274b010eec5438674a7e9cee7415d6 Mon Sep 17 00:00:00 2001 From: BirkhoffG <26811230+BirkhoffG@users.noreply.github.com> Date: Tue, 26 Dec 2023 14:50:26 +0800 Subject: [PATCH] Update READM --- README.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 61fcc00..7cf7053 100644 --- a/README.md +++ b/README.md @@ -52,16 +52,20 @@ or install directly from the repository: 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` or huggingface `datasets`, - you should try to manually install them, - or run `pip install jax-dataloader[all]` for installing all the dependencies. +> **Note** +> +> We will only install `jax`-related dependencies. If you wish to use +> integration of `pytorch` or huggingface `datasets`, you should try to +> manually install them, or run `pip install jax-dataloader[all]` for +> installing all the dependencies. + +
## Usage -[`jax_dataloader.core.DataLoader`](https://birkhoffg.github.io/jax-dataloader/core/#dataloader) +[`jax_dataloader.core.DataLoader`](https://birkhoffg.github.io/jax-dataloader/core.html#dataloader) follows similar API as the pytorch dataloader. - The `dataset` argument takes `jax_dataloader.core.Dataset` or @@ -75,11 +79,11 @@ import jax_dataloader as jdl import jax.numpy as jnp ``` -### Using [`ArrayDataset`](https://birkhoffg.github.io/jax-dataloader/dataset/#arraydataset) +### Using [`ArrayDataset`](https://birkhoffg.github.io/jax-dataloader/dataset.html#arraydataset) The `jax_dataloader.core.ArrayDataset` is an easy way to wrap multiple `jax.numpy.array` into one Dataset. For example, we can create an -[`ArrayDataset`](https://birkhoffg.github.io/jax-dataloader/dataset/#arraydataset) +[`ArrayDataset`](https://birkhoffg.github.io/jax-dataloader/dataset.html#arraydataset) as follows: ``` python @@ -109,10 +113,15 @@ ecosystems (e.g., built-in datasets. `jax_dataloader` supports directly passing the pytorch Dataset. -!!! note +
+ +> **Note** +> +> Unfortuantely, the [pytorch +> Dataset](https://pytorch.org/docs/stable/data.html) can only work with +> `backend=pytorch`. See the belowing example. - Unfortuantely, the [pytorch Dataset](https://pytorch.org/docs/stable/data.html) - can only work with `backend=pytorch`. See the belowing example. +
``` python from torchvision.datasets import MNIST