Skip to content

Commit

Permalink
build based on 7888f9f
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 15, 2024
1 parent 34f108a commit 961769e
Show file tree
Hide file tree
Showing 32 changed files with 1,817 additions and 0 deletions.
1 change: 1 addition & 0 deletions previews/PR284/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-12-15T16:17:59","documenter_version":"1.8.0"}}
5 changes: 5 additions & 0 deletions previews/PR284/api/densenet/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>DenseNet · Metalhead.jl</title><meta name="title" content="DenseNet · Metalhead.jl"/><meta property="og:title" content="DenseNet · Metalhead.jl"/><meta property="twitter:title" content="DenseNet · Metalhead.jl"/><meta name="description" content="Documentation for Metalhead.jl."/><meta property="og:description" content="Documentation for Metalhead.jl."/><meta property="twitter:description" content="Documentation for Metalhead.jl."/><meta property="og:url" content="https://fluxml.ai/Metalhead.jl/stable/api/densenet/"/><meta property="twitter:url" content="https://fluxml.ai/Metalhead.jl/stable/api/densenet/"/><link rel="canonical" href="https://fluxml.ai/Metalhead.jl/stable/api/densenet/"/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script><link href="../../assets/flux.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">Metalhead.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../../tutorials/quickstart/">A guide to getting started with Metalhead</a></li><li><a class="tocitem" href="../../tutorials/pretrained/">Working with pre-trained models from Metalhead</a></li></ul></li><li><span class="tocitem">Guides</span><ul><li><a class="tocitem" href="../../howto/resnet/">Using the ResNet model family in Metalhead.jl</a></li></ul></li><li><a class="tocitem" href="../../contributing/">Contributing to Metalhead</a></li><li><span class="tocitem">API reference</span><ul><li><input class="collapse-toggle" id="menuitem-5-1" type="checkbox" checked/><label class="tocitem" for="menuitem-5-1"><span class="docs-label">Convolutional Neural Networks</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../resnet/">ResNet-like models</a></li><li class="is-active"><a class="tocitem" href>DenseNet</a><ul class="internal"><li><a class="tocitem" href="#The-higher-level-model"><span>The higher level model</span></a></li><li><a class="tocitem" href="#The-core-function"><span>The core function</span></a></li></ul></li><li><a class="tocitem" href="../efficientnet/">EfficientNet family of models</a></li><li><a class="tocitem" href="../mobilenet/">MobileNet family of models</a></li><li><a class="tocitem" href="../inception/">Inception family of models</a></li><li><a class="tocitem" href="../hybrid/">Hybrid CNN architectures</a></li><li><a class="tocitem" href="../others/">Other models</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5-2" type="checkbox"/><label class="tocitem" for="menuitem-5-2"><span class="docs-label">Mixers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../mixers/">MLPMixer-like models</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5-3" type="checkbox"/><label class="tocitem" for="menuitem-5-3"><span class="docs-label">Vision Transformers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../vit/">Vision Transformer models</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5-4" type="checkbox"/><label class="tocitem" for="menuitem-5-4"><span class="docs-label">Layers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../layers_intro/">An introduction to the <code>Layers</code> module in Metalhead.jl</a></li><li><a class="tocitem" href="../layers_adv/">More advanced layers</a></li></ul></li><li><a class="tocitem" href="../utilities/">Model Utilities</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API reference</a></li><li><a class="is-disabled">Convolutional Neural Networks</a></li><li class="is-active"><a href>DenseNet</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>DenseNet</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/FluxML/Metalhead.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/FluxML/Metalhead.jl/blob/master/docs/src/api/densenet.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="DenseNet"><a class="docs-heading-anchor" href="#DenseNet">DenseNet</a><a id="DenseNet-1"></a><a class="docs-heading-anchor-permalink" href="#DenseNet" title="Permalink"></a></h1><p>This is the API reference for the DenseNet model present in Metalhead.jl.</p><h2 id="The-higher-level-model"><a class="docs-heading-anchor" href="#The-higher-level-model">The higher level model</a><a id="The-higher-level-model-1"></a><a class="docs-heading-anchor-permalink" href="#The-higher-level-model" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Metalhead.DenseNet" href="#Metalhead.DenseNet"><code>Metalhead.DenseNet</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">DenseNet(config::Int; pretrain = false, growth_rate = 32,
reduction = 0.5, inchannels = 3, nclasses = 1000)</code></pre><p>Create a DenseNet model with specified configuration. Currently supported values are (121, 161, 169, 201) (<a href="https://arxiv.org/abs/1608.06993">reference</a>).</p><p><strong>Arguments</strong></p><ul><li><code>config</code>: the configuration of the model</li><li><code>pretrain</code>: whether to load the model with pre-trained weights for ImageNet.</li><li><code>growth_rate</code>: the output feature map growth probability of dense blocks (i.e. <code>k</code> in the ref)</li><li><code>reduction</code>: the factor by which the number of feature maps is scaled across each transition</li><li><code>inchannels</code>: the number of input channels</li><li><code>nclasses</code>: the number of output classes</li></ul><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p><code>DenseNet</code> does not currently support pretrained weights.</p></div></div><p>See also <a href="#Metalhead.densenet"><code>Metalhead.densenet</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/Metalhead.jl/blob/7888f9fa873a45c0bbf4f329c34c67037f065deb/src/convnets/densenet.jl#L119-L139">source</a></section></article><h2 id="The-core-function"><a class="docs-heading-anchor" href="#The-core-function">The core function</a><a id="The-core-function-1"></a><a class="docs-heading-anchor-permalink" href="#The-core-function" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Metalhead.densenet" href="#Metalhead.densenet"><code>Metalhead.densenet</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">densenet(nblocks::AbstractVector{Int}; growth_rate = 32,
reduction = 0.5, dropout_prob = nothing, inchannels = 3,
nclasses = 1000)</code></pre><p>Create a DenseNet model (<a href="https://arxiv.org/abs/1608.06993">reference</a>).</p><p><strong>Arguments</strong></p><ul><li><code>nblocks</code>: number of dense blocks between transitions</li><li><code>growth_rate</code>: the output feature map growth probability of dense blocks (i.e. <code>k</code> in the ref)</li><li><code>reduction</code>: the factor by which the number of feature maps is scaled across each transition</li><li><code>dropout_prob</code>: the dropout probability for the classifier head. Set to <code>nothing</code> to disable dropout</li><li><code>inchannels</code>: the number of input channels</li><li><code>nclasses</code>: the number of output classes</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/Metalhead.jl/blob/7888f9fa873a45c0bbf4f329c34c67037f065deb/src/convnets/densenet.jl#L90-L106">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../resnet/">« ResNet-like models</a><a class="docs-footer-nextpage" href="../efficientnet/">EfficientNet family of models »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Sunday 15 December 2024 16:17">Sunday 15 December 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 961769e

Please sign in to comment.