Add API refactor and CI/CD checks #1
Merged
Conversation
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
Major Changes: - Refactor environment API to follow standard gym pattern (reset/step) - Refactor agent API to use observe/think/act pattern - Add ty type checking with configuration - Add ruff linting with configuration - Set up pre-commit hooks - Add GitHub Actions workflow for PR checks - Add third-party code notices for overcooked_new - Update all environments (Freeway, Snake, Overcooked) - Update all agents (Reactive, Planning, Agile) - Maintain backward compatibility New Features: - gym-like make() API for easy environment creation - Standardized obs, done = env.reset() pattern - Standardized obs, done, reward = env.step(action) pattern - agent.observe(obs) / agent.think(timeout) / agent.act() pattern - Type checking with ty (all checks pass) - Linting with ruff (all checks pass) - Pre-commit hooks for automated quality checks - CI/CD pipeline for PR validation Documentation: - Updated README.md with development setup - Added CONTRIBUTING.md with contribution guidelines - Added THIRD_PARTY_NOTICE.md for Overcooked-AI code - Added inline documentation and comments
- Updated ruff-pre-commit from v0.8.4 to v0.14.1 - Fixes issue where pre-commit ruff (v0.8.4) was undoing standalone ruff (v0.11.13) formatting - Both versions now agree on formatting style
- Added ty to dev dependencies in pyproject.toml - Fixes 'ty: No such file or directory' error in GitHub Actions - CI workflow uses 'uv sync --all-extras' to install dev dependencies
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.
Summary
This PR implements a comprehensive refactoring of the RealtimeGym package API and adds complete CI/CD infrastructure.
Changes
API Refactoring
reset()now returns(obs, done)step(action)method returns(obs, done, reward)act()methodobserve(observation)method to receive observationsthink(timeout)signatureact()returnsNonefor default action fallbackPackage Structure
make()function in__init__.pywith environment registrypyproject.tomlwith complete dependencies listrun_game.pyCode Quality
ty check(19/19 files)ruff checkandruff formatl→ descriptive names)== True,!= None)CI/CD Infrastructure
Third-Party Code Management
Testing
All checks passing:
Backward Compatibility
Legacy
act()method maintained in environments for backward compatibility with existing code.