aai-institute / aai-institute/nnbench

Add small parameter representation guide for the benchmark runner

Offen Anfängerfreundlich
#141 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation enhancement
Vorherrschende Sprache
Python
Sterne
21
Forks
4
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

We recently changed the way parameters are injected into the benchmark records. All Python-native types and containers thereof are passing unchanged, but user-defined types are serialized to string (their repr() outputs to be exact), which can be surprising.

Since we do not yet mention this anywhere in the docs, we could set up a small section on this practice, and recommend a way to handle types for best odds of reproducibility (e.g. dumping unique information into the output, or overloading the repr() method to give all unique info).

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Look at the benchmark runner code that injects parameters into records, likely in a file like runner.py or record.py. Examine how parameters are serialized, focusing on the handling of user-defined types. Review existing documentation to find where to add a new section explaining the repr() serialization practice and recommendations for ensuring reproducibility.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
70/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.