stdlib-js / stdlib-js/stdlib

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

Offen
#6,625 7 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Needs Discussion RFC
Vorherrschende Sprache
JavaScript
Sterne
6k
Forks
1.3k
Ø Merge
1 T. 3 Std.
Gemergte PRs (30 T.)
611

Beschreibung

### 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:`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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