diff --git a/.gitignore b/.gitignore index e4fecbbe..952f7cea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ Manifest.toml .vscode/ +docs/build/ +.DS_Store diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 00000000..e1455310 Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/make.jl b/docs/make.jl index 8d0504b2..47d64137 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,7 +2,7 @@ using Documenter, Optimisers, Zygote, StaticArrays, Functors DocMeta.setdocmeta!(Optimisers, :DocTestSetup, :(using Optimisers); recursive = true) -makedocs(modules = [Optimisers, Zygote, StaticArrays, Functors], +makedocs(modules = [Optimisers], doctest = false, sitename = "Optimisers.jl", pages = ["Home" => "index.md", diff --git a/docs/src/api.md b/docs/src/api.md index 661f83bc..5648d167 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -51,6 +51,7 @@ To further restrict this by ignoring some fields of a layer type, define `traina ```@docs Optimisers.trainable Optimisers.isnumeric +Optimisers.maywrite ``` Such restrictions are also obeyed by this function for flattening a model: @@ -68,4 +69,5 @@ Optimisers.init Optimisers.@.. Optimisers.@lazy Optimisers.adjust(::AbstractRule, ::Real) +Optimisers.@def ```