Document executed error norms in BackendHistory

Aperta Adatta ai principianti
#628 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
86/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python

Direzione di ricerca

Leggi src/solprop/backends/protocol.py alla revisione collegata e confronta BackendHistory.error_norm con _march_to e _record in src/solprop/backends/driver.py. Aggiorna la documentazione dell’attributo per descrivere la norma del tentativo eseguito e mantenere distinto lo storico equivalente del controller. Il lavoro è completato quando la documentazione del record pubblico corrisponde al contratto del driver e i controlli della documentazione vengono superati, senza modificare i calcoli o i valori predefiniti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation priority: medium

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_norm attribute 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.

Lingua principale
Python
Stelle
3
Fork
3
Merge medio
8h 28m
PR unite (30g)
176

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di LupoLab/solprop

Tutte le issue di LupoLab/solprop

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.