Document executed error norms in BackendHistory
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 86/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- python
- 領域
- backend, documentation
調査の方向性
リンク先のリビジョンで src/solprop/backends/protocol.py を読み、BackendHistory.error_norm と src/solprop/backends/driver.py の _march_to および _record を比較します。実行された試行のノルムを説明するよう属性のドキュメントを更新し、対応するコントローラーの履歴とは区別します。公開レコードのドキュメントがドライバーの契約と一致し、計算や既定値を変更せずにドキュメントチェックが通れば完了です。
索引モデルが issue の本文から書いたものです。
説明
What happens
BackendHistory.error_norm is documented as the error rescaled to the controller's unclipped proposal. The actual Runge–Kutta march records the executed trial norm. Only the controller's private accepted-norm history receives the equivalent proposal norm.
Why it matters
A backend implementing the session contract from the public record documentation could report different error histories at clipped or stretched landings even while making the correct numerical decisions.
Reproduction
Read, not a new numerical run: compare BackendHistory at ba7bee7a with _march_to and _record in the reference driver. _march_to computes equivalent, passes the original norm to _record, and appends equivalent to controller history. _record explicitly documents this executed-norm contract.
Context
Found during the independent Julia-owned session implementation in #611, tracking #608. Related session work is #607.
To do
- Correct the
BackendHistory.error_normattribute documentation to describe the executed norm. - Keep the separate equivalent controller history explicit and preserve numerical behavior.
Done when
The public record documentation agrees with the existing driver's contract and documentation checks pass. No arithmetic or defaults change.
- 主要言語
- Python
- スター
- 3
- フォーク
- 3
- 平均マージ
- 8時間 28分
- マージ済み PR（30日）
- 176
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
LupoLab/solprop のほかの issue
-
bug
難易度 1/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
documentation priority: low
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
documentation priority: high
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
documentation good first issue priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
area: native priority: low testing
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
LupoLab/solprop の issue をすべて見る
似ている issue
-
bug triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
mealie-recipes/mealie#9117 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
freelawproject/courtlistener#8406 ·
メンテナーはふだん 2 日以内に返信
-
good first issue help wanted level 1 wocs
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
GianlucaBave/murmury#49 ·
メンテナーはふだん 1 日以内に返信
-
regression skipped skipped_bmg
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
intel/torch-xpu-ops#6142 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
good first issue help wanted python up-for-grabs
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
andrewsiah/agentswarm-data-tasks#122 ·
メンテナーはふだん 1 日以内に返信