stdlib-js / stdlib-js/stdlib

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

Open
#6,625 7 comments 0 reactions 0 assignees View on GitHub
Needs Discussion RFC
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](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:`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.