build based on eed0c64

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-12-26T17:09:30","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-01-05T01:57:59","documenter_version":"1.2.1"}}

dev/howto/resnet/index.html

@@ -8,4 +8,4 @@
                                  stochastic_depth_prob = 0.2)</code></pre><p>To make this a ResNeXt-like model, all we need to do is configure the cardinality and the  base width:</p><pre><code class="language-julia hljs">custom_resnet = Metalhead.resnet(Metalhead.bottleneck, [3, 4, 6, 3];
                                  cardinality = 32, base_width = 4,
                                  pool_layer = AdaptiveMeanMaxPool((1, 1)),
-                                 stochastic_depth_prob = 0.2)</code></pre><p>And we have a custom model, built with minimal effort! The documentation for <a href="../../api/resnet/#Metalhead.resnet"><code>Metalhead.resnet</code></a> has been written with extensive care and in as much detail as possible to facilitate ease of use. Still, if you find anything difficult to understand, feel free to open an issue and we will be happy to help you out, and to improve the documentation where necessary.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/pretrained/">« Working with pre-trained models from Metalhead</a><a class="docs-footer-nextpage" href="../../contributing/">Contributing to Metalhead »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 17:09">Tuesday 26 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                                 stochastic_depth_prob = 0.2)</code></pre><p>And we have a custom model, built with minimal effort! The documentation for <a href="../../api/resnet/#Metalhead.resnet"><code>Metalhead.resnet</code></a> has been written with extensive care and in as much detail as possible to facilitate ease of use. Still, if you find anything difficult to understand, feel free to open an issue and we will be happy to help you out, and to improve the documentation where necessary.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/pretrained/">« Working with pre-trained models from Metalhead</a><a class="docs-footer-nextpage" href="../../contributing/">Contributing to Metalhead »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 5 January 2024 01:57">Friday 5 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/tutorials/pretrained/index.html

@@ -268,4 +268,4 @@
         logitcrossentropy(m(x), y)
     end;
     state, model = Optimisers.update(state, model, gs);
-end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../quickstart/">« A guide to getting started with Metalhead</a><a class="docs-footer-nextpage" href="../../howto/resnet/">Using the ResNet model family in Metalhead.jl »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 17:09">Tuesday 26 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../quickstart/">« A guide to getting started with Metalhead</a><a class="docs-footer-nextpage" href="../../howto/resnet/">Using the ResNet model family in Metalhead.jl »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 5 January 2024 01:57">Friday 5 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/tutorials/quickstart/index.html

@@ -3,4 +3,4 @@
 
 model = ResNet(18);</code></pre><p>The API reference contains the documentation and options for each model function. These models also support the option for loading pre-trained weights from ImageNet.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Metalhead is still under active development and thus not all models have pre-trained weights supported. While we are working on expanding the footprint of the pre-trained models, if you would like to help contribute model weights yourself, please check out the <a href="../../contributing/#contributing">contributing guide</a> guide.</p></div></div><p>To use a pre-trained model, just instantiate the model with the <code>pretrain</code> keyword argument set to <code>true</code>:</p><pre><code class="language-julia hljs">using Metalhead
 
-model = ResNet(18; pretrain = true);</code></pre><p>Refer to the <a href="../pretrained/#pretrained">pretraining guide</a> for more details on how to use pre-trained models.</p><h2 id="More-model-configuration-options"><a class="docs-heading-anchor" href="#More-model-configuration-options">More model configuration options</a><a id="More-model-configuration-options-1"></a><a class="docs-heading-anchor-permalink" href="#More-model-configuration-options" title="Permalink"></a></h2><p>For users who want to use more options for model configuration, Metalhead provides a &quot;mid-level&quot; API for models. These are the model functions that are in lowercase such as <a href="../../api/resnet/#Metalhead.resnet"><code>Metalhead.resnet</code></a> or <a href="../../api/mobilenet/#Metalhead.mobilenetv3"><code>Metalhead.mobilenetv3</code></a>. End-users who want to experiment with model architectures should use these functions. These models do not support the option for loading pre-trained weights from ImageNet out of the box, although one can always load weights explicitly using the <code>loadmodel!</code> function from Flux.</p><p>To use any of these models, check out the docstrings for the model functions (these are documented in the API reference). Note that these functions typically require more configuration options to be passed in, but offer a lot more flexibility in terms of model architecture. Metalhead defines as many default options as possible so as to make it easier for the user to pick and choose specific options to customise.</p><h2 id="Builders-for-the-advanced-user"><a class="docs-heading-anchor" href="#Builders-for-the-advanced-user">Builders for the advanced user</a><a id="Builders-for-the-advanced-user-1"></a><a class="docs-heading-anchor-permalink" href="#Builders-for-the-advanced-user" title="Permalink"></a></h2><p>For users who want the ability to customise their models as much as possible, Metalhead offers a powerful low-level interface. These are known as <strong>builders</strong> and allow the user to hack into the core of models and build them up as per their liking. Most users will not need to use builders since a large number of configuration options are exposed at the mid-level API. However, for package developers and users who want to build customised versions of their own models, the low-level API provides the customisability required while still reducing user code.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../pretrained/">Working with pre-trained models from Metalhead »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 17:09">Tuesday 26 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+model = ResNet(18; pretrain = true);</code></pre><p>Refer to the <a href="../pretrained/#pretrained">pretraining guide</a> for more details on how to use pre-trained models.</p><h2 id="More-model-configuration-options"><a class="docs-heading-anchor" href="#More-model-configuration-options">More model configuration options</a><a id="More-model-configuration-options-1"></a><a class="docs-heading-anchor-permalink" href="#More-model-configuration-options" title="Permalink"></a></h2><p>For users who want to use more options for model configuration, Metalhead provides a &quot;mid-level&quot; API for models. These are the model functions that are in lowercase such as <a href="../../api/resnet/#Metalhead.resnet"><code>Metalhead.resnet</code></a> or <a href="../../api/mobilenet/#Metalhead.mobilenetv3"><code>Metalhead.mobilenetv3</code></a>. End-users who want to experiment with model architectures should use these functions. These models do not support the option for loading pre-trained weights from ImageNet out of the box, although one can always load weights explicitly using the <code>loadmodel!</code> function from Flux.</p><p>To use any of these models, check out the docstrings for the model functions (these are documented in the API reference). Note that these functions typically require more configuration options to be passed in, but offer a lot more flexibility in terms of model architecture. Metalhead defines as many default options as possible so as to make it easier for the user to pick and choose specific options to customise.</p><h2 id="Builders-for-the-advanced-user"><a class="docs-heading-anchor" href="#Builders-for-the-advanced-user">Builders for the advanced user</a><a id="Builders-for-the-advanced-user-1"></a><a class="docs-heading-anchor-permalink" href="#Builders-for-the-advanced-user" title="Permalink"></a></h2><p>For users who want the ability to customise their models as much as possible, Metalhead offers a powerful low-level interface. These are known as <strong>builders</strong> and allow the user to hack into the core of models and build them up as per their liking. Most users will not need to use builders since a large number of configuration options are exposed at the mid-level API. However, for package developers and users who want to build customised versions of their own models, the low-level API provides the customisability required while still reducing user code.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../pretrained/">Working with pre-trained models from Metalhead »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 5 January 2024 01:57">Friday 5 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>