build based on a29950b

Evovest · Jul 7, 2024 · 5be10df · 5be10df
1 parent ce63bca
commit 5be10df
Show file tree

Hide file tree

Showing 14 changed files with 18 additions and 18 deletions.
diff --git a/previews/PR13/404.html b/previews/PR13/404.html
@@ -16,7 +16,7 @@
   </head>
   <body>
     <div id="app"></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api.md\":\"Cq--_twa\",\"design.md\":\"BjvT_iFJ\",\"index.md\":\"DqEzmXxp\",\"models.md\":\"CKRaAR2V\",\"quick-start.md\":\"DofKsMOe\",\"tutorials-classification-iris.md\":\"BZeqV4KS\",\"tutorials-logistic-titanic.md\":\"ccoPwAWT\",\"tutorials-regression-boston.md\":\"mjUO6czu\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"NeuroTreeModels\",\"description\":\"Docs for NeuroTreeModels.jl\",\"base\":\"/NeuroTreeModels.jl/previews/PR13/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"editLink\":{\"pattern\":\"github.com/Evovest/NeuroTreeModels.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Evovest/NeuroTreeModels.jl\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api.md\":\"D3zGZptS\",\"design.md\":\"BjvT_iFJ\",\"index.md\":\"DqEzmXxp\",\"models.md\":\"D6fAbLqZ\",\"quick-start.md\":\"DofKsMOe\",\"tutorials-classification-iris.md\":\"BZeqV4KS\",\"tutorials-logistic-titanic.md\":\"ccoPwAWT\",\"tutorials-regression-boston.md\":\"mjUO6czu\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"NeuroTreeModels\",\"description\":\"Docs for NeuroTreeModels.jl\",\"base\":\"/NeuroTreeModels.jl/previews/PR13/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"editLink\":{\"pattern\":\"github.com/Evovest/NeuroTreeModels.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Evovest/NeuroTreeModels.jl\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
 
   </body>
 </html>
diff --git a/previews/PR13/API.html b/previews/PR13/API.html
@@ -12,7 +12,7 @@
     <link rel="preload" href="/NeuroTreeModels.jl/previews/PR13/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
     <link rel="modulepreload" href="/NeuroTreeModels.jl/previews/PR13/assets/chunks/framework.CuaJcBQX.js">
     <link rel="modulepreload" href="/NeuroTreeModels.jl/previews/PR13/assets/chunks/theme.Dh6Nf8Cg.js">
-    <link rel="modulepreload" href="/NeuroTreeModels.jl/previews/PR13/assets/API.md.Cq--_twa.lean.js">
+    <link rel="modulepreload" href="/NeuroTreeModels.jl/previews/PR13/assets/API.md.D3zGZptS.lean.js">
     <link rel="icon" href="/favicon.ico">
     <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
     <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
@@ -32,8 +32,8 @@
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    verbosity</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    device</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">:cpu</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    gpuID</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
-<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span></code></pre></div><p>Training function of NeuroTreeModels&#39; internal API.</p><p><strong>Arguments</strong></p><ul><li><p><code>config::NeuroTypes</code></p></li><li><p><code>dtrain</code>: Must be <code>&lt;:AbstractDataFrame</code></p></li></ul><p><strong>Keyword arguments</strong></p><ul><li><p><code>feature_names</code>: Required kwarg, a <code>Vector{Symbol}</code> or <code>Vector{String}</code> of the feature names.</p></li><li><p><code>target_name</code> Required kwarg, a <code>Symbol</code> or <code>String</code> indicating the name of the target variable.</p></li><li><p><code>weight_name=nothing</code></p></li><li><p><code>offset_name=nothing</code></p></li><li><p><code>deval=nothing</code> Data for tracking evaluation metric and perform early stopping.</p></li><li><p><code>metric=nothing</code>: evaluation metric tracked on <code>deval</code>. Can be one of:</p><ul><li><p><code>:mse</code></p></li><li><p><code>:mae</code></p></li><li><p><code>:logloss</code></p></li><li><p><code>:mlogloss</code></p></li><li><p><code>:gaussian_mle</code></p></li></ul></li><li><p><code>print_every_n=9999</code></p></li><li><p><code>early_stopping_rounds=9999</code></p></li><li><p><code>verbosity=1</code></p></li><li><p><code>device=:cpu</code>: device on which to perform the computation, either <code>:cpu</code> or <code>:gpu</code></p></li><li><p><code>gpuID=0</code>: gpu device to use, only relveant if <code>device = :gpu</code></p></li></ul><p><a href="https://github.com/Evovest/NeuroTreeModels.jl/blob/ec97baf55d2e46e3618749217a1b716240a6463e/src/fit.jl#L47-L90" target="_blank" rel="noreferrer">source</a></p></div><br><h2 id="Inference" tabindex="-1">Inference <a class="header-anchor" href="#Inference" aria-label="Permalink to &quot;Inference {#Inference}&quot;"></a></h2><div style="border-width:1px;border-style:solid;border-color:black;padding:1em;border-radius:25px;"><a id="NeuroTreeModels.infer" href="#NeuroTreeModels.infer">#</a> <b><u>NeuroTreeModels.infer</u></b> — <i>Function</i>. <p>infer(m::NeuroTreeModel, data)</p><p>Return the inference of a <code>NeuroTreeModel</code> over <code>data</code>, where <code>data</code> is <code>AbstractDataFrame</code>.</p><p><a href="https://github.com/Evovest/NeuroTreeModels.jl/blob/ec97baf55d2e46e3618749217a1b716240a6463e/src/infer.jl#L8-L12" target="_blank" rel="noreferrer">source</a></p></div><br></div></div></main><footer class="VPDocFooter" data-v-83890dd9 data-v-4f9813fa><!--[--><!--]--><div class="edit-info" data-v-4f9813fa><div class="edit-link" data-v-4f9813fa><a class="VPLink link no-icon edit-link-button" href="/NeuroTreeModels.jl/previews/PR13/github.com/Evovest/NeuroTreeModels.jl/edit/main/docs/src/API" data-v-4f9813fa><!--[--><span class="vpi-square-pen edit-link-icon" data-v-4f9813fa></span> Edit this page<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-4f9813fa><span class="visually-hidden" id="doc-footer-aria-label" data-v-4f9813fa>Pager</span><div class="pager" data-v-4f9813fa><a class="VPLink link pager-link prev" href="/NeuroTreeModels.jl/previews/PR13/models" data-v-4f9813fa><!--[--><span class="desc" data-v-4f9813fa>Previous page</span><span class="title" data-v-4f9813fa>Models</span><!--]--></a></div><div class="pager" data-v-4f9813fa><a class="VPLink link pager-link next" href="/NeuroTreeModels.jl/previews/PR13/tutorials-regression-boston" data-v-4f9813fa><!--[--><span class="desc" data-v-4f9813fa>Next page</span><span class="title" data-v-4f9813fa>Regression</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api.md\":\"Cq--_twa\",\"design.md\":\"BjvT_iFJ\",\"index.md\":\"DqEzmXxp\",\"models.md\":\"CKRaAR2V\",\"quick-start.md\":\"DofKsMOe\",\"tutorials-classification-iris.md\":\"BZeqV4KS\",\"tutorials-logistic-titanic.md\":\"ccoPwAWT\",\"tutorials-regression-boston.md\":\"mjUO6czu\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"NeuroTreeModels\",\"description\":\"Docs for NeuroTreeModels.jl\",\"base\":\"/NeuroTreeModels.jl/previews/PR13/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"editLink\":{\"pattern\":\"github.com/Evovest/NeuroTreeModels.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Evovest/NeuroTreeModels.jl\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
+<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span></code></pre></div><p>Training function of NeuroTreeModels&#39; internal API.</p><p><strong>Arguments</strong></p><ul><li><p><code>config::NeuroTypes</code></p></li><li><p><code>dtrain</code>: Must be <code>&lt;:AbstractDataFrame</code></p></li></ul><p><strong>Keyword arguments</strong></p><ul><li><p><code>feature_names</code>: Required kwarg, a <code>Vector{Symbol}</code> or <code>Vector{String}</code> of the feature names.</p></li><li><p><code>target_name</code> Required kwarg, a <code>Symbol</code> or <code>String</code> indicating the name of the target variable.</p></li><li><p><code>weight_name=nothing</code></p></li><li><p><code>offset_name=nothing</code></p></li><li><p><code>deval=nothing</code> Data for tracking evaluation metric and perform early stopping.</p></li><li><p><code>metric=nothing</code>: evaluation metric tracked on <code>deval</code>. Can be one of:</p><ul><li><p><code>:mse</code></p></li><li><p><code>:mae</code></p></li><li><p><code>:logloss</code></p></li><li><p><code>:mlogloss</code></p></li><li><p><code>:gaussian_mle</code></p></li></ul></li><li><p><code>print_every_n=9999</code></p></li><li><p><code>early_stopping_rounds=9999</code></p></li><li><p><code>verbosity=1</code></p></li><li><p><code>device=:cpu</code>: device on which to perform the computation, either <code>:cpu</code> or <code>:gpu</code></p></li><li><p><code>gpuID=0</code>: gpu device to use, only relveant if <code>device = :gpu</code></p></li></ul><p><a href="https://github.com/Evovest/NeuroTreeModels.jl/blob/a29950b4f94df0b0a6ae92227df3c77b51959a13/src/fit.jl#L47-L90" target="_blank" rel="noreferrer">source</a></p></div><br><h2 id="Inference" tabindex="-1">Inference <a class="header-anchor" href="#Inference" aria-label="Permalink to &quot;Inference {#Inference}&quot;"></a></h2><div style="border-width:1px;border-style:solid;border-color:black;padding:1em;border-radius:25px;"><a id="NeuroTreeModels.infer" href="#NeuroTreeModels.infer">#</a> <b><u>NeuroTreeModels.infer</u></b> — <i>Function</i>. <p>infer(m::NeuroTreeModel, data)</p><p>Return the inference of a <code>NeuroTreeModel</code> over <code>data</code>, where <code>data</code> is <code>AbstractDataFrame</code>.</p><p><a href="https://github.com/Evovest/NeuroTreeModels.jl/blob/a29950b4f94df0b0a6ae92227df3c77b51959a13/src/infer.jl#L8-L12" target="_blank" rel="noreferrer">source</a></p></div><br></div></div></main><footer class="VPDocFooter" data-v-83890dd9 data-v-4f9813fa><!--[--><!--]--><div class="edit-info" data-v-4f9813fa><div class="edit-link" data-v-4f9813fa><a class="VPLink link no-icon edit-link-button" href="/NeuroTreeModels.jl/previews/PR13/github.com/Evovest/NeuroTreeModels.jl/edit/main/docs/src/API" data-v-4f9813fa><!--[--><span class="vpi-square-pen edit-link-icon" data-v-4f9813fa></span> Edit this page<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-4f9813fa><span class="visually-hidden" id="doc-footer-aria-label" data-v-4f9813fa>Pager</span><div class="pager" data-v-4f9813fa><a class="VPLink link pager-link prev" href="/NeuroTreeModels.jl/previews/PR13/models" data-v-4f9813fa><!--[--><span class="desc" data-v-4f9813fa>Previous page</span><span class="title" data-v-4f9813fa>Models</span><!--]--></a></div><div class="pager" data-v-4f9813fa><a class="VPLink link pager-link next" href="/NeuroTreeModels.jl/previews/PR13/tutorials-regression-boston" data-v-4f9813fa><!--[--><span class="desc" data-v-4f9813fa>Next page</span><span class="title" data-v-4f9813fa>Regression</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api.md\":\"D3zGZptS\",\"design.md\":\"BjvT_iFJ\",\"index.md\":\"DqEzmXxp\",\"models.md\":\"D6fAbLqZ\",\"quick-start.md\":\"DofKsMOe\",\"tutorials-classification-iris.md\":\"BZeqV4KS\",\"tutorials-logistic-titanic.md\":\"ccoPwAWT\",\"tutorials-regression-boston.md\":\"mjUO6czu\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"NeuroTreeModels\",\"description\":\"Docs for NeuroTreeModels.jl\",\"base\":\"/NeuroTreeModels.jl/previews/PR13/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick start\",\"link\":\"/quick-start\"},{\"text\":\"Design\",\"link\":\"/design\"},{\"text\":\"Models\",\"link\":\"/models\"},{\"text\":\"API\",\"link\":\"/API\"},{\"text\":\"Tutorials\",\"items\":[{\"text\":\"Regression\",\"link\":\"/tutorials-regression-boston\"},{\"text\":\"Logistic\",\"link\":\"/tutorials-logistic-titanic\"},{\"text\":\"Classification\",\"link\":\"/tutorials-classification-iris\"}]}],\"editLink\":{\"pattern\":\"github.com/Evovest/NeuroTreeModels.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Evovest/NeuroTreeModels.jl\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
 
   </body>
 </html>