0xMiden/examples

Benchmarking CLI improvements

Ouverte

#39 ouverte le 21 déc. 2022

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (1 personne assignée)TypeScript (25 forks)github user discovery
good first issue

Métriques du dépôt

Stars
 (21 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Examinez l'implémentation actuelle de l'interface en ligne de commande de benchmarking dans le référentiel d'exemples. Identifiez où clap est utilisé et remplacez le par structop, en suivant le modèle dans main.rs de miden vm. Consultez d'autres CLI (par exemple, prove.rs) pour une dénomination cohérente des paramètres. Renommez l'exécutable en miden bench. Mettez à jour l'étiquette de sortie pour inclure 'Execution + proving time'. Ajoutez l'impression de la taille de la preuve.
Stack technique
rust
Domaine
clitooling
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RustGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75