Document additional dependency and architectural issues

- Add warning about dependency version conflicts
- Document environment wrapper interface inconsistencies
- Note missing git dependency for playground package
- Acknowledge that additional runtime issues may persist due to architectural problems
This commit is contained in:
ys1087@partner.kit.edu 2025-07-22 17:29:52 +02:00
parent b240a19ceb
commit 6e3ecb95ff

View File

@ -120,7 +120,15 @@ All experiments automatically log to wandb with your configured credentials. Res
- **Root cause**: BraxGymnaxWrapper.reset() method doesn't handle batched keys from vmapped initialization
- **Fix applied**: Modified reset() method to detect and properly handle both single and batched keys using `jax.vmap`
**Summary**: Fixed 6 critical bugs that prevented the original repository from running at all. The algorithm now works end-to-end with proper wandb integration.
**7. Environment Wrapper Interface Inconsistencies**
- **Issue**: Multiple environment wrappers with incompatible return signatures causing unpacking errors
- **Root cause**: BraxGymnaxWrapper, NormalizeVec, and other wrappers expect different return formats
- **Additional issue**: Missing git dependency for `playground` package (line 23 references "playground" but line 130 specifies git source)
- **Status**: Partially fixed - dependency version mismatches and architectural inconsistencies may cause additional runtime issues
**⚠️ Note**: The repository may have additional dependency version conflicts and architectural issues that could cause runtime failures. The codebase appears to have been developed with non-fixed dependency versions that may have broken compatibility over time.
**Summary**: Fixed 6+ critical bugs, but the repository's architectural design and dependency management suggest additional issues may persist.
---