Skip to content

Commit 2437380

Browse files
committed
add module docstring for FashionMNIST
1 parent 142ee84 commit 2437380

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/src/datasets/FashionMNIST.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ julia> FashionMNIST.convert2image(FashionMNIST.traintensor(1)) # first training
8787

8888
## API Documentation
8989

90+
```@docs
91+
FashionMNIST
92+
```
93+
9094
### Trainingset
9195

9296
```@docs

src/FashionMNIST/FashionMNIST.jl

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
export FashionMNIST
2+
3+
"""
4+
Fashion-MNIST
5+
6+
- Authors: Han Xiao, Kashif Rasul, Roland Vollgraf
7+
- Website: https://github.com/zalandoresearch/fashion-mnist
8+
9+
Fashion-MNIST is a dataset of Zalando's article images—consisting
10+
of a training set of 60,000 examples and a test set of 10,000
11+
examples. Each example is a 28x28 grayscale image, associated
12+
with a label from 10 classes. It can serve as a drop-in
13+
replacement for MNIST.
14+
15+
## Interface
16+
17+
- [`FashionMNIST.traintensor`](@ref), [`FashionMNIST.trainlabels`](@ref), [`FashionMNIST.traindata`](@ref)
18+
- [`FashionMNIST.testtensor`](@ref), [`FashionMNIST.testlabels`](@ref), [`FashionMNIST.testdata`](@ref)
19+
20+
## Utilities
21+
22+
- [`FashionMNIST.download`](@ref)
23+
- [`MNIST.convert2features`](@ref)
24+
- [`MNIST.convert2image`](@ref)
25+
"""
226
module FashionMNIST
327
using DataDeps
428
using FixedPointNumbers

0 commit comments

Comments
 (0)