Skip to content

Commit 36a1d91

Browse files
author
Documenter.jl
committed
build based on c084670
1 parent 9d877a0 commit 36a1d91

File tree

14 files changed

+265
-203
lines changed

14 files changed

+265
-203
lines changed

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.12.4","generation_timestamp":"2026-01-16T16:07:06","documenter_version":"1.16.1"}}
1+
{"documenter":{"julia_version":"1.12.5","generation_timestamp":"2026-03-17T17:31:28","documenter_version":"1.17.0"}}

dev/api/index.html

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

dev/assets/documenter.js

Lines changed: 13 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/warner.js

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,40 @@ function maybeAddWarning() {
3737
closer.addEventListener("click", function () {
3838
document.body.removeChild(div);
3939
});
40-
const href = window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
40+
var target_href =
41+
window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
42+
43+
// try to stay on the same page when linking to the stable version
44+
// get the current page path relative to the version root
45+
var current_page = window.location.pathname;
46+
47+
// resolve the documenterBaseURL to an absolute path
48+
// documenterBaseURL is a relative path (usually "."), so we need to resolve it
49+
var base_url_absolute = new URL(documenterBaseURL, window.location.href)
50+
.pathname;
51+
if (!base_url_absolute.endsWith("/")) {
52+
base_url_absolute = base_url_absolute + "/";
53+
}
54+
55+
// extract the page path after the version directory
56+
// e.g., if we're on /stable/man/guide.html, we want "man/guide.html"
57+
var page_path = "";
58+
if (current_page.startsWith(base_url_absolute)) {
59+
page_path = current_page.substring(base_url_absolute.length);
60+
}
61+
62+
// construct the target URL with the same page path
63+
var target_url = target_href;
64+
if (page_path && page_path !== "" && page_path !== "index.html") {
65+
// ensure target_href ends with a slash before appending page path
66+
if (!target_url.endsWith("/")) {
67+
target_url = target_url + "/";
68+
}
69+
target_url = target_url + page_path;
70+
}
71+
72+
// preserve the anchor (hash) from the current page
73+
var current_hash = window.location.hash;
4174

4275
// Determine if this is a development version or an older release
4376
let warningMessage = "";
@@ -51,12 +84,35 @@ function maybeAddWarning() {
5184
"This documentation is for an <strong>older version</strong> that may be missing recent changes.<br>";
5285
}
5386

54-
warningMessage +=
55-
'<a href="' +
56-
href +
57-
'">Click here to go to the documentation for the latest stable release.</a>';
87+
// Create the link element with same-page navigation
88+
const link = document.createElement("a");
89+
link.href = target_url + current_hash;
90+
link.textContent =
91+
"Click here to go to the documentation for the latest stable release.";
92+
93+
// If we're trying to stay on the same page, verify it exists first
94+
if (page_path && page_path !== "" && page_path !== "index.html") {
95+
link.addEventListener("click", function (e) {
96+
e.preventDefault();
97+
// check if the target page exists, fallback to homepage if it doesn't
98+
fetch(target_url, { method: "HEAD" })
99+
.then(function (response) {
100+
if (response.ok) {
101+
window.location.href = target_url + current_hash;
102+
} else {
103+
// page doesn't exist in the target version, go to homepage
104+
window.location.href = target_href;
105+
}
106+
})
107+
.catch(function (error) {
108+
// network error or other failure - use homepage
109+
window.location.href = target_href;
110+
});
111+
});
112+
}
58113

59114
div.innerHTML = warningMessage;
115+
div.appendChild(link);
60116
div.appendChild(closer);
61117
document.body.appendChild(div);
62118
}

dev/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010

1111
# Train with FYL algorithm
1212
algorithm = PerturbedFenchelYoungLossImitation()
13-
result = train_policy(algorithm, benchmark; epochs=50)</code></pre><p>See the <a href="interface/">Interface Guide</a> and <a href="tutorials/tutorial/">Tutorials</a> for more details.</p><h2 id="Available-Algorithms"><a class="docs-heading-anchor" href="#Available-Algorithms">Available Algorithms</a><a id="Available-Algorithms-1"></a><a class="docs-heading-anchor-permalink" href="#Available-Algorithms" title="Permalink"></a></h2><ul><li><strong>Perturbed Fenchel-Young Loss Imitation</strong>: Differentiable imitation learning with perturbed optimization</li><li><strong>AnticipativeImitation</strong>: Imitation of anticipative solutions for dynamic problems</li><li><strong>DAgger</strong>: DAgger algorithm for dynamic problems</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="interface/">Interface Guide »</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.16.1 on <span class="colophon-date" title="Friday 16 January 2026 16:07">Friday 16 January 2026</span>. Using Julia version 1.12.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
13+
result = train_policy(algorithm, benchmark; epochs=50)</code></pre><p>See the <a href="interface/">Interface Guide</a> and <a href="tutorials/tutorial/">Tutorials</a> for more details.</p><h2 id="Available-Algorithms"><a class="docs-heading-anchor" href="#Available-Algorithms">Available Algorithms</a><a id="Available-Algorithms-1"></a><a class="docs-heading-anchor-permalink" href="#Available-Algorithms" title="Permalink"></a></h2><ul><li><strong>Perturbed Fenchel-Young Loss Imitation</strong>: Differentiable imitation learning with perturbed optimization</li><li><strong>AnticipativeImitation</strong>: Imitation of anticipative solutions for dynamic problems</li><li><strong>DAgger</strong>: DAgger algorithm for dynamic problems</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="interface/">Interface Guide »</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.17.0 on <span class="colophon-date" title="Tuesday 17 March 2026 17:31">Tuesday 17 March 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/interface/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
gap_metric = FunctionMetric(:validation_gap, validation_data) do ctx, data
1010
compute_gap(benchmark, data, ctx.policy.statistical_model, ctx.policy.maximizer)
1111
end</code></pre><h3 id="TrainingContext"><a class="docs-heading-anchor" href="#TrainingContext">TrainingContext</a><a id="TrainingContext-1"></a><a class="docs-heading-anchor-permalink" href="#TrainingContext" title="Permalink"></a></h3><p>Metrics receive a <code>TrainingContext</code> object containing:</p><ul><li><code>policy::DFLPolicy</code>: The policy being trained</li><li><code>epoch::Int</code>: Current epoch number</li><li><code>maximizer_kwargs::Function</code>: Maximizer kwargs extractor</li><li><code>other_fields</code>: Algorithm-specific fields (e.g., <code>loss</code> for FYL)</li></ul><p>Access policy components:</p><pre><code class="language-julia hljs">ctx.policy.statistical_model # Neural network
12-
ctx.policy.maximizer # Combinatorial optimizer</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../tutorials/tutorial/">Basic Tutorial: Training with FYL on Argmax Benchmark »</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.16.1 on <span class="colophon-date" title="Friday 16 January 2026 16:07">Friday 16 January 2026</span>. Using Julia version 1.12.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
12+
ctx.policy.maximizer # Combinatorial optimizer</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../tutorials/tutorial/">Basic Tutorial: Training with FYL on Argmax Benchmark »</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.17.0 on <span class="colophon-date" title="Tuesday 17 March 2026 17:31">Tuesday 17 March 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)