Document which libraries are actually patched, archive the rest - #14
Merged
Conversation
The README said "I can't remember which packages I modified, install all of
them". Every vendored package has now been diffed against the exact version
pinned in environment.yml.
Only three are patched:
supersuit 5 files: Dict observation support in frame_stack and
black_death, plus three project-local workarounds
stable_baselines3 3 files: VecEnv 5-tuple step / (obs, info) reset
msgpackrpc 1 file: RPC timeout 10s -> 100s for AirSim
Three were never modified and moved to archive/unmodified_libs:
pettingzoo 1.23.1 byte-identical to upstream
msgpack 0.5.6 byte-identical to upstream
gymnasium 0.28.1 one file differs by two unused imports and two
trailing comments; the parsed AST is identical
modified_libs/PATCHES.md records what each patch does. The two SuperSuit
fixes are submitted upstream as SuperSuit#268 and SuperSuit#269; once merged,
supersuit can be dropped from this folder.
Also documents that the environment passes pettingzoo's parallel_api_test on
PettingZoo 1.26.1 and that the train.py wrapper chain runs on SuperSuit 3.11
with those two patches.
Lauqz
added a commit
that referenced
this pull request
Jul 26, 2026
Document which libraries are actually patched, archive the rest
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
2 participants
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.
Answers the open question in the README: "Unfortunately, I can't remember which packages I modified. I advice you to install all of them to avoid bugs."
Every vendored package was diffed against the exact version pinned in
environment.yml, with line endings normalised.Actually patched (3 of 6)
supersuit3.8.0Dictobservation support inframe_stackandblack_death, plus 3 project-local workaroundsstable_baselines32.0.0VecEnv5-tuplestep_wait()and(obs, info)reset()msgpackrpc0.4.1Never modified (moved to
archive/unmodified_libs/)pettingzoo1.23.1msgpack0.5.6gymnasium0.28.1#!!!comments; parsed AST is identical, so it is a no-opInstall those three from PyPI instead.
Upstream
The two general SuperSuit fixes are submitted:
frame_stackacceptingDict)black_deathacceptingDict)Once merged,
modified_libs/supersuitcan be dropped entirely.Also documented
The environment passes PettingZoo's
parallel_api_teston PettingZoo 1.26.1, and thetrain.pywrapper chain runs on SuperSuit 3.11 with those two patches, on NumPy 2.x and Gymnasium 1.3. Verified with a mocked AirSim client, so it covers the API surface rather than a full simulator run.Diff shape
877 pure renames (R100), 1 modified README, 2 new docs. No library source was changed by this PR.
Depends on #13 for the two source fixes.