Skip to content

Add a visual Phase 1 walkthrough to the repository landing page #16

Description

@NeoLorenzo

Audit Priority: P2
Audit Type: DOCS

Problem / Opportunity

PolyVision's README explains the current Phase 1 research system in substantial technical detail, but the repository landing page does not show the actual task, policy-visible state, human interaction surface, or representative evaluation output. For a reinforcement-learning project built around a game environment, this makes the first impression unusually abstract: a new reader can understand the architecture diagram and benchmark numbers without seeing what an episode or decision state actually looks like.

Why This Matters

The project now has a mature, tightly specified Phase 1 environment, a human-information-parity interface, frozen reference results, and rendering support. A compact visual walkthrough would make those implemented capabilities much easier to understand and evaluate without requiring readers to reconstruct the experience from the Java/Python architecture and several documentation pages. This is particularly useful for showcasing the distinction between the constrained Turn-10 research task and full-game Polytopia.

Evidence

  • README.md contains a Mermaid architecture diagram and extensive text, but no screenshot, GIF, episode visualization, or representative rendered decision state.
  • pol_env/Tribes/py/gym_env.py already supports ansi, rgb_image/rgb_array, and Java GUI rendering modes, so the repository has an existing path to visualizing environment state.
  • tools/human_policy_interface.py and tools/human_benchmark.py implement the policy-visible human interaction workflow used for information-parity benchmarking.
  • README.md already reports the frozen v5 reference benchmark and links detailed evaluation artifacts, but does not visually connect those results to the task being evaluated.
  • No current open issue substantially represents repository presentation or a visual project walkthrough.

Proposed Outcome

Add a concise visual Phase 1 walkthrough near the top of the README using repository-owned/generated assets that show the current implemented task rather than an aspirational full-game system. The walkthrough should make it immediately clear what the agent sees/does, what the Turn-10 objective is, and what current evaluation output looks like.

Definition of Done

  • The README includes at least one representative visual of a current Phase 1 decision state or episode using the maintained environment/human interface.
  • The visual is accompanied by concise annotations explaining the constrained Bardur Turn-10 task, legal-action interface, and primary Turn-10 SPT objective.
  • The presentation includes a compact visual or table derived from the current frozen reference evidence so readers can connect the task to actual measured performance.
  • Assets are stored/generated in a reproducible, repository-appropriate way and do not depend on private or ephemeral external hosting.
  • The walkthrough clearly avoids implying that PolyVision currently supports combat, opponents, multiple tribes, or full-game play.
  • Existing detailed technical documentation remains the source for protocol and implementation details rather than being duplicated wholesale in the README.

Constraints / Non-Goals

This is a presentation/documentation improvement, not a request to build a new renderer, redesign the human benchmark UI, change the research protocol, or expand the Phase 1 curriculum. Prefer current repository rendering/interface capabilities and existing frozen evidence over bespoke visualization infrastructure.

Validation

Review the repository landing page as a first-time reader and verify that the current task, interaction model, and benchmark result can be understood from the opening sections without first navigating into implementation files or long-form research documents.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions