Skip to content

Commit cb215d9

Browse files
committed
update quickstart example
1 parent 11fdc80 commit cb215d9

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,12 @@ uv init && uv venv --python 3.12 # change version as needed
5353
uv pip install -e .
5454
```
5555

56-
To run a quick test, make sure your `OPENAI_API_KEY` is set properly and run the following:
56+
To run a quick test, the following will run an RLM query with the OpenAI client using your environment variable `OPENAI_API_KEY` (feel free to change this). This will generate console output as well as a log which you can use with the visualizer to explore the trajectories.
5757
```bash
58-
cd examples/
59-
uv run quickstart.py
58+
uv run examples/quickstart.py
6059
```
6160

62-
This will generate console output as well as a log which you can use with the visualizer to explore the trajectories.
63-
64-
65-
## REPL Environments
66-
The default RLM object uses a REPL environment that runs on the host process through Python `exec` calls. It uses the same virtual environment as the host process (i.e. it will have access to the same dependencies), but with some limitations in its available global modules. As an example, we can call RLM completions using GPT-5-nano with the Portkey client:
61+
The default RLM client uses a REPL environment that runs on the host process through Python `exec` calls. It uses the same virtual environment as the host process (i.e. it will have access to the same dependencies), but with some limitations in its available global modules. As an example, we can call RLM completions using GPT-5-nano:
6762
```python
6863
from rlm import RLM
6964

@@ -76,6 +71,7 @@ rlm = RLM(
7671
print(rlm.completion("Print me the first 100 powers of two, each on a newline.").response)
7772
```
7873

74+
## REPL Environments
7975
We support two types of REPL environments -- isolated, and non-isolated. Non-isolated environments (default) run code execution on the same machine as the RLM (e.g. through `exec`), which is pretty reasonable for some local low-risk tasks, like simple benchmarking, but can be problematic if the prompts or tool calls can interact with malicious users. Fully isolated environments used Cloud-based sandboxes (e.g. Prime Sandboxes, [Modal Sandboxes](https://modal.com/docs/guide/sandboxes)) to run code generated by the RLM, ensuring completely isolation from the host process. Environments can be added, but we natively support the following: `local` (default), `modal`, `prime`.
8076

8177
```python

0 commit comments

Comments
 (0)