docs: fix README Quick Start so a fresh install actually runs#14
Open
sasmith wants to merge 2 commits into
Open
docs: fix README Quick Start so a fresh install actually runs#14sasmith wants to merge 2 commits into
sasmith wants to merge 2 commits into
Conversation
- Add `cogsguard` (the Cogs vs Clips game) install from git: `pip install cogames` alone leaves `-m arena` failing with "Mission 'arena' not found." because the default game is registered but not bundled. - Use the `neural` extras so the `starter` policy can import `torch` (previously crashed with `ModuleNotFoundError: No module named 'torch'`). - Recommend a virtual environment up front to avoid the OS-managed PyYAML uninstall error on Debian-based system Pythons. - Replace the stale `beta-teams-small` season name (returns "Season not found") with `beta-teams-tiny-fixed`, and point users at `cogames season list`. https://claude.ai/code/session_01XTNWKurh2pCerhryCxDf73
sasmith
force-pushed
the
claude/test-readme-quickstart-Ux3ef
branch
from
ff6f554 to
1edf66a
Compare
nishu-builder
force-pushed
the
main
branch
2 times, most recently
from
6c38c63 to
cbd926f
Compare
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
3 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.
Summary
Walking through the Quick Start in
README.mdfrom a fresh environment, everystep past
pip install cogamesis broken. This PR makes the documented commandsactually work end-to-end.
What was broken
cogames play -m arena -p starter -r log -s 300) failed withMission 'arena' not found.— the default game (cogsguard) is registeredas a standalone game but isn't a hard dependency of
cogames, and it isn'tpublished to PyPI (only declared in
[tool.uv.sources]), sopip install cogamesleaves the user with no missions.cogsguardfrom git, the same command then failed withModuleNotFoundError: No module named 'torch'— thestarterpolicy needstorch, which lives in the[neural]extras.--season beta-teams-small, which returnsSeason 'beta-teams-small' not found.cogames season listonly offersbeta-teams-tiny-fixedandbeta-cvc.pip install cogameson a Debian-managed system Python aborts withCannot uninstall PyYAML 6.0.1, RECORD file not found.— easy to hit andnot currently mentioned.
What this PR changes
cogames[neural]pluscogsguard@git+https://github.com/Metta-AI/cogame-cogsguard.gitin all three install paths (pip, uv, Docker). Add
gitto the Dockerapt-get install so the git source resolves.
beta-teams-smallseason name withbeta-teams-tiny-fixedin the three commands in Step 3, and point users at
cogames season list.Verified
Ran the updated install commands in a fresh
uv venvand confirmedcogames play -m arena -p starter -r log -s 50completes successfully andprints the episode stats.
Test plan
confirms
cogames play -m arena -p starter -r log -s 300produces anepisode summary.
beta-teams-tiny-fixedis the season they want topoint new users at (vs. e.g.
beta-cvc).https://claude.ai/code/session_01XTNWKurh2pCerhryCxDf73
Generated by Claude Code