[RFC]: Add validator and parser in `@stdlib/bench/*` for benchmark description
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 1.3k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 611
Description
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
Questions
No.
Other
No.
Checklist
- I have read and understood the Code of Conduct.
- Searched for existing issues and pull requests.
- The issue name begins with
RFC:.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100