Reinforcement learning for text generation on MLX (Apple Silicon): GRPO/GSPO, environments, rollout, rewards, LoRA/QLoRA
Project description
TextPolicy
Reinforcement learning toolkit for text generation on MLX (Apple Silicon). TextPolicy provides algorithms (GRPO/GSPO), text-generation environments, a rollout runner, reward functions with a decorator registry, and LoRA/QLoRA utilities.
Install (uv)
uv add textpolicy
Optional model integration:
uv add mlx mlx-lm
Quickstart
Working example using a real model and tokenizer (mlx-lm required):
import mlx.core as mx
import textpolicy as tp
from textpolicy import load_model, create_policy
from textpolicy.environment.text_generation import TextGenerationEnv
from textpolicy.rollout import RolloutRunner, create_strategy
# 1) Load model and tokenizer (mlx-lm)
model, tokenizer = load_model("Qwen/Qwen3-0.6B")
# 2) Create a policy (controls generation)
generation_params = {"max_tokens": 25, "temperature": 0.7}
policy_fn = create_policy(model, tokenizer, generation_params)
# 3) Define a reward function (env uses this to score responses)
@tp.reward
def length_reward(prompt: str, completion: str, example: dict, **kwargs) -> float:
return float(len(completion.split()))
# 4) Create an environment (requires a tokenizer)
env = TextGenerationEnv(["What is AI?"], length_reward, tokenizer=tokenizer)
# 5) Collect one rollout step
strategy = create_strategy('grpo')
runner = RolloutRunner(env, policy=policy_fn, strategy=strategy, max_steps=1)
buffer = runner.collect()
print(len(buffer.episodes))
Docs:
- Quickstart:
docs/QUICKSTART_UV.md - LoRA/QLoRA:
docs/10_lora_qlora.md - Full index:
docs/index.md
FAQ:
- Do I need a model?
- Yes for generation with
create_policy. Useload_model()(mlx‑lm) to get(model, tokenizer). For reward‑only code (no generation), a model is not required.
- Yes for generation with
- Do I need a tokenizer?
- Yes.
Both
TextGenerationEnvandTextGenerationEnvironmentrequire a tokenizer.load_model()returns one for mlx‑lm models.
- Yes.
Both
- How do I control generation?
- Pass
generation_paramstocreate_policy(for example,max_tokens,temperature,top_p,repetition_penalty).
- Pass
- What does
step()return?- A dict with
observation,reward,terminated,truncated,info. The runner enforces this.
- A dict with
Examples:
- 01–06: reward functions, batch processing, minimal training
- 08: GRPO training with rollout + buffer
- 09–10: length reduction (GRPO/GSPO)
- 11: LoRA/QLoRA configuration
- 12: TinyLoRA + GTPO + HICRA reasoning run (
experiments/countdown_reasoning_lora.py)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file textpolicy-0.1.11.tar.gz.
File metadata
- Download URL: textpolicy-0.1.11.tar.gz
- Upload date:
- Size: 316.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d3f336c905a9944c53678ed62d81f84ae7277ec9fa3791b1e6236121701e14f6
|
|
| MD5 |
5be0ce60d294810f5c6662aab9cfc296
|
|
| BLAKE2b-256 |
754d07872c69d502af0a21e367a42f56c2e1eb66381ee0f8308cc012b69d3754
|
File details
Details for the file textpolicy-0.1.11-py3-none-any.whl.
File metadata
- Download URL: textpolicy-0.1.11-py3-none-any.whl
- Upload date:
- Size: 221.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b1a0030c37a718baf7cc9572f13b2a3f89e234924c53881d6e19b94953c2fc55
|
|
| MD5 |
3dab3eef2276cb26f0e5cfce4b2d319b
|
|
| BLAKE2b-256 |
2c126783f621a3e63598979d5b95b6abed6dfbda39e178df9b696ec1e413fe4c
|