Skip to main content

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. Use load_model() (mlx‑lm) to get (model, tokenizer). For reward‑only code (no generation), a model is not required.
  • Do I need a tokenizer?
    • Yes. Both TextGenerationEnv and TextGenerationEnvironment require a tokenizer. load_model() returns one for mlx‑lm models.
  • How do I control generation?
    • Pass generation_params to create_policy (for example, max_tokens, temperature, top_p, repetition_penalty).
  • What does step() return?
    • A dict with observation, reward, terminated, truncated, info. The runner enforces this.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textpolicy-0.1.7.tar.gz (209.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textpolicy-0.1.7-py3-none-any.whl (175.5 kB view details)

Uploaded Python 3

File details

Details for the file textpolicy-0.1.7.tar.gz.

File metadata

  • Download URL: textpolicy-0.1.7.tar.gz
  • Upload date:
  • Size: 209.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.16

File hashes

Hashes for textpolicy-0.1.7.tar.gz
Algorithm Hash digest
SHA256 be4351c82b7ee6f8c3a4683d1f2144d1ead0ac7031867fefb4e8aa10babf5d66
MD5 7deee546b9a83dea29a01da61193ac81
BLAKE2b-256 473bb6c8e19dc801f78d9cd27dc22b1c32887148bb5708a8543789b05b86af1f

See more details on using hashes here.

File details

Details for the file textpolicy-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: textpolicy-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 175.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.16

File hashes

Hashes for textpolicy-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 cdbc8b2b55a62dcc0658cee6fdb39488fef30dbdb068f18d2c5f06067740433e
MD5 619981a7e96c0c38dc9dfd06806e6c6b
BLAKE2b-256 4f2b3fc83c83fb9effaac06f4254f27f17855e68498e43b35edabd03e5805995

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page