stdlib-js / stdlib-js/stdlib

[RFC]: Add validator and parser in `@stdlib/bench/*` for benchmark description

Aperta
#6,625 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Needs Discussion RFC
Lingua principale
JavaScript
Stelle
6k
Fork
1.3k
Merge medio
1g 3h
PR unite (30g)
611

Descrizione

### Description

This RFC proposes adding Validator and Parser for the benchmark description ( EX : `# @stdlib/blas/ddot::stacks:size=1000,ndims=2,shape=(2,500)` ) in `@stdlib/bench/*`

Until now, we have been using this descriptive format unconsciously. However, since these descriptors are crucial for visualizing the benchmarks, we need to formalize this approach by including validation and a parser that converts the description into JSON.

### Related Issues

Related issues [#6](https://github.com/stdlib-js/google-summer-of-code/issues/6)

### Questions

No.

### Other

No.

### Checklist

- [x] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [x] Searched for existing issues and pull requests.
- [x] The issue name begins with `RFC:`.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start by reviewing the existing @stdlib/bench/* code and the discussion in related issue #6. Define the benchmark-description format, including validation rules and the JSON representation produced by the parser; done means both capabilities are formalized for the example descriptor.

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

Valutazione

Stack tecnologico
javascript
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.