diff --git a/docs/Project.toml b/docs/Project.toml index dfa65cd1..11387b51 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,2 +1,6 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +ImageCore = "a09fc81d-aa75-5fe9-8630-4744c3626534" +ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19" +ImageShow = "4e3cecfd-b093-5904-9786-8bbb286a6a31" +MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458" diff --git a/docs/make.jl b/docs/make.jl index 71aa5542..9523a925 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,4 +1,5 @@ using Documenter, MLDatasets +using ImageShow # for better image display ## Commented out since gives warning # DocMeta.setdocmeta!(MLDatasets, :DocTestSetup, :(using MLDatasets); recursive=true) @@ -34,7 +35,7 @@ makedocs( "Iris" => "datasets/Iris.md", "Boston Housing" => "datasets/BostonHousing.md", ], - + "Text" => Any[ "PTBLM" => "datasets/PTBLM.md", "UD_English" => "datasets/UD_English.md", @@ -54,4 +55,4 @@ makedocs( ) -deploydocs(repo = "github.com/JuliaML/MLDatasets.jl.git") \ No newline at end of file +deploydocs(repo = "github.com/JuliaML/MLDatasets.jl.git") diff --git a/docs/src/index.md b/docs/src/index.md index efa74fb6..6cb7b14b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -55,3 +55,20 @@ will trigger a download dialog to `~/.julia/datadeps/MNIST`. To overwrite this on a case by case basis, it is possible to specify a data directory directly in `traindata(dir = )` and `testdata(dir = )`. + +## Preview + +For image dataset, [`MosaicViews`](https://github.com/JuliaArrays/MosaicViews.jl) provides a very simple interface to display a list +of images. + +```@example +using MLDatasets +using ImageCore + +# The original dataset is stored in row-major order, to display it +# normally in Julia, we need to permute the first two dimensions. +test_x = Gray.(PermutedDimsArray(MNIST.testtensor(), (2, 1, 3))); +test_x_sample = @view test_x[:, :, 1:64]; + +mosaic(test_x_sample, nrow=8) +```