Skip to content

Commit 8b978b1

Browse files
binary-huskyclaude
andcommitted
Document ajet-swarm top as alias for ajet-swarm overwatch
Add mentions of the `ajet-swarm top` alias across documentation to help users discover this shorter alternative command. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 1bb02c8 commit 8b978b1

8 files changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Let's begin with the simplest example: a math agent with a tool call. This is a
4747

4848
Let's begin with the simplest AgentJet Swarm example: also a math agent. In this case, you can use any GPU-less laptop to train the model remotely.
4949

50-
1. Start swarm server and begin swarm overwatch: `ajet-swarm start` and `ajet-swarm overwatch`. (Alternative: if you are a fan of docker, use our [prebuilt docker image here](docs/en/ajet-swarm-docker.md) without setting up dependencies)
50+
1. Start swarm server and begin swarm overwatch: `ajet-swarm start` and `ajet-swarm overwatch` (or `ajet-swarm top`). (Alternative: if you are a fan of docker, use our [prebuilt docker image here](docs/en/ajet-swarm-docker.md) without setting up dependencies)
5151
2. From your laptop (or swarm server localhost), run [this simple script](https://github.com/modelscope/AgentJet/blob/main/tutorial/example_math_swarm/math.py) to begin training:
5252
```python
5353
AJET_SWARM_URL="http://swarm-server-ip:10086" python ./tutorial/example_math_swarm/math.py

docs/en/ajet-swarm-docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The command launches two background processes with `&`:
7070

7171
| Process | What it does |
7272
|---|---|
73-
| `ajet-swarm overwatch` | Starts the **real-time TUI monitor** in the foreground. Displays the current server state (OFFLINE / BOOTING / ROLLING / WEIGHT_SYNCING), active episodes, and rollout statistics. |
73+
| `ajet-swarm overwatch` | Starts the **real-time TUI monitor** in the foreground. Displays the current server state (OFFLINE / BOOTING / ROLLING / WEIGHT_SYNCING), active episodes, and rollout statistics. Tip: `ajet-swarm top` is an alias. |
7474
| `ajet-swarm start` | Starts the **Swarm Server** itself — initializes VERL training loop, vLLM inference engine, and the FastAPI HTTP server on port `10086`. |
7575
| `NO_COLOR=1 LOGURU_COLORIZE=NO` | Disables ANSI color codes in the server log so the log file `swarm_server.log` is readable as plain text. |
7676
| `&>/workspace/log/swarm_server.log` | Redirects both stdout and stderr of the server process to the log file (which is persisted to your host machine via the volume mount). |

docs/en/swarm.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Notes:
3838
```bash
3939
ajet-swarm overwatch --swarm-url=http://localhost:10086
4040
```
41+
Tip: `ajet-swarm top` is an alias for `ajet-swarm overwatch`.
4142

4243
3. changing customized port (default port is 10086):
4344
```bash

docs/en/swarm_best_practice.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ everything need to begin from bring the swarm server alive.
1515
We recommend launching server together with a swarm monitor:
1616
```bash
1717
# this command start swarm server and a TUI to monitor the swarm server
18+
# tip: ajet-swarm top is an alias for ajet-swarm overwatch
1819
(ajet-swarm start &> ajet-swarm-server.log) & (ajet-swarm overwatch)
1920
```
2021

docs/en/swarm_deepdive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Practical tips:
117117

118118
- **Treat YAML as the source of truth**: you can inspect it with `yaml_job.dump_job_as_yaml("./config.yaml")` and load overrides via `yaml_job.build_job_from_yaml("./config.yaml")`.
119119
- **Idempotency**: `auto_sync_train_config_and_start_engine()` is designed to be safe if the engine is already **ROLLING** (it will do nothing) and will wait if the engine is **BOOTING / WEIGHT_SYNCING**.
120-
- **Monitoring**: run `ajet-swarm overwatch --swarm-url=http://your-swarm-server:10086` (or `python -m ajet.launcher --swarm-overwatch=...`) to watch the server states and rollout pool.
120+
- **Monitoring**: run `ajet-swarm overwatch --swarm-url=http://your-swarm-server:10086` (or `ajet-swarm top`, which is an alias) to watch the server states and rollout pool.
121121
- **Full AgentJetJob arguments**: run `help(AgentJetJob)` or check `ajet/copilot/job.py` for all available parameters including `max_prompt_length`, `max_response_length`, `max_model_len`, `mini_batch_num`, `lora_rank`, `lora_alpha`, `lora_target_modules`, and more.
122122

123123
### Episode Running

docs/en/swarm_workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ A swarm workflow has three phases per training step:
7676
```bash
7777
# Start server + TUI monitor (in two terminals, or combined):
7878
ajet-swarm start &
79-
ajet-swarm overwatch
79+
ajet-swarm overwatch # or: ajet-swarm top
8080
```
8181

8282
The server starts with `ajet_swarm_default.yaml` (see [Swarm Mode Config Chain](../configuration/#swarm-mode-config-chain)). No `--conf` is needed for the default setup.

docs/en/tune_your_first_agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,7 @@ On your GPU machine (or cluster), start the Swarm Server:
463463
ajet-swarm start
464464

465465
# Open the monitoring dashboard in another terminal
466+
# tip: ajet-swarm top is an alias for ajet-swarm overwatch
466467
ajet-swarm overwatch --swarm-url=http://localhost:10086
467468
```
468469

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Let's begin with the simplest example: a math agent with a tool call. This is a
3333

3434
Let's begin with the simplest AgentJet Swarm example: also a math agent. In this case, you can use any GPU-less laptop to train the model remotely.
3535

36-
1. Start swarm server and begin swarm overwatch: `ajet-swarm start` and `ajet-swarm overwatch`. (Alternative: if you are a fan of docker, use our [prebuilt docker image here](en/ajet-swarm-docker.md) without setting up dependencies)
36+
1. Start swarm server and begin swarm overwatch: `ajet-swarm start` and `ajet-swarm overwatch` (or `ajet-swarm top`). (Alternative: if you are a fan of docker, use our [prebuilt docker image here](en/ajet-swarm-docker.md) without setting up dependencies)
3737
2. From your laptop (or swarm server localhost), run [this simple script](https://github.com/modelscope/AgentJet/blob/main/tutorial/example_math_swarm/math.py) to begin training:
3838
```python
3939
AJET_SWARM_URL="http://swarm-server-ip:10086" python ./tutorial/example_math_swarm/math.py

0 commit comments

Comments
 (0)