Skip to content

Commit

Permalink
build based on 03a4278
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 19, 2024
1 parent 58748fe commit 127a407
Show file tree
Hide file tree
Showing 25 changed files with 1,662 additions and 1,676 deletions.
28 changes: 14 additions & 14 deletions previews/PR533/api/Lux/contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Training State containing:
* `step`: Number of updates of the parameters made.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/training.jl#L1-L11' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/training.jl#L1-L11' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -103,7 +103,7 @@ A 4-Tuple containing:
* `ts`: Updated Training State.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/training.jl#L66-L90' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/training.jl#L66-L90' class='documenter-source'>source</a><br>

</div>
<br>
Expand All @@ -128,7 +128,7 @@ Update the parameters stored in `ts` using the gradients `grads`.
Updated `TrainState` object.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/training.jl#L47-L60' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/training.jl#L47-L60' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -205,7 +205,7 @@ m = Lux.Experimental.FrozenLayer(Dense(2 => 2), (:weight,))
See also [`Lux.Experimental.freeze`](contrib#Lux.Experimental.freeze), [`Lux.Experimental.unfreeze`](contrib#Lux.Experimental.unfreeze).


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/freeze.jl#L1-L57' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/freeze.jl#L1-L57' class='documenter-source'>source</a><br>

</div>
<br>
Expand All @@ -221,7 +221,7 @@ freeze(l::AbstractExplicitLayer, which_params::Union{Tuple, Nothing} = nothing)
Constructs a version of `l` with `which_params` frozen. If `which_params` is nothing, then all parameters are frozen.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/freeze.jl#L107-L112' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/freeze.jl#L107-L112' class='documenter-source'>source</a><br>


```
Expand All @@ -232,7 +232,7 @@ freeze(l::AbstractExplicitLayer, ps, st::NamedTuple,
Construct a [`Lux.Experimental.FrozenLayer`](contrib#Lux.Experimental.FrozenLayer) for `l` with the current parameters and states. If `which_params` is nothing, then all parameters are frozen.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/freeze.jl#L117-L123' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/freeze.jl#L117-L123' class='documenter-source'>source</a><br>

</div>
<br>
Expand All @@ -248,7 +248,7 @@ unfreeze(l::FrozenLayer)
Unfreezes the layer `l`.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/freeze.jl#L141-L145' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/freeze.jl#L141-L145' class='documenter-source'>source</a><br>


```
Expand All @@ -258,7 +258,7 @@ unfreeze(l::FrozenLayer, ps, st::NamedTuple)
Unwraps a [`Lux.Experimental.FrozenLayer`](contrib#Lux.Experimental.FrozenLayer) `l` with the current parameters and states.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/freeze.jl#L148-L152' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/freeze.jl#L148-L152' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -319,7 +319,7 @@ Lux.layer_map(zero_dense_params, c, ps, st)
```


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/map.jl#L39' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/map.jl#L39' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -360,7 +360,7 @@ Lux.@layer_map zero_dense_params c ps st
```


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/map.jl#L1' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/map.jl#L1' class='documenter-source'>source</a><br>

</div>
<br>
Expand All @@ -386,7 +386,7 @@ Recurses into the `layer` and replaces the inner most non Container Layers with
See [`Lux.Experimental.DebugLayer`](contrib#Lux.Experimental.DebugLayer) for details about the Keyword Arguments.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/debug.jl#L158-L165' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/debug.jl#L158-L165' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -438,7 +438,7 @@ If `nan_check` is enabled and NaNs are detected then a `DomainError` is thrown.
See [`Lux.Experimental.@debug_mode`](contrib#Lux.Experimental.@debug_mode) to construct this layer.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/debug.jl#L1-L49' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/debug.jl#L1-L49' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -482,7 +482,7 @@ ps = Lux.share_parameters(ps, (("d3.l2", "d1"), ("d2", "d3.l1")))
```


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/share_parameters.jl#L3-L36' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/share_parameters.jl#L3-L36' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -606,7 +606,7 @@ Array Parameter don't print the number of parameters on the side. However, they
:::


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/ced058c3665a75ab7d3802814f8f595919e827e2/src/contrib/compact.jl#L14-L130' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/03a42788a45c027ea5118717b0dee1454313c547/src/contrib/compact.jl#L14-L130' class='documenter-source'>source</a><br>

</div>
<br>
Loading

0 comments on commit 127a407

Please sign in to comment.