Skip to content

Commit

Permalink
build based on 9cf6fbe
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 29, 2024
1 parent dfc20c1 commit 3cbbb74
Show file tree
Hide file tree
Showing 17 changed files with 103 additions and 103 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-09-22T02:05:14","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-09-29T02:06:22","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
author={Pacaud, Fran{\c{c}}ois and Shin, Sungho and Schanen, Michel and Maldonado, Daniel Adrian and Anitescu, Mihai},
journal={arXiv preprint arXiv:2203.11875},
year={2022}
}</code></pre><h2 id="Funding"><a class="docs-heading-anchor" href="#Funding">Funding</a><a id="Funding-1"></a><a class="docs-heading-anchor-permalink" href="#Funding" title="Permalink"></a></h2><p>This research was supported by the Exascale Computing Project (17-SC-20-SC), a joint project of the U.S. Department of Energy’s Office of Science and National Nuclear Security Administration, responsible for delivering a capable exascale ecosystem, including software, applications, and hardware technology, to support the nation’s exascale computing imperative.</p><h2 id="Table-of-contents"><a class="docs-heading-anchor" href="#Table-of-contents">Table of contents</a><a id="Table-of-contents-1"></a><a class="docs-heading-anchor-permalink" href="#Table-of-contents" title="Permalink"></a></h2><h3 id="Quickstart-2"><a class="docs-heading-anchor" href="#Quickstart-2">Quickstart</a><a class="docs-heading-anchor-permalink" href="#Quickstart-2" title="Permalink"></a></h3><ul><li><a href="quickstart/cpu/#Argos-on-CPU-(default)">Argos on CPU (default)</a></li><li><a href="quickstart/cuda/#Argos-on-NVIDIA-GPU">Argos on NVIDIA GPU</a></li></ul><h3 id="OPF-Model"><a class="docs-heading-anchor" href="#OPF-Model">OPF Model</a><a id="OPF-Model-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Model" title="Permalink"></a></h3><ul><li><a href="man/overview/#Overview">Overview</a></li><li><a href="man/fullspace/#FullSpaceEvaluator">FullSpaceEvaluator</a></li><li><a href="man/reducedspace/#ReducedSpaceEvaluator">ReducedSpaceEvaluator</a></li></ul><h3 id="OPF-Solution"><a class="docs-heading-anchor" href="#OPF-Solution">OPF Solution</a><a id="OPF-Solution-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Solution" title="Permalink"></a></h3><ul><li><a href="optim/fullspace/#Full-space-OPF">Full-space OPF</a></li><li><a href="optim/reducedspace/#Reduced-space-OPF">Reduced-space OPF</a></li><li><a href="optim/biegler/#Biegler&#39;s-method">Biegler&#39;s method</a></li></ul><h3 id="Wrappers"><a class="docs-heading-anchor" href="#Wrappers">Wrappers</a><a id="Wrappers-1"></a><a class="docs-heading-anchor-permalink" href="#Wrappers" title="Permalink"></a></h3><ul><li><a href="man/moi_wrapper/#MathOptInterface-wrapper">MathOptInterface wrapper</a></li><li><a href="man/nlpmodel_wrapper/#NLPModels">NLPModels</a></li></ul><h3 id="Library"><a class="docs-heading-anchor" href="#Library">Library</a><a id="Library-1"></a><a class="docs-heading-anchor-permalink" href="#Library" title="Permalink"></a></h3><ul><li><a href="lib/api/#Evaluator-API">Evaluator API</a></li><li><a href="lib/evaluators/#Evaluators">Evaluators</a></li><li><a href="lib/kkt/#KKT-systems">KKT systems</a></li><li><a href="lib/wrappers/#Wrappers">Wrappers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quickstart/cpu/">Argos on CPU (default) »</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="Sunday 22 September 2024 02:05">Sunday 22 September 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre><h2 id="Funding"><a class="docs-heading-anchor" href="#Funding">Funding</a><a id="Funding-1"></a><a class="docs-heading-anchor-permalink" href="#Funding" title="Permalink"></a></h2><p>This research was supported by the Exascale Computing Project (17-SC-20-SC), a joint project of the U.S. Department of Energy’s Office of Science and National Nuclear Security Administration, responsible for delivering a capable exascale ecosystem, including software, applications, and hardware technology, to support the nation’s exascale computing imperative.</p><h2 id="Table-of-contents"><a class="docs-heading-anchor" href="#Table-of-contents">Table of contents</a><a id="Table-of-contents-1"></a><a class="docs-heading-anchor-permalink" href="#Table-of-contents" title="Permalink"></a></h2><h3 id="Quickstart-2"><a class="docs-heading-anchor" href="#Quickstart-2">Quickstart</a><a class="docs-heading-anchor-permalink" href="#Quickstart-2" title="Permalink"></a></h3><ul><li><a href="quickstart/cpu/#Argos-on-CPU-(default)">Argos on CPU (default)</a></li><li><a href="quickstart/cuda/#Argos-on-NVIDIA-GPU">Argos on NVIDIA GPU</a></li></ul><h3 id="OPF-Model"><a class="docs-heading-anchor" href="#OPF-Model">OPF Model</a><a id="OPF-Model-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Model" title="Permalink"></a></h3><ul><li><a href="man/overview/#Overview">Overview</a></li><li><a href="man/fullspace/#FullSpaceEvaluator">FullSpaceEvaluator</a></li><li><a href="man/reducedspace/#ReducedSpaceEvaluator">ReducedSpaceEvaluator</a></li></ul><h3 id="OPF-Solution"><a class="docs-heading-anchor" href="#OPF-Solution">OPF Solution</a><a id="OPF-Solution-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Solution" title="Permalink"></a></h3><ul><li><a href="optim/fullspace/#Full-space-OPF">Full-space OPF</a></li><li><a href="optim/reducedspace/#Reduced-space-OPF">Reduced-space OPF</a></li><li><a href="optim/biegler/#Biegler&#39;s-method">Biegler&#39;s method</a></li></ul><h3 id="Wrappers"><a class="docs-heading-anchor" href="#Wrappers">Wrappers</a><a id="Wrappers-1"></a><a class="docs-heading-anchor-permalink" href="#Wrappers" title="Permalink"></a></h3><ul><li><a href="man/moi_wrapper/#MathOptInterface-wrapper">MathOptInterface wrapper</a></li><li><a href="man/nlpmodel_wrapper/#NLPModels">NLPModels</a></li></ul><h3 id="Library"><a class="docs-heading-anchor" href="#Library">Library</a><a id="Library-1"></a><a class="docs-heading-anchor-permalink" href="#Library" title="Permalink"></a></h3><ul><li><a href="lib/api/#Evaluator-API">Evaluator API</a></li><li><a href="lib/evaluators/#Evaluators">Evaluators</a></li><li><a href="lib/kkt/#KKT-systems">KKT systems</a></li><li><a href="lib/wrappers/#Wrappers">Wrappers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quickstart/cpu/">Argos on CPU (default) »</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="Sunday 29 September 2024 02:06">Sunday 29 September 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/lib/api/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/lib/evaluators/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@
julia&gt; @assert isa(x, Array) # x is defined on the host memory

julia&gt; Argos.objective(bdg, x) # evaluate the objective on the device
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/9cf6fbe7e266591cb130531d89659e2206c4dc61/src/Evaluators/bridge_evaluator.jl#L14-L40">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« Evaluators API</a><a class="docs-footer-nextpage" href="../kkt/">KKT systems »</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="Sunday 22 September 2024 02:05">Sunday 22 September 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/9cf6fbe7e266591cb130531d89659e2206c4dc61/src/Evaluators/bridge_evaluator.jl#L14-L40">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« Evaluators API</a><a class="docs-footer-nextpage" href="../kkt/">KKT systems »</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="Sunday 29 September 2024 02:06">Sunday 29 September 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/lib/kkt/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
julia&gt; kkt = Argos.BieglerKKTSystem{T, VI, VT, MT}(opf)

julia&gt; MadNLP.get_kkt(kkt) # return the matrix to factorize
</code></pre><p><strong>Notes</strong></p><p><code>BieglerKKTSystem</code> can be instantiated both on the host memory (CPU) or on a NVIDIA GPU using CUDA. When instantiated on the GPU, <code>BieglerKKTSystem</code> uses <code>cusolverRF</code> to streamline the solution of the sparse linear systems in the reduction algorithm.</p><p><strong>References</strong></p><p>[BNS2015] Biegler, Lorenz T., Jorge Nocedal, and Claudia Schmid. &quot;A reduced Hessian method for large-scale constrained optimization.&quot; SIAM Journal on Optimization 5, no. 2 (1995): 314-347.</p><p>[PSSMA2022] Pacaud, François, Sungho Shin, Michel Schanen, Daniel Adrian Maldonado, and Mihai Anitescu. &quot;Condensed interior-point methods: porting reduced-space approaches on GPU hardware.&quot; arXiv preprint arXiv:2203.11875 (2022).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/9cf6fbe7e266591cb130531d89659e2206c4dc61/src/KKT/reduced_newton.jl#L2-L42">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../evaluators/">« Evaluators Type</a><a class="docs-footer-nextpage" href="../wrappers/">Wrappers »</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="Sunday 22 September 2024 02:05">Sunday 22 September 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p><strong>Notes</strong></p><p><code>BieglerKKTSystem</code> can be instantiated both on the host memory (CPU) or on a NVIDIA GPU using CUDA. When instantiated on the GPU, <code>BieglerKKTSystem</code> uses <code>cusolverRF</code> to streamline the solution of the sparse linear systems in the reduction algorithm.</p><p><strong>References</strong></p><p>[BNS2015] Biegler, Lorenz T., Jorge Nocedal, and Claudia Schmid. &quot;A reduced Hessian method for large-scale constrained optimization.&quot; SIAM Journal on Optimization 5, no. 2 (1995): 314-347.</p><p>[PSSMA2022] Pacaud, François, Sungho Shin, Michel Schanen, Daniel Adrian Maldonado, and Mihai Anitescu. &quot;Condensed interior-point methods: porting reduced-space approaches on GPU hardware.&quot; arXiv preprint arXiv:2203.11875 (2022).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/9cf6fbe7e266591cb130531d89659e2206c4dc61/src/KKT/reduced_newton.jl#L2-L42">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../evaluators/">« Evaluators Type</a><a class="docs-footer-nextpage" href="../wrappers/">Wrappers »</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="Sunday 29 September 2024 02:06">Sunday 29 September 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 3cbbb74

Please sign in to comment.