diff --git a/README.md b/README.md index 078849e7f..dd0ffc005 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,16 @@ There's one ALB game right now: Cogs vs Clips. ## Step 1: Install CoGames -Install [cogames](https://pypi.org/project/cogames/) as a Python package. +Install [cogames](https://pypi.org/project/cogames/) as a Python package, along +with the Cogs vs Clips game (`cogsguard`, installed from git) and the `neural` +extras needed to run the `starter` policy. ```bash -pip install cogames +# Use a virtual environment to avoid conflicts with system-managed packages. +python -m venv .venv +source .venv/bin/activate + +pip install "cogames[neural]" +pip install "cogsguard @ git+https://github.com/Metta-AI/cogame-cogsguard.git" ```
Using uv @@ -51,8 +58,9 @@ curl -LsSf https://astral.sh/uv/install.sh | sh uv venv .venv source .venv/bin/activate -# Install cogames -uv pip install cogames +# Install cogames, the neural extras, and the cogsguard game +uv pip install "cogames[neural]" +uv pip install "cogsguard @ git+https://github.com/Metta-AI/cogame-cogsguard.git" ```
@@ -64,11 +72,12 @@ FROM python:3.12-slim # Ensure C/C++ compiler is available RUN apt-get update && \ - apt-get install -y --no-install-recommends build-essential && \ + apt-get install -y --no-install-recommends build-essential git && \ rm -rf /var/lib/apt/lists/* -# Install cogames -RUN pip install --no-cache-dir cogames +# Install cogames, the neural extras, and the cogsguard game +RUN pip install --no-cache-dir "cogames[neural]" \ + "cogsguard @ git+https://github.com/Metta-AI/cogame-cogsguard.git" ``` @@ -111,16 +120,18 @@ Command guide: ```bash cogames create-bundle -p class=cogames.policy.starter_agent.StarterPolicy -o submission.zip cogames upload -p ./submission.zip -n "$USER.README-quickstart-starter-policy" --no-submit - cogames submit "$USER.README-quickstart-starter-policy" --season beta-teams-small + cogames submit "$USER.README-quickstart-starter-policy" --season beta-teams-tiny-fixed ``` 3. Check your submission status. ```bash - cogames submissions --season beta-teams-small --policy "$USER.README-quickstart-starter-policy" - cogames season matches beta-teams-small --limit 5 + cogames submissions --season beta-teams-tiny-fixed --policy "$USER.README-quickstart-starter-policy" + cogames season matches beta-teams-tiny-fixed --limit 5 ``` + Run `cogames season list` to see other open seasons you can submit to. + # Tutorials To learn more, see: diff --git a/pyproject.toml b/pyproject.toml index c8a6b634f..8f838d2cd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ classifiers = [ "Programming Language :: Python :: 3.12", ] dependencies = [ - "mettagrid==0.26.17", + "mettagrid==0.26.19", "softmax-cli==0.26.7", "packaging>=24.0.0", "pydantic>=2.11.5", @@ -89,8 +89,8 @@ testpaths = ["tests"] source = ["cogames"] [tool.uv.sources] -mettagrid = { workspace = true } -softmax-cli = { workspace = true } +mettagrid = {git = "https://github.com/Metta-AI/mettagrid.git"} +softmax-cli = {git = "https://github.com/Metta-AI/softmax-cli.git"} diplomacog = { git = "https://github.com/Metta-AI/cogame-diplomacog.git" } hungercog = { git = "https://github.com/Metta-AI/cogame-hungercog.git" } overcogged = { git = "https://github.com/Metta-AI/cogame-overcogged.git" }