Skip to main content

Release SDK — RL Environments as a Service by Centific

Project description

rleaas — Release SDK

Python SDK for the Release (RLEaaS) platform by Centific — RL Environments as a Service.

Installation

pip install rleaas

API Key

Setup API key needed? How to get it
Local dev server (http://localhost:8000) No Run the AgentWork-Simulator locally — no auth required
Hosted / production Yes Log in to the Release dashboard → Settings → API Keys → create a key

Set the key as an environment variable so you never hardcode it:

export RLEAAS_API_KEY="rleaas_sk_your_key_here"

The SDK reads it automatically:

import rleaas

client = rleaas.Client()                          # reads RLEAAS_API_KEY from env
# or
client = rleaas.Client(api_key="rleaas_sk_...")   # pass explicitly

Local development (no key required)

import rleaas

client = rleaas.Client(base_url="http://localhost:8000")
print(client.ping())
# {'message': 'RL Environment & Agent API', 'version': '1.0.0', ...}

Sub-clients

Attribute Purpose
client.Environment Create and manage simulation environments
client.Tools Register and configure agent tools
client.Agent Register and export trained agents
client.Verifier Define scoring verifiers (rule-based, LLM judge, composite)
client.Scenario Create and browse training scenarios
client.ScenarioSuite Organize scenarios into training/evaluation suites
client.TrainingJob Launch and monitor GRPO/PPO/DQN/A2C training runs
client.Evaluation Run evaluations and retrieve rollouts
client.Metrics Query KPIs and training metrics
client.AuditLog Access audit logs and governance configuration

Example

import rleaas

client = rleaas.Client()   # reads RLEAAS_API_KEY from environment

# Create environment
env = client.Environment.create(name="FinSim-Prod-v1", vertical="FinSim")
env.wait_until_ready()

# Create verifier
rule_v = client.Verifier.create(
    name="AML Compliance Check",
    verifier_type="rule_based",
    environment="FinSim-Prod-v1",
    config={
        "conditions": ["'run_aml_check' in trajectory.tool_calls"],
        "condition_logic": "AND",
        "reward_on_pass": 1.0,
        "reward_on_fail": 0.0,
    },
)

# Train
job = client.TrainingJob.run(
    environment_name="FinSim-Prod-v1",
    algorithm="GRPO",
    config={"episodes": 10000, "max_steps_per_episode": 20},
    verifier_ids=[rule_v.id],
)
job.wait_until_complete()
best = job.get_best_checkpoint()

# Evaluate
eval_job = client.Evaluation.run(
    agent_checkpoint_id=best["id"],
    scenario_suite_id="suite_eval_01",
    verifier_ids=[rule_v.id],
)
report = eval_job.wait_until_complete()
print(report["overall_score"])

Examples

Clone or download the examples/ folder and run them in order:

File What it shows
examples/quickstart.py Connect, ping, list environments and tools
examples/create_environment.py Create env → verifier → scenarios → suites
examples/verifiers.py All 4 verifier types (rule, trajectory, LLM, composite)
examples/train_agent.py Launch GRPO training, monitor progress, get best checkpoint
examples/evaluate_agent.py Run evaluation, compare rollouts, export audit report
# Install the SDK
pip install rleaas

# Run examples against a local server
python examples/quickstart.py
python examples/create_environment.py
python examples/verifiers.py
python examples/train_agent.py
python examples/evaluate_agent.py

Async support

async with rleaas.AsyncClient() as client:
    status = await client.ping()

License

MIT

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

rleaas-1.0.3.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

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

rleaas-1.0.3-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file rleaas-1.0.3.tar.gz.

File metadata

  • Download URL: rleaas-1.0.3.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for rleaas-1.0.3.tar.gz
Algorithm Hash digest
SHA256 5e2d352d82b4771772c3d274a9b7954655289201cf426794f68f81e7d5731e48
MD5 50bcd556063b92a071b2cd32aad785de
BLAKE2b-256 c14de57e2ab53caa33efcd9576105a0de91e8095122d9edb4135d78b05dbd837

See more details on using hashes here.

File details

Details for the file rleaas-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: rleaas-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for rleaas-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 76edcd00f69e3fc3a2fdd87e37d8fe16de693dcd8556c9f2ded55fd826841f00
MD5 f7480a0f95626656a161ce299a681a82
BLAKE2b-256 503a2e175636a639713146baa792c10a16e33dfeea2efe1713e1a858033158f6

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