Skip to content

docs: document deterministic multi-family SVG rendering#140

Merged
ProfRandom92 merged 1 commit into
mainfrom
codex/update-multi-family-benchmark-documentation
May 19, 2026
Merged

docs: document deterministic multi-family SVG rendering#140
ProfRandom92 merged 1 commit into
mainfrom
codex/update-multi-family-benchmark-documentation

Conversation

@ProfRandom92
Copy link
Copy Markdown
Owner

Motivation

  • Document the new deterministic SVG rendering step for the multi-family admissibility benchmark so contributors know the input/output artifacts, the renderer script, the npm regeneration command, and how to validate the renderer; this keeps benchmark docs aligned with the committed renderer and test artifacts.

Description

  • Added a concise "Deterministic SVG rendering" section to docs/benchmarks/multi_family_admissibility_benchmark.md that references the input artifact artifacts/multi_family_admissibility_results.json, output artifacts/multi_family_admissibility_curves.svg, renderer script scripts/render_multi_family_admissibility_svg.py, and npm command npm run generate:multi-family-svg, and updated the validation commands to include pytest tests/test_multi_family_svg_renderer.py -q.

Testing

  • Ran npm run check (which runs the repository-wide layout/typecheck/validate/build/test pipeline) and all tests passed; the targeted pytest run pytest tests/test_multi_family_svg_renderer.py -q was included in the test suite and passed as part of the run.

Codex Task

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the multi_family_admissibility_benchmark.md documentation by adding a section for deterministic SVG rendering and a corresponding test command in the validation section. Feedback suggests improving the formatting of the new documentation section by using code blocks for commands to ensure consistency with existing sections and improve usability for copy-pasting.

Comment on lines +70 to +75
The benchmark also includes a deterministic SVG rendering step:

- Input: `artifacts/multi_family_admissibility_results.json`
- Output: `artifacts/multi_family_admissibility_curves.svg`
- Script: `scripts/render_multi_family_admissibility_svg.py`
- npm command: `npm run generate:multi-family-svg`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the 'Regeneration commands' section (lines 56-66), consider using code blocks for the SVG regeneration commands and including the Python script execution command explicitly. This makes the documentation easier to follow and the commands easier to copy-paste.

Suggested structure:

The benchmark also includes a deterministic SVG rendering step:

- Input: `artifacts/multi_family_admissibility_results.json`
- Output: `artifacts/multi_family_admissibility_curves.svg`

Use either command to regenerate the SVG:

```bash
python scripts/render_multi_family_admissibility_svg.py
npm run generate:multi-family-svg

@ProfRandom92 ProfRandom92 merged commit 6800975 into main May 19, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant