Add datasets to docs
All the relevant functions. Perhaps discuss a consistent API, describe it in the docs and then only document the modules.
This commit is contained in:
parent
740a59d0a6
commit
ff9198b939
10
docs/make.jl
10
docs/make.jl
|
@ -4,11 +4,6 @@ DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive=true)
|
|||
makedocs(modules=[Flux, NNlib],
|
||||
doctest = true,
|
||||
sitename = "Flux",
|
||||
format = Documenter.HTML(
|
||||
analytics = "UA-36890222-9",
|
||||
assets = ["assets/flux.css"],
|
||||
prettyurls = get(ENV, "CI", nothing) == "true",
|
||||
),
|
||||
pages = ["Home" => "index.md",
|
||||
"Building Models" =>
|
||||
["Basics" => "models/basics.md",
|
||||
|
@ -29,7 +24,12 @@ makedocs(modules=[Flux, NNlib],
|
|||
"The Julia Ecosystem" => "ecosystem.md",
|
||||
"Utility Functions" => "utilities.md",
|
||||
"Performance Tips" => "performance.md",
|
||||
"Datasets" => "datasets.md",
|
||||
"Community" => "community.md"],
|
||||
format = Documenter.HTML(
|
||||
analytics = "UA-36890222-9",
|
||||
assets = ["assets/flux.css"],
|
||||
prettyurls = get(ENV, "CI", nothing) == "true"),
|
||||
)
|
||||
|
||||
deploydocs(repo = "github.com/FluxML/Flux.jl.git",
|
||||
|
|
|
@ -0,0 +1,20 @@
|
|||
# Datasets
|
||||
|
||||
Flux includes several standard machine learning datasets.
|
||||
|
||||
```@docs
|
||||
Flux.Data.Iris.features()
|
||||
Flux.Data.Iris.labels()
|
||||
Flux.Data.MNIST.images()
|
||||
Flux.Data.MNIST.labels()
|
||||
Flux.Data.FashionMNIST.images()
|
||||
Flux.Data.FashionMNIST.labels()
|
||||
Flux.Data.CMUDict.phones()
|
||||
Flux.Data.CMUDict.symbols()
|
||||
Flux.Data.CMUDict.rawdict()
|
||||
Flux.Data.CMUDict.cmudict()
|
||||
Flux.Data.Sentiment.train()
|
||||
Flux.Data.Sentiment.test()
|
||||
Flux.Data.Sentiment.dev()
|
||||
```
|
||||
|
Loading…
Reference in New Issue