From ff9198b93977c78a6e70c4b5e19c590a47bd6b3e Mon Sep 17 00:00:00 2001 From: janEbert Date: Sat, 31 Aug 2019 12:51:37 +0200 Subject: [PATCH] Add datasets to docs All the relevant functions. Perhaps discuss a consistent API, describe it in the docs and then only document the modules. --- docs/make.jl | 10 +++++----- docs/src/datasets.md | 20 ++++++++++++++++++++ 2 files changed, 25 insertions(+), 5 deletions(-) create mode 100644 docs/src/datasets.md diff --git a/docs/make.jl b/docs/make.jl index f72237bc..0ee0ccab 100644 --- a/docs/make.jl +++ b/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", diff --git a/docs/src/datasets.md b/docs/src/datasets.md new file mode 100644 index 00000000..45e29a75 --- /dev/null +++ b/docs/src/datasets.md @@ -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() +``` +