chore: document and validate AirLLM Apple Silicon requirements in README/CLAUDE.md #1284

Closed
opened 2026-03-24 01:44:21 +00:00 by claude · 1 comment
Collaborator

Context

From screenshot triage (issue #1275).

The project already supports AirLLM (Apple Silicon inference) as an optional backend, but the system requirements and setup path are not documented for users setting up from scratch.

What the Screenshot Shows

A Mac-compatible local LLM setup guide (Artem Andreenko’s port of Karpathy-style autoresearch) specifying:

  • Apple Silicon required (M1, M2, M3, or M4)
  • 16 GB RAM minimum (32 GB recommended for larger experiments)
  • 10–20 GB free disk space
  • Internet connection for initial model download

Current State

CLAUDE.md mentions AirLLM in the Service Fallback Matrix: AirLLM | Import error or no Apple Silicon | Ollama backend. The graceful degradation is implemented, but:

  • No documented minimum hardware requirements
  • No setup guide for enabling AirLLM
  • No config example showing TIMMY_LLM_BACKEND=airllm

Tasks

  • Add a System Requirements section to README.md covering:
    • Minimum specs for AirLLM path (Apple Silicon, 16 GB RAM, ~15 GB disk)
    • Minimum specs for Ollama path (any OS, 8 GB RAM minimum)
  • Add TIMMY_LLM_BACKEND to the documented environment variables in config.py or .env.example
  • Verify AirLLM import guard works correctly on Intel Mac and Linux (falls back to Ollama)
  • Add a unit test asserting AirLLM backend gracefully degrades when not on Apple Silicon

Acceptance Criteria

  • README has a System Requirements section
  • .env.example documents TIMMY_LLM_BACKEND with valid values
  • tox -e unit passes
## Context From screenshot triage (issue #1275). The project already supports AirLLM (Apple Silicon inference) as an optional backend, but the system requirements and setup path are not documented for users setting up from scratch. ## What the Screenshot Shows A Mac-compatible local LLM setup guide (Artem Andreenko’s port of Karpathy-style autoresearch) specifying: - **Apple Silicon required** (M1, M2, M3, or M4) - **16 GB RAM minimum** (32 GB recommended for larger experiments) - **10–20 GB free disk space** - Internet connection for initial model download ## Current State `CLAUDE.md` mentions AirLLM in the Service Fallback Matrix: `AirLLM | Import error or no Apple Silicon | Ollama backend`. The graceful degradation is implemented, but: - No documented minimum hardware requirements - No setup guide for enabling AirLLM - No config example showing `TIMMY_LLM_BACKEND=airllm` ## Tasks - [ ] Add a **System Requirements** section to `README.md` covering: - Minimum specs for AirLLM path (Apple Silicon, 16 GB RAM, ~15 GB disk) - Minimum specs for Ollama path (any OS, 8 GB RAM minimum) - [ ] Add `TIMMY_LLM_BACKEND` to the documented environment variables in `config.py` or `.env.example` - [ ] Verify AirLLM import guard works correctly on Intel Mac and Linux (falls back to Ollama) - [ ] Add a unit test asserting AirLLM backend gracefully degrades when not on Apple Silicon ## Acceptance Criteria - README has a System Requirements section - `.env.example` documents `TIMMY_LLM_BACKEND` with valid values - `tox -e unit` passes
claude was assigned by Timmy 2026-03-24 01:46:44 +00:00
Author
Collaborator

PR created: #1298

Summary of changes:

  • README.md: Added System Requirements section with hardware specs for AirLLM (Apple Silicon M1–M4, 16 GB RAM, ~15 GB disk) and Ollama (any OS, 8 GB RAM) paths
  • config.py: Added "airllm" to timmy_model_backend Literal type (was referenced in docs but rejected by pydantic)
  • agent.py: Added import guard — create_timmy(backend="airllm") logs a warning and falls back to Ollama on non-Apple-Silicon or when airllm is not installed
  • .env.example: Expanded TIMMY_MODEL_BACKEND docs with per-value hardware requirements and install command
  • tests/unit/test_airllm_backend.py: 9 new unit tests — is_apple_silicon() on all platforms + graceful degradation on Intel/Linux/missing-package

tox -e unit passes (507 tests).

PR created: #1298 Summary of changes: - **README.md**: Added `System Requirements` section with hardware specs for AirLLM (Apple Silicon M1–M4, 16 GB RAM, ~15 GB disk) and Ollama (any OS, 8 GB RAM) paths - **config.py**: Added `"airllm"` to `timmy_model_backend` Literal type (was referenced in docs but rejected by pydantic) - **agent.py**: Added import guard — `create_timmy(backend="airllm")` logs a warning and falls back to Ollama on non-Apple-Silicon or when airllm is not installed - **.env.example**: Expanded `TIMMY_MODEL_BACKEND` docs with per-value hardware requirements and install command - **tests/unit/test_airllm_backend.py**: 9 new unit tests — `is_apple_silicon()` on all platforms + graceful degradation on Intel/Linux/missing-package `tox -e unit` passes (507 tests).
claude was unassigned by Timmy 2026-03-24 01:56:16 +00:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Rockachopa/Timmy-time-dashboard#1284