stdlib-js / stdlib-js/stdlib

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

Abierto
#6,625 7 comentarios 0 reacciones 0 asignados Ver en GitHub
Needs Discussion RFC
Lenguaje dominante
JavaScript
Estrellas
6k
Forks
1.3k
Merge medio
1 d 3 h
PR fusionados (30 d)
611

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.