Skip to content

Commit 9d877a0

Browse files
author
Documenter.jl
committed
build based on 13d2398
1 parent 992e931 commit 9d877a0

File tree

14 files changed

+652
-3
lines changed

14 files changed

+652
-3
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-12T17:18:29","documenter_version":"1.16.1"}}
1+
{"documenter":{"julia_version":"1.12.4","generation_timestamp":"2026-01-16T16:07:06","documenter_version":"1.16.1"}}

dev/api/index.html

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

dev/index.html

Lines changed: 12 additions & 1 deletion
Large diffs are not rendered by default.

dev/interface/index.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Interface Guide · DecisionFocusedLearningAlgorithms.jl</title><meta name="title" content="Interface Guide · DecisionFocusedLearningAlgorithms.jl"/><meta property="og:title" content="Interface Guide · DecisionFocusedLearningAlgorithms.jl"/><meta property="twitter:title" content="Interface Guide · DecisionFocusedLearningAlgorithms.jl"/><meta name="description" content="Documentation for DecisionFocusedLearningAlgorithms.jl."/><meta property="og:description" content="Documentation for DecisionFocusedLearningAlgorithms.jl."/><meta property="twitter:description" content="Documentation for DecisionFocusedLearningAlgorithms.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="../">DecisionFocusedLearningAlgorithms.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 class="is-active"><a class="tocitem" href>Interface Guide</a><ul class="internal"><li><a class="tocitem" href="#Core-Concepts"><span>Core Concepts</span></a></li><li><a class="tocitem" href="#Metrics"><span>Metrics</span></a></li></ul></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../tutorials/tutorial/">Basic Tutorial: Training with FYL on Argmax Benchmark</a></li><li><a class="tocitem" href="../tutorials/warcraft_fyl/">Training on Warcraft Shortest Path</a></li></ul></li><li><a class="tocitem" href="../api/">API Reference</a></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 class="is-active"><a href>Interface Guide</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Interface Guide</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningAlgorithms.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/DecisionFocusedLearningAlgorithms.jl/blob/main/docs/src/interface.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="Algorithm-Interface"><a class="docs-heading-anchor" href="#Algorithm-Interface">Algorithm Interface</a><a id="Algorithm-Interface-1"></a><a class="docs-heading-anchor-permalink" href="#Algorithm-Interface" title="Permalink"></a></h1><p>This page describes the unified interface for Decision-Focused Learning algorithms provided by this package.</p><h2 id="Core-Concepts"><a class="docs-heading-anchor" href="#Core-Concepts">Core Concepts</a><a id="Core-Concepts-1"></a><a class="docs-heading-anchor-permalink" href="#Core-Concepts" title="Permalink"></a></h2><h3 id="DFLPolicy"><a class="docs-heading-anchor" href="#DFLPolicy">DFLPolicy</a><a id="DFLPolicy-1"></a><a class="docs-heading-anchor-permalink" href="#DFLPolicy" title="Permalink"></a></h3><p>The <a href="#DFLPolicy"><code>DFLPolicy</code></a> is the central abstraction that encapsulates a decision-focused learning policy. It combines:</p><ul><li>A <strong>statistical model</strong> (typically a neural network) that predicts parameters from input features</li><li>A <strong>combinatorial optimizer</strong> (maximizer) that solves optimization problems using the predicted parameters</li></ul><pre><code class="language-julia hljs">policy = DFLPolicy(
3+
Chain(Dense(input_dim =&gt; hidden_dim, relu), Dense(hidden_dim =&gt; output_dim)),
4+
my_optimizer
5+
)</code></pre><h3 id="Training-Interface"><a class="docs-heading-anchor" href="#Training-Interface">Training Interface</a><a id="Training-Interface-1"></a><a class="docs-heading-anchor-permalink" href="#Training-Interface" title="Permalink"></a></h3><p>All algorithms in this package follow a unified training interface with two main functions:</p><h4 id="Core-Training-Method"><a class="docs-heading-anchor" href="#Core-Training-Method">Core Training Method</a><a id="Core-Training-Method-1"></a><a class="docs-heading-anchor-permalink" href="#Core-Training-Method" title="Permalink"></a></h4><pre><code class="language-julia hljs">history = train_policy!(algorithm, policy, training_data; epochs=100, metrics=(), maximizer_kwargs=get_info)</code></pre><p><strong>Arguments:</strong></p><ul><li><code>algorithm</code>: An algorithm instance (e.g., <code>PerturbedFenchelYoungLossImitation</code>, <code>DAgger</code>, <code>AnticipativeImitation</code>)</li><li><code>policy::DFLPolicy</code>: The policy to train (contains the model and maximizer)</li><li><code>training_data</code>: Either a dataset of <code>DataSample</code> objects or <code>Environment</code> (depends on algorithm)</li><li><code>epochs::Int</code>: Number of training epochs (default: 100)</li><li><code>metrics::Tuple</code>: Metrics to evaluate during training (default: empty)</li><li><code>maximizer_kwargs::Function</code>: Function that extracts keyword arguments for the maximizer from data samples (default: <code>get_info</code>)</li></ul><p><strong>Returns:</strong></p><ul><li><code>history::MVHistory</code>: Training history containing loss values and metric evaluations</li></ul><h4 id="Benchmark-Convenience-Wrapper"><a class="docs-heading-anchor" href="#Benchmark-Convenience-Wrapper">Benchmark Convenience Wrapper</a><a id="Benchmark-Convenience-Wrapper-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmark-Convenience-Wrapper" title="Permalink"></a></h4><pre><code class="language-julia hljs">result = train_policy(algorithm, benchmark; dataset_size=30, split_ratio=(0.3, 0.3), epochs=100, metrics=())</code></pre><p>This high-level function handles all setup from a benchmark and returns a trained policy along with training history.</p><p><strong>Arguments:</strong></p><ul><li><code>algorithm</code>: An algorithm instance</li><li><code>benchmark::AbstractBenchmark</code>: A benchmark from DecisionFocusedLearningBenchmarks.jl</li><li><code>dataset_size::Int</code>: Number of instances to generate</li><li><code>split_ratio::Tuple</code>: Train/validation/test split ratios</li><li><code>epochs::Int</code>: Number of training epochs</li><li><code>metrics::Tuple</code>: Metrics to track during training</li></ul><p><strong>Returns:</strong></p><ul><li><code>(; policy, history)</code>: Named tuple with trained policy and training history</li></ul><h2 id="Metrics"><a class="docs-heading-anchor" href="#Metrics">Metrics</a><a id="Metrics-1"></a><a class="docs-heading-anchor-permalink" href="#Metrics" title="Permalink"></a></h2><p>Metrics allow you to track additional quantities during training.</p><h3 id="Built-in-Metrics"><a class="docs-heading-anchor" href="#Built-in-Metrics">Built-in Metrics</a><a id="Built-in-Metrics-1"></a><a class="docs-heading-anchor-permalink" href="#Built-in-Metrics" title="Permalink"></a></h3><h4 id="FYLLossMetric"><a class="docs-heading-anchor" href="#FYLLossMetric">FYLLossMetric</a><a id="FYLLossMetric-1"></a><a class="docs-heading-anchor-permalink" href="#FYLLossMetric" title="Permalink"></a></h4><p>Evaluates Fenchel-Young loss on a validation dataset.</p><pre><code class="language-julia hljs">val_metric = FYLLossMetric(validation_data, :validation_loss)</code></pre><h4 id="FunctionMetric"><a class="docs-heading-anchor" href="#FunctionMetric">FunctionMetric</a><a id="FunctionMetric-1"></a><a class="docs-heading-anchor-permalink" href="#FunctionMetric" title="Permalink"></a></h4><p>Custom metric defined by a function.</p><pre><code class="language-julia hljs"># Simple metric (no stored data)
6+
epoch_metric = FunctionMetric(ctx -&gt; ctx.epoch, :epoch)
7+
8+
# Metric with stored data
9+
gap_metric = FunctionMetric(:validation_gap, validation_data) do ctx, data
10+
compute_gap(benchmark, data, ctx.policy.statistical_model, ctx.policy.maximizer)
11+
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>

dev/objects.inv

1.39 KB
Binary file not shown.

dev/search_index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/tutorials/tutorial.jl

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# # Basic Tutorial: Training with FYL on Argmax Benchmark
2+
#
3+
# This tutorial demonstrates the basic workflow for training a policy
4+
# using the Perturbed Fenchel-Young Loss algorithm.
5+
6+
# ## Setup
7+
using DecisionFocusedLearningAlgorithms
8+
using DecisionFocusedLearningBenchmarks
9+
using MLUtils: splitobs
10+
using Plots
11+
12+
# ## Create Benchmark and Data
13+
b = ArgmaxBenchmark()
14+
dataset = generate_dataset(b, 100)
15+
train_data, val_data, test_data = splitobs(dataset; at=(0.3, 0.3, 0.4))
16+
17+
# ## Create Policy
18+
model = generate_statistical_model(b; seed=0)
19+
maximizer = generate_maximizer(b)
20+
policy = DFLPolicy(model, maximizer)
21+
22+
# ## Configure Algorithm
23+
algorithm = PerturbedFenchelYoungLossImitation(;
24+
nb_samples=10, ε=0.1, threaded=true, seed=0
25+
)
26+
27+
# ## Define Metrics to track during training
28+
validation_loss_metric = FYLLossMetric(val_data, :validation_loss)
29+
30+
val_gap_metric = FunctionMetric(:val_gap, val_data) do ctx, data
31+
compute_gap(b, data, ctx.policy.statistical_model, ctx.policy.maximizer)
32+
end
33+
34+
test_gap_metric = FunctionMetric(:test_gap, test_data) do ctx, data
35+
compute_gap(b, data, ctx.policy.statistical_model, ctx.policy.maximizer)
36+
end
37+
38+
metrics = (validation_loss_metric, val_gap_metric, test_gap_metric)
39+
40+
# ## Train the Policy
41+
history = train_policy!(algorithm, policy, train_data; epochs=100, metrics=metrics)
42+
43+
# ## Plot Results
44+
val_gap_epochs, val_gap_values = get(history, :val_gap)
45+
test_gap_epochs, test_gap_values = get(history, :test_gap)
46+
47+
plot(
48+
[val_gap_epochs, test_gap_epochs],
49+
[val_gap_values, test_gap_values];
50+
labels=["Val Gap" "Test Gap"],
51+
xlabel="Epoch",
52+
ylabel="Gap",
53+
title="Gap Evolution During Training",
54+
)
55+
56+
# Plot loss evolution
57+
train_loss_epochs, train_loss_values = get(history, :training_loss)
58+
val_loss_epochs, val_loss_values = get(history, :validation_loss)
59+
60+
plot(
61+
[train_loss_epochs, val_loss_epochs],
62+
[train_loss_values, val_loss_values];
63+
labels=["Training Loss" "Validation Loss"],
64+
xlabel="Epoch",
65+
ylabel="Loss",
66+
title="Loss Evolution During Training",
67+
)

0 commit comments

Comments
 (0)