Skip to content

Commit

Permalink
build based on 04cb416
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 23, 2024
1 parent 6433039 commit f0c3a95
Show file tree
Hide file tree
Showing 24 changed files with 850 additions and 838 deletions.
26 changes: 13 additions & 13 deletions dev/api/Lux/contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Training State containing:
* `step`: Number of updates of the parameters made.


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/training.jl#L3-L13' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/training.jl#L3-L13' class='documenter-source'>source</a><br>

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


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/training.jl#L24-L48' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/training.jl#L24-L48' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -184,7 +184,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/freeze.jl#L1-L57' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/freeze.jl#L1-L57' class='documenter-source'>source</a><br>

</div>
<br>
Expand All @@ -200,7 +200,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/freeze.jl#L107-L112' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/freeze.jl#L107-L112' class='documenter-source'>source</a><br>


```
Expand All @@ -211,7 +211,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/freeze.jl#L117-L123' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/freeze.jl#L117-L123' class='documenter-source'>source</a><br>

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


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


```
Expand All @@ -237,7 +237,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/freeze.jl#L148-L152' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/freeze.jl#L148-L152' class='documenter-source'>source</a><br>

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


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/map.jl#L42' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/map.jl#L42' class='documenter-source'>source</a><br>

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


<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/map.jl#L4' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/map.jl#L4' class='documenter-source'>source</a><br>

</div>
<br>
Expand All @@ -365,7 +365,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/debug.jl#L158-L165' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/debug.jl#L158-L165' class='documenter-source'>source</a><br>

</div>
<br>
Expand Down Expand Up @@ -417,7 +417,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/debug.jl#L1-L49' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/debug.jl#L1-L49' class='documenter-source'>source</a><br>

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


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

</div>
<br>
Expand Down Expand Up @@ -585,7 +585,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/f85b7cec8cb13eab4590d565af408315c1b2750e/src/contrib/compact.jl#L17-L133' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/LuxDL/Lux.jl/blob/04cb416d3b1bf89f60e4bc7bb5ba2db622094b18/src/contrib/compact.jl#L15-L131' class='documenter-source'>source</a><br>

</div>
<br>
Loading

0 comments on commit f0c3a95

Please sign in to comment.