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.

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

docs : readme update for possible hub description use #22

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,49 @@

🌟 You can run [`python download_data.py`](download_data.py) to interactively select and download any of these datasets!

## How to get the data and use with Hub 💾
A simple way of using this dataset is with [Activeloop](https://activeloop.ai)'s python package [Hub](https://github.com/activeloopai/Hub)!

First, run `pip install hub` (or `pip3 install hub`).

```python
# Load kmnist-training set in python
import hub
ds = hub.load("hub://activeloop/kmnist-train")

# Load kmnist-test set in python
#ds = hub.load("hub://activeloop/kmnist-test")



# Checking out the first number and his label
import matplotlib.pyplot as plt
img = ds.images[0].numpy()
plt.imshow(img)
plt.title(f"{ds.labels[0].numpy(aslist=True)}")
plt.show()

# train a model in pytorch
for sample in ds.pytorch():
# ... model code here ...

# train a model in tensorflow
for sample in ds.tensorflow():
# ... model code here ...
```

available tensors can be shown by printing dataset:

```python
print(ds)
# prints: Dataset(path='hub://activeloop/kmnist-train', read_only=True, tensors=['images', 'labels'])
```

For more information, check out the [hub documentation](https://docs.activeloop.ai/).




### Kuzushiji-MNIST

Kuzushiji-MNIST contains 70,000 28x28 grayscale images spanning 10 classes (one from each column of [hiragana](https://upload.wikimedia.org/wikipedia/commons/thumb/2/28/Table_hiragana.svg/768px-Table_hiragana.svg.png)), and is perfectly balanced like the original MNIST dataset (6k/1k train/test for each class).
Expand Down