Bump black_death_v3 to black_death_v4 - #266
Open
teddytennant wants to merge 1 commit into
Open
Conversation
The wrapper's behavior changed in Farama-Foundation#265: it now reports the episode as done when every agent is terminated OR truncated, where before it required both, so an episode that ended purely by truncation never reported done. Per the SuperSuit convention that a behavior change gets a new version, this renames the wrapper to black_death_v4. supersuit.__getattr__ picks the bump up automatically: >>> supersuit.black_death_v3 DeprecatedWrapper: black_death_v3 is now deprecated, use black_death_v4 instead Follow-on to Farama-Foundation#265, as requested.
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.
Follow-on to #265, as requested — bumps the wrapper version for the behavior change that PR made.
Why
#265 changed
black_death's done semantics: the episode is now reported as done when every agent is terminated or truncated, where before it required both, so an episode that ended purely by truncation never reported done. That's a behavior change to a versioned wrapper, so it gets a new version.What
black_death_v3→black_death_v4, updated at the definition, both__init__.pyre-exports, and the four test modules that use it.No new deprecation plumbing is needed —
supersuit.__getattr__derives it from the version suffix automatically:Testing
pytest test/→ 115 passed, 46 skipped. The 2 collection errors are pre-existing missing optional deps locally (multi_agent_ale_py,stable_baselines3) and error identically onmain.