[Doc] Results pipeline for the documentation, and a gallery of problems
メンテナーはふだん 1 日以内に返信
@ocots がすでに取り組んでいます。
2026年11月4日 から。
評価
この issue はまだ評価されていません。
説明
Agents: read the guide for agents in #310 first (order, difficulty, how to claim an issue, working method). The specification is in this description and in the comments below.
Goal
Separate the computations shown in the documentation (solving every problem, plots), which are long and may fail, from the documentation build, which must be fast and never fail because of a problem. Jobs compute results and store them; the documentation only reads what exists; each problem page shows the results if they exist and are up to date, says so otherwise. Problem pages are reached through a gallery instead of a list in the sidebar.
Part of #307. Related: #305 (crons write their reports to the same branch), #306 (features for the gallery filters), #134 (visualize), #311 (VitePress).
Storage: a results branch
- An orphan branch
results, rewritten with a single commit on each update so that it does not grow. Not a tracked directory inmain(regenerated SVGs would bloat the history). - Shared with the crons of #305 (no separate
cron-reportsbranch). - Locally: a git-ignored directory (e.g.
docs/results/) filled by a script, so the documentation also builds offline and in previews.
results/ # branch `results`
├── manifest.json # date, commit, list of runs
├── env/<run id>/ # environment of each computation run
│ ├── Project.toml, Manifest.toml
│ ├── versioninfo.txt # output of versioninfo()
│ └── status.txt, status-manifest.txt # Pkg.status(), Pkg.status(mode=PKGMODE_MANIFEST)
├── problems/<problem>/
│ ├── result.json # per modeling and configuration: objective, iterations, times, status; fingerprint; run id
│ ├── state.svg, control.svg, costate.svg
│ ├── visualize.svg # if the problem has a visualisation (#134)
│ └── thumbnail.svg # for the gallery
└── cron/ # reports of the crons (#305)
Robustness
-
One writer. Computation jobs run in parallel, one per problem, and only upload workflow artifacts; a final job collects them and makes the single commit. No concurrent writes; a failing problem does not prevent the others from being published.
-
Freshness. Each
result.jsonrecords a fingerprint: a hash of the problem files (metadata, model files of every modeling, description) and the versions of the packages used. At build time the documentation recomputes the fingerprint and shows, per problem:- up to date: the results;
- stale: the results, marked "computed for commit X";
- missing: "results not computed yet".
The build never fails on missing or stale results.
-
Triggers of the computations: a push to
mainthat changes a problem (only problems whose fingerprint changed), weekly (with the crons of #305, staggered),workflow_dispatch(all problems or a list). The documentation workflow never triggers or waits for them. -
VitePress: copy the results into
docs/src/public/results/beforemakedocs(VitePress silently drops files it does not recognise outsidepublic/, see the notes on the VitePress backend in ct-conventionsrules/site.md).
Problem pages
Generated, never hand-written (docs/problems.jl today):
- description (
ext/Descriptions/<p>.md), parameters, features (#306), status per modeling (#303), references; - how to get and solve it in each modeling where it exists (short code, not executed beyond trivial calls);
- results from
result.json, with the freshness badge; plots as SVG (ruleSITE12),visualize.svgwhen it exists; - Reproducibility block, same presentation as the OptimalControl.jl documentation (
docs/src/index.md, section "Reproducibility"): a table to downloadProject.tomlandManifest.tomlof the run that produced the results, and a collapsible::: detailsblock withversioninfo,Pkg.status()and the full dependency tree, read fromenv/<run id>/(they cannot be executed at build time, since the results come from another environment).
No heavy computation at documentation build time: the only code executed by the build is short (tutorials, trivial calls).
Gallery
Replaces the list of problems in the sidebar, since the collection will grow quickly:
- one card per problem: thumbnail (
thumbnail.svg, or the visualisation), name, modelings and statuses, tags; - filters by modeling, status, tag and features (dimensions, free final time, constraints);
- a Vue component (see
docs/src/components/in CTBase.jl), with the existing interactive table (docs/browser.jl) as a second view of the same page, or replaced by it.
Done when
- Workflow computing results per problem in parallel, single collector, branch
resultsrewritten with one commit;env/<run id>/saved for each run. - Fingerprint computed identically by the jobs and by the documentation build; up to date / stale / missing shown on the pages, shown on purpose for each case.
- Local script filling
docs/results/; documentation builds with no results at all. - Problem pages generated with results, plots, visualisation and Reproducibility block.
- Gallery page with filters; problems removed from the sidebar list.
- Documentation build time reported before and after.
- 主要言語
- Julia
- スター
- 13
- フォーク
- 1
- 平均マージ
- 3時間 20分
- マージ済み PR(30日)
- 27
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
control-toolbox/OptimalControlProblems.jl のほかの issue
-
[Metadata] Declared fields: tags, references, Corleone, reference solution対応中かも @ocots が今日担当しました。 オープン
control-toolbox/OptimalControlProblems.jl#379 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[Cron] Robustness of the initial guess and known local objectives対応中かも @ocots が今日担当しました。 オープン
control-toolbox/OptimalControlProblems.jl#378 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[Metadata] Shared initial guess in the metadata, read by every modeling対応中かも @ocots が今日担当しました。 オープン
control-toolbox/OptimalControlProblems.jl#377 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[Metadata] Compute the features of a problem from its model対応中かも @ocots が今日担当しました。 オープン
control-toolbox/OptimalControlProblems.jl#376 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[Metadata] Reference objectives per scheme, computed by a script対応中かも @ocots が今日担当しました。 オープン
control-toolbox/OptimalControlProblems.jl#375 · コメント 1 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
control-toolbox/OptimalControlProblems.jl の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
backport 1.14 GC
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
`binary_focal_loss` throws a `DomainError` when a negative sample has `ŷ = 1`対応中かも @parth-patel010 が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
FluxML/Flux.jl#2818 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
JuliaDiff/TaylorSeries.jl#445 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
control-toolbox/CTActions#139 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信