stdlib-js / stdlib-js/stdlib

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

オープン
#6,625 コメント 7 件 リアクション 0 件 担当者 0 名 GitHub で見る
Needs Discussion RFC
主要言語
JavaScript
スター
6k
フォーク
1.3k
平均マージ
1日 3時間
マージ済み PR(30日)
611

説明

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

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。