Transfert from paper to RTD - #6
Open
frheault wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a new Benchmarks section to the documentation and introduces a dedicated page describing the TRX benchmark suite, results visualizations, and interoperability testing methodology.
Changes:
- Adds a “Benchmarks” dropdown entry to the main docs index navigation.
- Introduces
benchmarks.mdwith benchmark methodology, results figures, and availability links.
Reviewed changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| source/index.md | Adds a new docs navigation dropdown linking to the Benchmarks page. |
| source/benchmarks.md | New documentation page detailing benchmark results, testing methodology, and technical observations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Benchmarks page summarizing the TRX format's performance evaluations across Python, Rust, C++, and JavaScript. It integrates the storage size comparisons, processing duration/throughput (Trellis) plots, and documents our unified, relay, compression, and edge-case testing methodologies.
The text is 90% from the Overleaf and slightly rephrased, but also extra information I had noted during development.
I removed most of the "overlapping" text from the overleaf, but when information is present in both, typically the Overleaf is more concise.