Skip to content

Commit 0b13540

Browse files
committed
fix invalid urls
1 parent 0142ccf commit 0b13540

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ We aim to build a easy-to-learn Agent tuner that unlock more possibilities for a
3939
- **Easy and Friendly**. AgentJet helps you tune models behind your agent workflows easily, optimizing your agents for top performance with minimal effort.
4040
- **Rich Tutorial Library**. AgentJet provides a rich library of [examples](https://github.com/modelscope/AgentJet/tree/main/tutorial) as tutorials.
4141
- **Efficient and Scalable**. AgentJet uses [verl] as the default backbone (`--backbone=verl`). However, we also support [trinity](https://github.com/modelscope/Trinity-RFT/) as alternative backbone, accelerating your tuning process via fully asynchronous RFT.
42-
- **Flexible and Fast**. AgentJet supports [multi-agent workflows](https://modelscope.github.io/AgentJet/en/workflow.md) and adopts a context merging technique, accelerating training by 1.5x to 10x when the workflow involves multi-turn (or multi-agent) conversations.
42+
- **Flexible and Fast**. AgentJet supports [multi-agent workflows](https://modelscope.github.io/AgentJet/en/workflow/) and adopts a context merging technique, accelerating training by 1.5x to 10x when the workflow involves multi-turn (or multi-agent) conversations.
4343
- **Reliability and Reproducibility**. Our team keeps track of framework performance across multiple [tasks + major-git-version + training-backbones](https://benchmark.agent-matrix.com/) (under construction, still gathering data, coming soon).
4444

4545
For advanced researchers, AgentJet also provides high-resolution logging and debugging solutions:
@@ -113,7 +113,7 @@ The internal system orchestrates several specialized modules to handle the compl
113113

114114
* **Tutorials**: From [Installation](https://modelscope.github.io/AgentJet/en/installation) to [Tuning your first agent](https://modelscope.github.io/AgentJet/en/tune_your_first_agent) — the essential path for beginners.
115115
* **Core Components**: Define your [Trainable Workflow](https://modelscope.github.io/AgentJet/en/workflow) and manage [Data](https://modelscope.github.io/AgentJet/en/data_pipeline) and [Reward](https://modelscope.github.io/AgentJet/en/task_judger).
116-
* **Example**: Check the [Example Library](#example-library) above for real-world cases like [Math](https://modelscope.github.io/AgentJet/en/example_math_agent), [Werewolves game](https://modelscope.github.io/AgentJet/en/example_werewolves) and [Learning to ask task](https://modelscope.github.io/AgentJet/en/example_learning_to_ask).
116+
* **Example**: Check the [Example Library](https://modelscope.github.io/AgentJet/#example-library) above for real-world cases like [Math](https://modelscope.github.io/AgentJet/en/example_math_agent), [Werewolves game](https://modelscope.github.io/AgentJet/en/example_werewolves) and [Learning to ask task](https://modelscope.github.io/AgentJet/en/example_learning_to_ask).
117117
* **Deep Dive**: Master advanced [Configuration](https://modelscope.github.io/AgentJet/en/configuration).
118118

119119
## ✈️ Roadmap
@@ -151,5 +151,5 @@ If you use AgentJet in your research, please cite:
151151
---
152152
<div align="center">
153153

154-
[⭐ Star Us](https://github.com/modelscope/AgentJet) · [🐛 Report Bug](https://github.com/modelscope/AgentJet/issues) · [💡 Request Feature](https://github.com/modelscope/AgentJet/issues)
154+
[⭐ Star Us](https://github.com/modelscope/AgentJet) · [Report Bug](https://github.com/modelscope/AgentJet/issues) · [Request Feature](https://github.com/modelscope/AgentJet/issues)
155155
</div>

docs/en/example_math_agent.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,14 @@ Most wiring happens in `tutorial/example_math_agent/math_agent.yaml`:
185185
```
186186

187187

188+
!!! warning "user_workflow assignment"
189+
- As you have noticed, `user_workflow: tutorial.example_math_agent.math_agent_langchain->ExampleMathLearn` means, AgentJet will try to import `ExampleMathLearn` from `${WorkingDir}/tutorial/example_math_agent/math_agent_langchain.py`. (**Dot import**)
190+
- If you prefer absolute path, or you workflow is not in python search path, you can also use the alternative way to import your workflow `user_workflow: /path/to/ajet/tutorial/example_math_agent/math_agent_langchain.py->ExampleMathLearn`. (**Path import**)
191+
- Both **dot import** (dot-to-module) and **path import** (path-to-source-code) is good. But **dot import** is recommended as it is more pythonic.
192+
193+
194+
195+
188196
| Field | Description |
189197
|-------|-------------|
190198
| `task_reader` | Where tasks come from |

docs/en/installation.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ cd AgentJet
2828

2929
### Step 2: Install Dependencies
3030

31-
AgentJet supports multiple backbones. Currently we have `verl` and `trinity` (recommended).
31+
AgentJet supports multiple backbones, you can choose any of them depending on your requirements, or choose all of them to compare the performance. Currently we have `verl` and `trinity`.
3232

3333
!!! info "Package Manager"
3434
We recommend using `uv` to manage your Python environment as it is incredibly fast. See also [`uv` installation document](https://docs.astral.sh/uv/getting-started/installation/).
@@ -49,7 +49,8 @@ AgentJet supports multiple backbones. Currently we have `verl` and `trinity` (re
4949
```
5050

5151
!!! warning "flash-attn Installation"
52-
`flash-attn` must be installed after other dependencies. To build faster, export `MAX_JOBS=${N_CPU}`, or ensure a healthy connection to GitHub to install pre-compiled wheels.
52+
- `flash-attn` must be installed **after** other dependencies.
53+
- If you find your machine spend a long time installing flash-attn, ensure a healthy connection to GitHub.
5354

5455
=== "VERL (conda)"
5556

@@ -64,8 +65,10 @@ AgentJet supports multiple backbones. Currently we have `verl` and `trinity` (re
6465
pip install --verbose flash-attn --no-deps --no-build-isolation --no-cache
6566
```
6667

68+
6769
!!! warning "flash-attn Installation"
68-
`flash-attn` must be installed after other dependencies. To build faster, export `MAX_JOBS=${N_CPU}`, or ensure a healthy connection to GitHub to install pre-compiled wheels.
70+
- `flash-attn` must be installed **after** other dependencies.
71+
- If you find your machine spend a long time installing flash-attn, ensure a healthy connection to GitHub.
6972

7073

7174
=== "VERL (aliyun)"

0 commit comments

Comments
 (0)