0xMiden/examples

Benchmarking CLI improvements

Offen

#39 geöffnet am 21.12.2022

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (25 Forks)github user discovery
good first issue

Repository-Metriken

Stars
 (21 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

A few small things that would be great to improve in benchmarking CLI:

  1. We should use structop instead of clap as thats what we use for all other CLIs (e.g., here).
  2. We should keep CLI parameters as consistent as possible across different CLIs (e.g., for how we specify security, number of outputs etc.). See example here.
  3. Let's change the executable file name to something like miden-bench (miden-benchmarking-cli is way too long).
  4. miden::prove() also includes execution time, I believe. So, to make things more clear, we should probably label it as "Execution + proving time" or something like that.
  5. Would also be great to print out proof size.

Contributor Guide

Research-Richtung
Untersuche die aktuelle Implementierung der Benchmarking CLI im Beispiele Repository. Finde heraus, wo clap verwendet wird, und ersetze es durch structop, dem Muster in miden vms main.rs folgend. Überprüfe andere CLIs (z. B. prove.rs) auf konsistente Parameternamen. Benenne die ausführbare Datei in miden bench um. Aktualisiere die Ausgabebezeichnung auf 'Execution + proving time'. Füge das Drucken der Beweisgröße hinzu.
Tech Stack
rust
Domain
clitooling
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
RustGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75