Skip to content

Commit 0970f5a

Browse files
committed
Fix small issues on README and other documents.
Signed-off-by: Felipe Vieira Frujeri <[email protected]>
1 parent ed6752a commit 0970f5a

File tree

6 files changed

+16
-7
lines changed

6 files changed

+16
-7
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ We're excited about contributions that expand NeMo Gym's capabilities and improv
6565
git clone [email protected]:NVIDIA-NeMo/Gym.git
6666
cd Gym
6767
curl -LsSf https://astral.sh/uv/install.sh | sh
68-
source $HOME/.local/bin/env
68+
export PATH=$HOME/.local/bin/env/bin:$PATH # or
69+
# echo 'export PATH=$HOME/.local/bin/env/bin:$PATH' >> ~/.bashrc
6970
uv venv --python 3.12
7071
source .venv/bin/activate
7172
uv sync --extra dev --group docs

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ cd Gym
2525

2626
# Install dependencies
2727
curl -LsSf https://astral.sh/uv/install.sh | sh
28-
source $HOME/.local/bin/env
28+
export PATH=$HOME/.local/bin/env/bin:$PATH # or
29+
# echo 'export PATH=$HOME/.local/bin/env/bin:$PATH' >> ~/.bashrc
2930
uv venv --python 3.12 && source .venv/bin/activate
3031
uv sync --extra dev --group docs
3132

@@ -59,7 +60,7 @@ python responses_api_agents/simple_agent/client.py
5960
**Terminal 2** (keep servers running in Terminal 1):
6061
```bash
6162
# Create a simple dataset with one query
62-
echo '{"responses_create_params":{"input":[{"role":"developer","content":"You are a helpful assistant."},{"role":"user","content":"What is the weather in Seattle?"}]}}' > weather_query.jsonl
63+
echo '{"responses_create_params":{"input":[{"role":"developer","content":"You are a helpful assistant."},{"role":"user","content":"What is the weather in Seattle?"}],"tools":[{"type":"function","name":"get_weather","description":"","parameters":{"type":"object","properties":{"city":{"type":"string","description":""}},"required":["city"],"additionalProperties":false},"strict":true}]}}' > weather_query.jsonl
6364

6465
# Collect verified rollouts
6566
ng_collect_rollouts \

docs/get-started/setup-installation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ cd Gym
3535

3636
# Install UV (Python package manager)
3737
curl -LsSf https://astral.sh/uv/install.sh | sh
38-
source $HOME/.local/bin/env
38+
export PATH=$HOME/.local/bin/env/bin:$PATH # or
39+
# echo 'export PATH=$HOME/.local/bin/env/bin:$PATH' >> ~/.bashrc
3940

4041
# Create virtual environment
4142
uv venv --python 3.12

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# NeMo Gym Documentation
44

5-
NeMo Gym is a framework for building reinforcement learning (RL) training environments large language models (LLMs). Gym provides training environment development scaffolding and training environment patterns such as multi-step, multi-turn, and user modeling scenarios.
5+
NeMo Gym is a framework for building reinforcement learning (RL) training environments for large language models (LLMs) based Agents. Gym provides training environment development scaffolding and training environment patterns such as multi-step, multi-turn, and user modeling scenarios.
66

77
At the core of NeMo Gym are three server concepts: **Responses API Model servers** are model endpoints, **Resources servers** contain tool implementations and verification logic, and **Response API Agent servers** orchestrate the interaction between models and resources.
88

@@ -21,7 +21,8 @@ cd Gym
2121

2222
# Install UV if not already available
2323
curl -LsSf https://astral.sh/uv/install.sh | sh
24-
source $HOME/.local/bin/env
24+
export PATH=$HOME/.local/bin/env/bin:$PATH # or
25+
# echo 'export PATH=$HOME/.local/bin/env/bin:$PATH' >> ~/.bashrc
2526

2627
# Create a virtual environment and install Gym
2728
uv venv --python 3.12 && source .venv/bin/activate
@@ -64,7 +65,7 @@ python responses_api_agents/simple_agent/client.py
6465

6566
```bash
6667
# Create a simple dataset with one query
67-
echo '{"responses_create_params":{"input":[{"role":"developer","content":"You are a helpful assistant."},{"role":"user","content":"What is the weather in Seattle?"}]}}' > weather_query.jsonl
68+
echo '{"responses_create_params":{"input":[{"role":"developer","content":"You are a helpful assistant."},{"role":"user","content":"What is the weather in Seattle?"}],"tools":[{"type":"function","name":"get_weather","description":"","parameters":{"type":"object","properties":{"city":{"type":"string","description":""}},"required":["city"],"additionalProperties":false},"strict":true}]}}' > weather_query.jsonl
6869

6970
# Collect verified rollouts
7071
ng_collect_rollouts \

nemo_gym/rollout_collection.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,7 @@ def collect_rollouts(): # pragma: no cover
143143
rch = RolloutCollectionHelper()
144144

145145
asyncio.run(rch.run_from_config(config))
146+
147+
148+
if __name__ == "__main__":
149+
collect_rollouts()

responses_api_agents/simple_agent/client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"content": "You are a helpful personal assistant that aims to be helpful and reduce any pain points the user has.",
3131
},
3232
{"role": "user", "content": "going out in sf tn"},
33+
# {"role": "user", "content": "What is the weather in San Francisco?"}, # If you want to force the weather tool call, uncomment this line
3334
],
3435
tools=[
3536
{

0 commit comments

Comments
 (0)