Skip to content

Commit de57f4e

Browse files
committed
add module docstring to MNIST
1 parent 3f27857 commit de57f4e

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/src/datasets/MNIST.md

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

8787
## API Documentation
8888

89+
```@docs
90+
MNIST
91+
```
92+
8993
### Trainingset
9094

9195
```@docs

src/MNIST/MNIST.jl

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
export MNIST
2+
3+
"""
4+
The MNIST database of handwritten digits
5+
6+
- Authors: Yann LeCun, Corinna Cortes, Christopher J.C. Burges
7+
- Website: http://yann.lecun.com/exdb/mnist/
8+
9+
MNIST is a classic image-classification dataset that is often
10+
used in small-scale machine learning experiments. It contains
11+
70,000 images of handwritten digits. Each observation is a 28x28
12+
pixel gray-scale image that depicts a handwritten version of 1 of
13+
the 10 possible digits (0-9).
14+
15+
## Interface
16+
17+
- [`MNIST.traintensor`](@ref), [`MNIST.trainlabels`](@ref), [`MNIST.traindata`](@ref)
18+
- [`MNIST.testtensor`](@ref), [`MNIST.testlabels`](@ref), [`MNIST.testdata`](@ref)
19+
20+
## Utilities
21+
22+
- [`MNIST.download`](@ref)
23+
- [`MNIST.convert2features`](@ref)
24+
- [`MNIST.convert2image`](@ref)
25+
"""
226
module MNIST
327
using DataDeps
428
using ImageCore

0 commit comments

Comments
 (0)