Local Development

pip install openreward

# server.py
from openreward.environments import Environment, Server, Split, TextBlock, ToolOutput, tool
from pydantic import BaseModel

class AnswerParams(BaseModel):
    answer: str

class MyEnvironment(Environment):
    """A simple math environment"""

    @classmethod
    def list_tasks(cls, split: str):
        return [
            {"id": "task-1", "problem": "What is 2+2?", "answer": 4},
            {"id": "task-2", "problem": "What is 5*3?", "answer": 15},
        ]

    @classmethod
    def list_splits(cls):
        return [Split(name="train", type="train"), Split(name="test", type="test")]

    def get_prompt(self):
        return [TextBlock(type="text", text=self.task_spec["problem"])]

    @tool
    def answer(self, params: AnswerParams) -> ToolOutput:
        """Submit your answer"""
        correct = str(self.task_spec["answer"]) == params.answer
        return ToolOutput(
            blocks=[TextBlock(type="text", text="Correct!" if correct else "Wrong!")],
            reward=1.0 if correct else 0.0,
            finished=True
        )

if __name__ == "__main__":
    Server([MyEnvironment]).run()

python server.py

INFO:     Started server process [12345]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8080

# test_environment.py
from openreward import OpenReward

or_client = OpenReward(base_url="http://localhost:8080") # you must point towards the environment if running locally

# Connect to local server (no namespace = localhost)
environment = or_client.environments.get(name="myenvironment")

# List tasks
tasks = environment.list_tasks(split="train")
print(f"Found {len(tasks)} tasks")

# Create session and test tool
with environment.session(task=tasks[0]) as session:
    prompt = session.get_prompt()
    print(f"Prompt: {prompt[0].text}")

    result = session.call_tool("answer", {"answer": "4"})
    print(f"Result: {result.blocks[0].text}")
    print(f"Reward: {result.reward}")

environment = or_client.environments.get(name="myenvironment", base_url="http://localhost:8080")

python test_environment.py

Found 2 tasks
Prompt: What is 2+2?
Result: Correct!
Reward: 1.0

# Build Docker image
docker build -t my-environment:local .

# Run container
docker run -p 8080:8080 my-environment:local

# Test from another terminal
python test_environment.py