Skip to content

docs(predict-rlm): refresh README developer framing#51

Open
ereinach wants to merge 1 commit into
Trampoline-AI:mainfrom
ereinach:codex/readme-dev-framing
Open

docs(predict-rlm): refresh README developer framing#51
ereinach wants to merge 1 commit into
Trampoline-AI:mainfrom
ereinach:codex/readme-dev-framing

Conversation

@ereinach

@ereinach ereinach commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Rationale

The README should quickly explain why a regular developer would reach for predict-rlm, while avoiding claims that go beyond what the current code supports. This refresh makes the opening more concrete, clarifies good-fit use cases, and tightens feature wording around files, multimodal support, skills, traces, and the SBX extra.

Summary

  • Reframe the README introduction around adaptive LLM workflows and typed runtime execution.
  • Add a "When to use it" section for practical developer fit and non-fit cases.
  • Tighten RLM benefits and feature bullets to match source-verified capabilities.
  • Document the predict-rlm[sbx] extra before using the Docker Sandboxes backend.

Test Plan

  • git diff --check
  • uv run --extra sbx python -c "from predict_rlm import File, PredictRLM, SbxConfig, SbxPool; from predict_rlm.skills import pdf, spreadsheet, docx; print('README API imports ok with sbx extra')"

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant