Add Optimiser.jl as a doc dependency

Add `cpu` and `gpu` to the manual and `Optimisers.jl` as a dependency
FluxML · Jul 28, 2022 · 46932c7 · 46932c7
1 parent d660eda
commit 46932c7
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 3 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -4,6 +4,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Functors = "d9f16b24-f501-4c13-a1f2-28368ffc5196"
 MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
 NNlib = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"
+Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
 
 [compat]
 Documenter = "0.26"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,10 +1,10 @@
-using Documenter, Flux, NNlib, Functors, MLUtils, BSON
+using Documenter, Flux, NNlib, Functors, MLUtils, BSON, Optimisers
 
 
 DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive = true)
 
 makedocs(
-    modules = [Flux, NNlib, Functors, MLUtils, BSON],
+    modules = [Flux, NNlib, Functors, MLUtils, BSON, Optimisers],
     doctest = false,
     sitename = "Flux",
     pages = [

diff --git a/docs/src/gpu.md b/docs/src/gpu.md
@@ -86,6 +86,11 @@ julia> x |> cpu
  0.7766742
 ```
 
+```@docs
+cpu
+gpu
+```
+
 ## Common GPU Workflows
 
 Some of the common workflows involving the use of GPUs are presented below.

diff --git a/docs/src/training/optimisers.md b/docs/src/training/optimisers.md
@@ -1,3 +1,7 @@
+```@meta
+CurrentModule = Flux
+```
+
 # Optimisers
 
 Consider a [simple linear regression](../models/basics.md). We create some dummy data, calculate a loss, and backpropagate to calculate gradients for the parameters `W` and `b`.
@@ -189,3 +193,13 @@ opt = Optimiser(ClipValue(1e-3), Adam(1e-3))
 ClipValue
 ClipNorm
 ```
+
+# Optimisers.jl
+
+Flux re-exports some utility functions from [`Optimisers.jl`](https://github.com/FluxML/Optimisers.jl)
+and the complete `Optimisers` package under the `Flux.Optimisers` namespace.
+
+```@docs
+Optimisers.destructure
+Optimisers.trainable
+```
diff --git a/docs/src/utilities.md b/docs/src/utilities.md
@@ -107,7 +107,6 @@ Flux.outputsize
 
 ```@docs
 Flux.modules
-Flux.destructure
 Flux.nfan
 ```