add download documentation

Author: Evizero

docs/src/datasets/CIFAR10.md

@@ -42,7 +42,7 @@ information on the interface take a look at the documentation
 
 Function | Description
 ---------|-------------
-`download([dir])` | Trigger interactive download of the dataset
+[`download([dir])`](@ref CIFAR10.download) | Trigger interactive download of the dataset
 [`classnames()`](@ref CIFAR10.classnames) | Return the class names as a vector of strings
 [`traintensor([T], [indices]; [dir])`](@ref CIFAR10.traintensor) | Load the training images as an array of eltype `T`
 [`trainlabels([indices]; [dir])`](@ref CIFAR10.trainlabels) | Load the labels for the training images
@@ -104,6 +104,7 @@ CIFAR10.testdata
 ### Utilities
 
 ```@docs
+CIFAR10.download
 CIFAR10.classnames
 CIFAR10.convert2features
 CIFAR10.convert2image

docs/src/datasets/CIFAR100.md

@@ -45,9 +45,9 @@ information on the interface take a look at the documentation
 
 Function | Description
 ---------|-------------
-`download([dir])` | Trigger interactive download of the dataset
-[`classnames_coarse()`](@ref CIFAR100.classnames_coarse) | Return the 20 super-class names as a vector of strings
-[`classnames_fine()`](@ref CIFAR100.classnames_fine) | Return the 100 class names as a vector of strings
+[`download([dir])`](@ref CIFAR100.download) | Trigger interactive download of the dataset
+[`classnames_coarse(; [dir])`](@ref CIFAR100.classnames_coarse) | Return the 20 super-class names as a vector of strings
+[`classnames_fine(; [dir])`](@ref CIFAR100.classnames_fine) | Return the 100 class names as a vector of strings
 [`traintensor([T], [indices]; [dir])`](@ref CIFAR100.traintensor) | Load the training images as an array of eltype `T`
 [`trainlabels([indices]; [dir])`](@ref CIFAR100.trainlabels) | Load the labels for the training images
 [`testtensor([T], [indices]; [dir])`](@ref CIFAR100.testtensor) | Load the test images as an array of eltype `T`
@@ -111,6 +111,7 @@ See [`CIFAR10.convert2features`](@ref) and
 [`CIFAR10.convert2image`](@ref)
 
 ```@docs
+CIFAR100.download
 CIFAR100.classnames_coarse
 CIFAR100.classnames_fine
 ```

docs/src/datasets/FashionMNIST.md

@@ -42,7 +42,7 @@ information on the interface take a look at the documentation
 
 Function | Description
 ---------|-------------
-`download([dir])` | Trigger (interactive) download of the dataset
+[`download([dir])`](@ref FashionMNIST.download) | Trigger (interactive) download of the dataset
 [`classnames()`](@ref FashionMNIST.classnames) | Return the class names as a vector of strings
 [`traintensor([T], [indices]; [dir])`](@ref FashionMNIST.traintensor) | Load the training images as an array of eltype `T`
 [`trainlabels([indices]; [dir])`](@ref FashionMNIST.trainlabels) | Load the labels for the training images
@@ -109,6 +109,7 @@ See [`MNIST.convert2features`](@ref) and
 [`MNIST.convert2image`](@ref)
 
 ```@docs
+FashionMNIST.download
 FashionMNIST.classnames
 ```
 

docs/src/datasets/MNIST.md

@@ -43,7 +43,7 @@ information on the interface take a look at the documentation
 
 Function | Description
 ---------|-------------
-`download([dir])` | Trigger (interactive) download of the dataset
+[`download([dir])`](@ref MNIST.download) | Trigger (interactive) download of the dataset
 [`traintensor([T], [indices]; [dir])`](@ref MNIST.traintensor) | Load the training images as an array of eltype `T`
 [`trainlabels([indices]; [dir])`](@ref MNIST.trainlabels) | Load the labels for the training images
 [`testtensor([T], [indices]; [dir])`](@ref MNIST.testtensor) | Load the test images as an array of eltype `T`
@@ -105,6 +105,7 @@ MNIST.testdata
 ### Utilities
 
 ```@docs
+MNIST.download
 MNIST.convert2features
 MNIST.convert2image
 ```

src/CIFAR10/CIFAR10.jl

@@ -50,6 +50,19 @@ module CIFAR10
         "truck",
     ]
 
+    """
+        download([dir]; [i_accept_the_terms_of_use])
+
+    Trigger the (interactive) download of the full dataset into
+    "<`dir`>/$DEPNAME". If no `dir` is provided the dataset will
+    be downloaded into "~/.julia/datadeps/$DEPNAME".
+
+    This function will display an interactive dialog unless
+    either the keyword parameter `i_accept_the_terms_of_use` or
+    the environment variable `DATADEPS_ALWAY_ACCEPT` is set to
+    `true`. Note that using the data responsibly and respecting
+    copyright/terms-of-use remains your responsibility.
+    """
     download(args...; kw...) = download_dep(DEPNAME, args...; kw...)
 
     include(joinpath("Reader","Reader.jl"))

src/CIFAR100/CIFAR100.jl

@@ -38,6 +38,19 @@ module CIFAR100
     const TRAINSET_SIZE = 50_000
     const TESTSET_SIZE  = 10_000
 
+    """
+        download([dir]; [i_accept_the_terms_of_use])
+
+    Trigger the (interactive) download of the full dataset into
+    "<`dir`>/$DEPNAME". If no `dir` is provided the dataset will
+    be downloaded into "~/.julia/datadeps/$DEPNAME".
+
+    This function will display an interactive dialog unless
+    either the keyword parameter `i_accept_the_terms_of_use` or
+    the environment variable `DATADEPS_ALWAY_ACCEPT` is set to
+    `true`. Note that using the data responsibly and respecting
+    copyright/terms-of-use remains your responsibility.
+    """
     download(args...; kw...) = download_dep(DEPNAME, args...; kw...)
 
     include(joinpath("Reader","Reader.jl"))

src/FashionMNIST/FashionMNIST.jl

@@ -47,6 +47,19 @@ module FashionMNIST
         "Ankle boot"
     ]
 
+    """
+        download([dir]; [i_accept_the_terms_of_use])
+
+    Trigger the (interactive) download of the full dataset into
+    "<`dir`>/$DEPNAME". If no `dir` is provided the dataset will
+    be downloaded into "~/.julia/datadeps/$DEPNAME".
+
+    This function will display an interactive dialog unless
+    either the keyword parameter `i_accept_the_terms_of_use` or
+    the environment variable `DATADEPS_ALWAY_ACCEPT` is set to
+    `true`. Note that using the data responsibly and respecting
+    copyright/terms-of-use remains your responsibility.
+    """
     download(args...; kw...) = download_dep(DEPNAME, args...; kw...)
 
     include("interface.jl")

src/MNIST/MNIST.jl

@@ -31,6 +31,19 @@ module MNIST
     const TESTIMAGES  = "t10k-images-idx3-ubyte.gz"
     const TESTLABELS  = "t10k-labels-idx1-ubyte.gz"
 
+    """
+        download([dir]; [i_accept_the_terms_of_use])
+
+    Trigger the (interactive) download of the full dataset into
+    "<`dir`>/$DEPNAME". If no `dir` is provided the dataset will
+    be downloaded into "~/.julia/datadeps/$DEPNAME".
+
+    This function will display an interactive dialog unless
+    either the keyword parameter `i_accept_the_terms_of_use` or
+    the environment variable `DATADEPS_ALWAY_ACCEPT` is set to
+    `true`. Note that using the data responsibly and respecting
+    copyright/terms-of-use remains your responsibility.
+    """
     download(args...; kw...) = download_dep(DEPNAME, args...; kw...)
 
     include(joinpath("Reader","Reader.jl"))