Skip to content

Document concrete system requirements for running AgentEvolver #7

@arjuntheprogrammer

Description

@arjuntheprogrammer

Problem

  • The public README (README.md:88-127) only mentions “conda” and a “cuda toolkit” before installation, so new users do not know minimum OS, GPU compute capability / VRAM, CPU/RAM, Python/Conda versions, or disk/network expectations before cloning the repo.
  • The detailed QuickStart (docs/tutorial/quick_start.md) likewise describes the command flow without enumerating the hardware/software prerequisites, making it hard to size the environment (especially for AppWorld + ReMe deployments).
  • Without a single “System Requirements” section, contributors must infer requirements from scattered hints or trial and error, slowing onboarding and increasing support load.

Proposal

  1. Add a “System Requirements” section near the top of README.md (and mirror/link it from docs/tutorial/quick_start.md) listing:
    • Supported OSes (tested Ubuntu version, macOS/Windows status if applicable).
    • Required CUDA toolkit + driver versions, minimum GPU memory, and guidance for CPU-only limitations.
    • Recommended CPU cores, RAM, and disk space for AppWorld/ReMe deployments.
    • Required Python/Conda versions and other global dependencies (Docker, tmux, open ports, etc.).
  2. If requirements differ per workflow (basic vs. overall/ReMe), include a table summarizing each scenario.
  3. Cross-link this section from installation scripts / docs so users see it before running install.sh.

Acceptance Criteria

  • README prominently documents hardware/software prerequisites with concrete versions and resource estimates.
  • Docs (e.g., QuickStart) reference the same requirements to keep guidance consistent.
  • New users can determine whether their machine or GPU cluster meets the requirements without executing any scripts.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions