Refresh README, add AGENTS.md, add --view flag to benchmarks/run.py#1359
Merged
Conversation
Rewrites the README to lead with a quickstart example, reorganizes sections for clarity, replaces the compatibility table with a concise exceptions list, and adds an animated examples gallery showcasing benchmark scenes. Adds AGENTS.md with development workflow conventions and a .agent/rules pointer for AI coding assistants. Adds a --view flag to benchmarks/run.py that launches mjwarp-viewer on a benchmark scene with nworld=1, so the examples in the README work out of the box.
Collaborator
|
awesome pr! thanks @erikfrey |
thowell
reviewed
May 15, 2026
thowell
reviewed
May 15, 2026
thowell
reviewed
May 15, 2026
thowell
reviewed
May 15, 2026
| - **Integrator**: `IMPLICIT` not yet supported | ||
| - **Solver**: `PGS` and `noslip` not yet supported | ||
| - **Actuator / Sensors**: `PLUGIN` types not yet supported | ||
| - **Flex**: flex-flex collisions, `selfcollide`, `mjEQ_FLEXVERT`, and `mjEQ_FLEXSTRAIN` not yet supported |
Collaborator
There was a problem hiding this comment.
wondering if we should just say that flex is experimental right now and that not all features are implemented or optimized yet?
@quagla thoughts?
Collaborator
Author
There was a problem hiding this comment.
Done — simplified to "experimental — not all features are implemented or optimized yet". @quagla please review the wording.
thowell
reviewed
May 15, 2026
Collaborator
|
left a few comments, additionally: 🐛 Identified Bugs & Structural Issues1. Broken Exception Logging in
|
- Use high-throughput instead of fast in README intro (thowell) - Simplify --event_trace flag usage, drop =True (thowell) - Remove Jacobian format exception, sparse Jacobians now supported (thowell) - Simplify Flex to experimental status (thowell) - Move differentiability out of exceptions list, link to google-deepmind#500 (thowell) - Link implicit integrator exception to PR google-deepmind#1339 (thowell) - Fix e.stderr logging in _view_benchmark, use e.returncode instead (thowell) - Warn and show only first match when --view matches multiple benchmarks (thowell)
Collaborator
Author
|
Thanks for the thorough review @thowell! Addressed the inline comments and the follow-up in 00ef296: Applied:
Not applying (intentionally):
|
Restructure --view to avoid loop+break pattern, add empty benchmarks check with helpful error message. Unwrap hard-wrapped lines in AGENTS.md and soften PR body guidelines.
thowell
approved these changes
May 18, 2026
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.
Improves the README and first-time user experience.