Skip to content

Commit 160dc3e

Browse files
author
Documenter.jl
committed
build based on 1d0d5d2
1 parent e4abb90 commit 160dc3e

File tree

21 files changed

+49
-44
lines changed

21 files changed

+49
-44
lines changed

dev/.documenter-siteinfo.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-06-26T10:18:47","documenter_version":"1.5.0"}}
1+
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-09-10T10:16:02","documenter_version":"1.7.0"}}

dev/assets/documenter.js

+29-24
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/themes/catppuccin-frappe.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/themes/catppuccin-latte.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/themes/catppuccin-macchiato.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/themes/catppuccin-mocha.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/themes/documenter-dark.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/themes/documenter-light.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/basics/index.html

+1-1
Large diffs are not rendered by default.

dev/docs_custom_oracle/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@
6363
# transformation obtained through OAVI by using your custom oracle
6464
X_transformed, sets = fit_oavi(X; oracle=custom_oracle)</code></pre><p>You can also pass further kwargs used by your oracle and we will pass them through to your oracle call. This is done by the <code>oracle_kwargs</code> argument. Let&#39;s say we want to pass the keyword arguments <code>epsilon=1.0e-5</code> and <code>max_iteration=5000</code> along to our custom oracle.</p><pre><code class="language-julia hljs">kwargs = [(:epsilon, 1.0e-5), (:max_iteration, 5000)]
6565

66-
X_transformed, sets = fit_oavi(X; oracle=custom_oracle, oracle_kwargs=kwargs)</code></pre><p>The above code will call <code>custom_oracle</code> with the keyword arguments <code>epsilon</code> and <code>max_iteration</code> exchanged for <code>1.0e-5</code> and <code>5000</code>, respectively, that is, <code>custom_oracle(data, labels; epsilon=1.0e-5, max_iteration=5000)</code> and ultimately when calling the algorithm in our example <code>blended_conditional_gradient(f, grad!, region, x0; epsilon=1.0e-5, max_iteration=5000)</code>.</p><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../docs_oavi_transformation/">« Transforming data using <span>$\; \texttt{OAVI}$</span></a><a class="docs-footer-nextpage" href="../docs_vca_transformation/">Transforming data using <span>$\; \texttt{VCA}$</span> »</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.5.0 on <span class="colophon-date" title="Wednesday 26 June 2024 10:18">Wednesday 26 June 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
66+
X_transformed, sets = fit_oavi(X; oracle=custom_oracle, oracle_kwargs=kwargs)</code></pre><p>The above code will call <code>custom_oracle</code> with the keyword arguments <code>epsilon</code> and <code>max_iteration</code> exchanged for <code>1.0e-5</code> and <code>5000</code>, respectively, that is, <code>custom_oracle(data, labels; epsilon=1.0e-5, max_iteration=5000)</code> and ultimately when calling the algorithm in our example <code>blended_conditional_gradient(f, grad!, region, x0; epsilon=1.0e-5, max_iteration=5000)</code>.</p><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../docs_oavi_transformation/">« Transforming data using <span>$\; \texttt{OAVI}$</span></a><a class="docs-footer-nextpage" href="../docs_vca_transformation/">Transforming data using <span>$\; \texttt{VCA}$</span> »</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.7.0 on <span class="colophon-date" title="Tuesday 10 September 2024 10:16">Tuesday 10 September 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/docs_oavi_transformation/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@
4949

5050
# apply transformation to test set
5151
X_test_transformed, sets_test = apply_G_transformation(best_sets, X_test)</code></pre><p>Note that <code>X_test</code> has to have the same second dimension as <code>X_train</code>, that is <code>size(X_train, 2) == size(X_test, 2)</code>, so be careful when applying the transformation to other data.</p><p>Lastly, to be safe, we check that the dimensions of the transformations indeed match the number of vanishing polynomials constructed by the algorithm.</p><pre><code class="language-julia hljs">println(&quot;Number of vanishing polynomials: &quot;, size(best_sets.leading_terms, 2))
52-
size(best_transform, 2) == size(X_test_transformed, 2) == size(best_sets.leading_terms, 2)</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../how_to_run/">« Obtaining a transformation</a><a class="docs-footer-nextpage" href="../docs_custom_oracle/">Custom Oracles »</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.5.0 on <span class="colophon-date" title="Wednesday 26 June 2024 10:18">Wednesday 26 June 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
52+
size(best_transform, 2) == size(X_test_transformed, 2) == size(best_sets.leading_terms, 2)</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../how_to_run/">« Obtaining a transformation</a><a class="docs-footer-nextpage" href="../docs_custom_oracle/">Custom Oracles »</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.7.0 on <span class="colophon-date" title="Tuesday 10 September 2024 10:16">Tuesday 10 September 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/docs_vca_transformation/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@
5151
polys = ApproximateVanishingIdeals.V_to_matrix(best_sets_vca)
5252

5353
println(&quot;Number of vanishing polynomials: &quot;, size(polys, 2))
54-
size(best_transform_vca, 2) == size(X_test_transformed_vca, 2) == size(polys, 2)</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../docs_custom_oracle/">« Custom Oracles</a><a class="docs-footer-nextpage" href="../print_polynomials/">Printing polynomials »</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.5.0 on <span class="colophon-date" title="Wednesday 26 June 2024 10:18">Wednesday 26 June 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
54+
size(best_transform_vca, 2) == size(X_test_transformed_vca, 2) == size(polys, 2)</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../docs_custom_oracle/">« Custom Oracles</a><a class="docs-footer-nextpage" href="../print_polynomials/">Printing polynomials »</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.7.0 on <span class="colophon-date" title="Tuesday 10 September 2024 10:16">Tuesday 10 September 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)