Skip to content

Commit f7771b1

Browse files
author
Documenter.jl
committed
build based on fd4c1f8 
1 parent c197a48 commit f7771b1

34 files changed

Lines changed: 261 additions & 215 deletions

File tree

‎dev/.documenter-siteinfo.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-04-22T09:20:08","documenter_version":"1.10.1"}}
1+
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-07-16T12:08:57","documenter_version":"1.14.1"}}

‎dev/api/0_interface/index.html‎

Lines changed: 21 additions & 21 deletions
Large diffs are not rendered by default.

‎dev/api/argmax/index.html‎

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎dev/api/argmax_2d/index.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Argmax2D · DecisionFocusedLearningBenchmarks.jl</title><meta name="title" content="Argmax2D · DecisionFocusedLearningBenchmarks.jl"/><meta property="og:title" content="Argmax2D · DecisionFocusedLearningBenchmarks.jl"/><meta property="twitter:title" content="Argmax2D · DecisionFocusedLearningBenchmarks.jl"/><meta name="description" content="Documentation for DecisionFocusedLearningBenchmarks.jl."/><meta property="og:description" content="Documentation for DecisionFocusedLearningBenchmarks.jl."/><meta property="twitter:description" content="Documentation for DecisionFocusedLearningBenchmarks.jl."/><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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">DecisionFocusedLearningBenchmarks.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="../../warcraft/">Path-finding on image maps</a></li></ul></li><li><span class="tocitem">Benchmark problems list</span><ul><li><a class="tocitem" href="../../benchmarks/subset_selection/">Subset Selection</a></li><li><a class="tocitem" href="../../benchmarks/fixed_size_shortest_path/">Shortest paths</a></li><li><a class="tocitem" href="../../benchmarks/warcraft/">Warcraft</a></li><li><a class="tocitem" href="../../benchmarks/portfolio_optimization/">Portfolio Optimization</a></li><li><a class="tocitem" href="../../benchmarks/vsp/">Stochastic Vehicle Scheduling</a></li></ul></li><li><span class="tocitem">API reference</span><ul><li><a class="tocitem" href="../0_interface/">Interface</a></li><li><a class="tocitem" href="../argmax/">Argmax</a></li><li class="is-active"><a class="tocitem" href>Argmax2D</a><ul class="internal"><li><a class="tocitem" href="#Public"><span>Public</span></a></li><li><a class="tocitem" href="#Private"><span>Private</span></a></li></ul></li><li><a class="tocitem" href="../fixed_shortest_path/">Fixed-size shortest path</a></li><li><a class="tocitem" href="../portfolio_optimization/">Subset selection</a></li><li><a class="tocitem" href="../ranking/">Ranking</a></li><li><a class="tocitem" href="../subset_selection/">Subset selection</a></li><li><a class="tocitem" href="../vsp/">Stochastic Vehicle Scheduling</a></li><li><a class="tocitem" href="../warcraft/">Warcraft</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 class="is-active"><a href>Argmax2D</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Argmax2D</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.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/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/main/docs/src/api/argmax_2d.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="Argmax2D"><a class="docs-heading-anchor" href="#Argmax2D">Argmax2D</a><a id="Argmax2D-1"></a><a class="docs-heading-anchor-permalink" href="#Argmax2D" title="Permalink"></a></h1><h2 id="Public"><a class="docs-heading-anchor" href="#Public">Public</a><a id="Public-1"></a><a class="docs-heading-anchor-permalink" href="#Public" 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="DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark" href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark"><code>DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark</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">struct Argmax2DBenchmark{E, R} &lt;: AbstractBenchmark</code></pre><p>Argmax becnhmark on a 2d polytope.</p><p><strong>Fields</strong></p><ul><li><p><code>nb_features::Int64</code>: number of features</p></li><li><p><code>encoder::Any</code>: true mapping between features and costs</p></li><li><p><code>polytope_vertex_range::Any</code>: </p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/fd4c1f8171298023d3b529c73f6dac3adbc93cfe/src/Argmax2D/Argmax2D.jl#L14">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="DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark-Tuple{}" href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark-Tuple{}"><code>DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">Argmax2DBenchmark(
3+
;
4+
nb_features,
5+
seed,
6+
polytope_vertex_range
7+
) -&gt; Argmax2DBenchmark{E, Vector{Int64}} where E&lt;:(Flux.Chain{T} where T&lt;:Tuple{Flux.Dense{typeof(identity), Matrix{Float32}}, typeof(vec)})
8+
</code></pre><p>Custom constructor for <a href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark"><code>Argmax2DBenchmark</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/fd4c1f8171298023d3b529c73f6dac3adbc93cfe/src/Argmax2D/Argmax2D.jl#L36">source</a></section></article><h2 id="Private"><a class="docs-heading-anchor" href="#Private">Private</a><a id="Private-1"></a><a class="docs-heading-anchor-permalink" href="#Private" 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="DecisionFocusedLearningBenchmarks.Utils.generate_dataset" href="#DecisionFocusedLearningBenchmarks.Utils.generate_dataset"><code>DecisionFocusedLearningBenchmarks.Utils.generate_dataset</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">generate_dataset(bench::Argmax2DBenchmark; ...) -&gt; Vector
9+
generate_dataset(
10+
bench::Argmax2DBenchmark,
11+
dataset_size;
12+
seed,
13+
rng
14+
) -&gt; Any
15+
</code></pre><p>Generate a dataset for the <a href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark"><code>Argmax2DBenchmark</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/fd4c1f8171298023d3b529c73f6dac3adbc93cfe/src/Argmax2D/Argmax2D.jl#L49">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="DecisionFocusedLearningBenchmarks.Utils.generate_maximizer-Tuple{Argmax2DBenchmark}" href="#DecisionFocusedLearningBenchmarks.Utils.generate_maximizer-Tuple{Argmax2DBenchmark}"><code>DecisionFocusedLearningBenchmarks.Utils.generate_maximizer</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">generate_maximizer(
16+
_::Argmax2DBenchmark
17+
) -&gt; typeof(DecisionFocusedLearningBenchmarks.Argmax2D.maximizer)
18+
</code></pre><p>Maximizer for the <a href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark"><code>Argmax2DBenchmark</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/fd4c1f8171298023d3b529c73f6dac3adbc93cfe/src/Argmax2D/Argmax2D.jl#L68">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="DecisionFocusedLearningBenchmarks.Utils.generate_statistical_model-Tuple{Argmax2DBenchmark}" href="#DecisionFocusedLearningBenchmarks.Utils.generate_statistical_model-Tuple{Argmax2DBenchmark}"><code>DecisionFocusedLearningBenchmarks.Utils.generate_statistical_model</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">generate_statistical_model(
19+
bench::Argmax2DBenchmark;
20+
seed,
21+
rng
22+
) -&gt; Flux.Chain{T} where T&lt;:Tuple{Flux.Dense{typeof(identity), Matrix{Float32}}, typeof(vec)}
23+
</code></pre><p>Generate a statistical model for the <a href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark"><code>Argmax2DBenchmark</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/fd4c1f8171298023d3b529c73f6dac3adbc93cfe/src/Argmax2D/Argmax2D.jl#L77">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="DecisionFocusedLearningBenchmarks.Utils.plot_data-Tuple{Argmax2DBenchmark, DataSample}" href="#DecisionFocusedLearningBenchmarks.Utils.plot_data-Tuple{Argmax2DBenchmark, DataSample}"><code>DecisionFocusedLearningBenchmarks.Utils.plot_data</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">plot_data(
24+
::Argmax2DBenchmark,
25+
sample::DataSample;
26+
θ_true,
27+
kwargs...
28+
) -&gt; Plots.Plot
29+
</code></pre><p>Plot the data sample for the <a href="#DecisionFocusedLearningBenchmarks.Argmax2D.Argmax2DBenchmark"><code>Argmax2DBenchmark</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/blob/fd4c1f8171298023d3b529c73f6dac3adbc93cfe/src/Argmax2D/Argmax2D.jl#L91">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../argmax/">« Argmax</a><a class="docs-footer-nextpage" href="../fixed_shortest_path/">Fixed-size shortest path »</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.14.1 on <span class="colophon-date" title="Wednesday 16 July 2025 12:08">Wednesday 16 July 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)