Add MLUtils's docs and fix some missing docstrings (#1910)

* Add `MLUtils` to doc dependencies and fix missing `DataLoader` docstring

* Fix `siamese_contrastive_loss` docs

* Fix `Flux.flatten` docs

* Create `mlutils.md`

* Change relative path for `MLUtils`

* `H2` heading -> `H1` heading

Author: Saransh-cpp

docs/Project.toml

@@ -2,6 +2,7 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Functors = "d9f16b24-f501-4c13-a1f2-28368ffc5196"
 NNlib = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"
+MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
 
 [compat]
 Documenter = "0.26"

docs/make.jl

@@ -1,7 +1,7 @@
-using Documenter, Flux, NNlib, Functors
+using Documenter, Flux, NNlib, Functors, MLUtils
 
 DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive = true)
-makedocs(modules = [Flux, NNlib, Functors],
+makedocs(modules = [Flux, NNlib, Functors, MLUtils],
          doctest = VERSION == v"1.5",
          sitename = "Flux",
          pages = ["Home" => "index.md",
@@ -17,7 +17,7 @@ makedocs(modules = [Flux, NNlib, Functors],
                      "Functors" => "models/functors.md"],
                   "Handling Data" =>
                     ["One-Hot Encoding" => "data/onehot.md",
-                     "DataLoader" => "data/dataloader.md"],
+                     "MLUtils" => "data/mlutils.md"],
                   "Training Models" =>
                     ["Optimisers" => "training/optimisers.md",
                      "Training" => "training/training.md"],

docs/src/data/dataloader.md

@@ -0,0 +1,31 @@
+# MLUtils.jl
+
+Flux re-exports the `DataLoader` type and utility functions for working with
+data from [MLUtils](https://github.com/JuliaML/MLUtils.jl).
+
+## DataLoader
+
+`DataLoader` can be used to handle iteration over mini-batches of data.
+
+```@docs
+MLUtils.DataLoader
+```
+
+## Utility functions for working with data
+
+The utility functions are meant to be used while working with data;
+these functions help create inputs for your models or batch your dataset.
+
+Below is a non-exhaustive list of such utility functions.
+
+```@docs
+MLUtils.unsqueeze
+MLUtils.stack
+MLUtils.unstack
+MLUtils.chunk
+MLUtils.group_counts
+MLUtils.batch
+MLUtils.unbatch
+MLUtils.batchseq
+MLUtils.rpad(v::AbstractVector, n::Integer, p)
+```

docs/src/data/mlutils.md

@@ -1,6 +1,6 @@
-## Functors.jl
+# Functors.jl
 
-Flux makes use of the Functors.jl to represent many of the core functionalities it provides.
+Flux makes use of the [Functors.jl](https://github.com/FluxML/Functors.jl) to represent many of the core functionalities it provides.
 
 Functors.jl is a collection of tools designed to represent a [functor](https://en.wikipedia.org/wiki/Functor_(functional_programming)). Flux makes use of it to treat certain structs as functors. Notable examples include the layers that Flux defines.
 

docs/src/models/functors.md

@@ -23,7 +23,7 @@ DepthwiseConv
 ConvTranspose
 CrossCor
 SamePad
-flatten
+Flux.flatten
 Flux.convfilter
 Flux.depthwiseconvfilter
 ```

docs/src/models/layers.md

@@ -41,5 +41,5 @@ Flux.Losses.dice_coeff_loss
 Flux.Losses.tversky_loss
 Flux.Losses.binary_focal_loss
 Flux.Losses.focal_loss
-Flux.losses.siamese_contrastive_loss
+Flux.Losses.siamese_contrastive_loss
 ```

docs/src/models/losses.md

@@ -1,4 +1,4 @@
-# NNlib
+# NNlib.jl
 
 Flux re-exports all of the functions exported by the [NNlib](https://github.com/FluxML/NNlib.jl) package.
 

docs/src/models/nnlib.md

@@ -1,25 +1,7 @@
 # Utility Functions
 
-Flux contains some utility functions for working with data; these functions
-help create inputs for your models or batch your dataset.
-Other functions can be used to initialize your layers or to regularly execute
-callback functions.
-
-## Working with Data
-
-Utilities for data processing are provided by [MLUtils.jl](https://github.com/JuliaML/MLUtils.jl). Below is a non-exhaustive list.
-
-```@docs
-MLUtils.unsqueeze
-MLUtils.stack
-MLUtils.unstack
-MLUtils.chunk
-MLUtils.group_counts
-MLUtils.batch
-MLUtils.unbatch
-MLUtils.batchseq
-Base.rpad(v::AbstractVector, n::Integer, p)
-```
+Flux provides utility functions which can be used to initialize your layers
+or to regularly execute callback functions.
 
 ## Layer Initialization