Skip to content

Commit

Permalink
build based on c3e6339
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 22, 2024
1 parent fb674a6 commit a20d05a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-11T07:00:38","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-22T14:45:17","documenter_version":"1.3.0"}}
6 changes: 3 additions & 3 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
fit!(mach)
yhat = MLJBase.predict(mach, env)
# output
```</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/d6c20f09ce77c7ac05c9de28a67987789b251894/src/mlj_interface.jl#L26-L47">source</a></section></article><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="Maxnet.complexity-Tuple{Maxnet.MaxnetModel}" href="#Maxnet.complexity-Tuple{Maxnet.MaxnetModel}"><code>Maxnet.complexity</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Get the number of non-zero coefficients in the model</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/d6c20f09ce77c7ac05c9de28a67987789b251894/src/types.jl#L24">source</a></section></article><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="Maxnet.default_features-Tuple{Any}" href="#Maxnet.default_features-Tuple{Any}"><code>Maxnet.default_features</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">default_features(np)</code></pre><p>Takes the number of presences <code>np</code> and returns a <code>Vector</code> of <code>AbstractFeatureClass</code>s that are used my maxent as default.</p><p>If <code>np</code> is less than ten, then only <code>LinearFeature</code> and <code>CategoricalFeature</code> are used. If it is at least 10, then <code>QuadraticFeature</code> is additionally used. If it is at least 15, then <code>HingeFeature</code> is additionally used. If it is at least 80, then <code>ProductFeature</code> is additionally used.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/d6c20f09ce77c7ac05c9de28a67987789b251894/src/feature_classes.jl#L30-L39">source</a></section></article><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="Maxnet.maxnet-Tuple{BitVector, Any}" href="#Maxnet.maxnet-Tuple{BitVector, Any}"><code>Maxnet.maxnet</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">maxnet(
```</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/c3e63390eb5eff9bbfaecea5b6ee8ca683038cff/src/mlj_interface.jl#L26-L47">source</a></section></article><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="Maxnet.complexity-Tuple{Maxnet.MaxnetModel}" href="#Maxnet.complexity-Tuple{Maxnet.MaxnetModel}"><code>Maxnet.complexity</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Get the number of non-zero coefficients in the model</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/c3e63390eb5eff9bbfaecea5b6ee8ca683038cff/src/types.jl#L24">source</a></section></article><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="Maxnet.default_features-Tuple{Any}" href="#Maxnet.default_features-Tuple{Any}"><code>Maxnet.default_features</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">default_features(np)</code></pre><p>Takes the number of presences <code>np</code> and returns a <code>Vector</code> of <code>AbstractFeatureClass</code>s that are used my maxent as default.</p><p>If <code>np</code> is less than ten, then only <code>LinearFeature</code> and <code>CategoricalFeature</code> are used. If it is at least 10, then <code>QuadraticFeature</code> is additionally used. If it is at least 15, then <code>HingeFeature</code> is additionally used. If it is at least 80, then <code>ProductFeature</code> is additionally used.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/c3e63390eb5eff9bbfaecea5b6ee8ca683038cff/src/feature_classes.jl#L30-L39">source</a></section></article><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="Maxnet.maxnet-Tuple{BitVector, Any}" href="#Maxnet.maxnet-Tuple{BitVector, Any}"><code>Maxnet.maxnet</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">maxnet(
presences, predictors;
features, regularization_multiplier, regularization_function,
addsamplestobackground, weight_factor, backend,
Expand All @@ -32,9 +32,9 @@
Features classes: Maxnet.AbstractFeatureClass[LinearFeature(), CategoricalFeature(), QuadraticFeature()]
Entropy: 6.114650341746531
Model complexity: 21
Variables selected: [:frs6190_ann, :h_dem, :pre6190_l1, :pre6190_l10, :pre6190_l4, :pre6190_l7, :tmn6190_ann, :vap6190_ann, :ecoreg, :cld6190_ann, :dtr6190_ann, :tmx6190_ann]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/d6c20f09ce77c7ac05c9de28a67987789b251894/src/maxnet_function.jl#L1-L44">source</a></section></article><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="Maxnet.predict-Tuple{Maxnet.MaxnetModel, Any}" href="#Maxnet.predict-Tuple{Maxnet.MaxnetModel, Any}"><code>Maxnet.predict</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">predict(m, x; link, clamp)
Variables selected: [:frs6190_ann, :h_dem, :pre6190_l1, :pre6190_l10, :pre6190_l4, :pre6190_l7, :tmn6190_ann, :vap6190_ann, :ecoreg, :cld6190_ann, :dtr6190_ann, :tmx6190_ann]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/c3e63390eb5eff9bbfaecea5b6ee8ca683038cff/src/maxnet_function.jl#L1-L44">source</a></section></article><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="Maxnet.predict-Tuple{Maxnet.MaxnetModel, Any}" href="#Maxnet.predict-Tuple{Maxnet.MaxnetModel, Any}"><code>Maxnet.predict</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">predict(m, x; link, clamp)

Use a maxnet model to predict on new data.</code></pre><p><strong>Arguments</strong></p><ul><li><code>m</code>: a MaxnetModel as returned by <code>maxnet</code></li><li><code>x</code>: a <code>Tables.jl</code>-compatible table of predictors. All columns that were used to fit <code>m</code> should be present in <code>x</code></li></ul><p><strong>Keywords</strong></p><ul><li><code>link</code>: the link function used. Defaults to CloglogLink(), which is the default on the Maxent Java appliation since version 4.3. Alternatively, LogitLink() was the Maxent default on earlier versions. To get exponential output, which can be interpreted as predicted abundance, use LogLink() IdentityLink() returns the exponent without any transformation.</li><li><code>clamp</code>: If <code>true</code>, values in <code>x</code> will be clamped to the range the model was trained on. Defaults to <code>false</code>.</li></ul><p><strong>Returns</strong></p><p>A <code>Vector</code> with the resulting predictions.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">using Maxnet
p_a, env = Maxnet.bradypus();
bradypus_model = maxnet(p_a, env; features = &quot;lq&quot;)
prediction = Maxnet.predict(bradypus_model, env)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/d6c20f09ce77c7ac05c9de28a67987789b251894/src/predict.jl#L1-L27">source</a></section></article></article><nav class="docs-footer"><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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 11 March 2024 07:00">Monday 11 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
prediction = Maxnet.predict(bradypus_model, env)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tiemvanderdeure/Maxnet.jl/blob/c3e63390eb5eff9bbfaecea5b6ee8ca683038cff/src/predict.jl#L1-L27">source</a></section></article></article><nav class="docs-footer"><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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Friday 22 March 2024 14:45">Friday 22 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit a20d05a

Please sign in to comment.