Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
434d2f5
PullRequest: 353 [Lite] Add gradient checkpointing to FSDPEngine
nuzant Jul 14, 2025
d8038b2
PullRequest: 354 [lite] GRPO pre-commit: minor changes in FSDP engine
garrett4wade Jul 14, 2025
724628e
PullRequest: 355 [Lite] GRPO pre-commit 2: Refactor RemoteSGLangEngin…
garrett4wade Jul 14, 2025
8a15551
PullRequest: 357 [lite] GRPO pre-commit 3: Fix typos and experiment u…
garrett4wade Jul 14, 2025
3f95968
PullRequest: 358 [lite] Support GRPO training locally with the GSM8k …
garrett4wade Jul 15, 2025
c75dcaf
merge
garrett4wade Jul 16, 2025
b2bd639
PullRequest: 368 [lite] Refactor train engine after merging contribut…
garrett4wade Jul 16, 2025
b56f599
PullRequest: 371 [lite] [fix] fix misc bugs in GRPO implementation
garrett4wade Jul 16, 2025
ddabd9c
PullRequest: 370 [lite] Add Slurm Launcher and Ray Launcher
nuzant Jul 21, 2025
2f1b679
PullRequest: 392 [lite] Fix several bugs regarding RL learning and ad…
garrett4wade Jul 21, 2025
9c4da33
Merge branch 'lite' of https://github.com/inclusionAI/AReaL into lite
garrett4wade Jul 21, 2025
ab5db3f
.
garrett4wade Jul 21, 2025
4dd4a22
.
garrett4wade Jul 21, 2025
21bd032
PullRequest: 408 [Feature] Bump SGLang version to v0.4.9.post2
garrett4wade Jul 24, 2025
06d9370
PullRequest: 422 [lite] Fix tests and scripts after updating sgl to 0…
garrett4wade Jul 24, 2025
d6dbd90
PullRequest: 423 [lite] Remove the boba example for github release.
garrett4wade Jul 24, 2025
041121d
merge
garrett4wade Jul 24, 2025
be51586
Merge branch 'lite' of https://github.com/inclusionAI/AReaL into lite
garrett4wade Jul 24, 2025
b4b2018
Merge branch 'lite' of https://code.alipay.com/inclusionAI/AReaL into…
garrett4wade Jul 24, 2025
209aec6
update readme
garrett4wade Jul 24, 2025
8750616
Merge branch 'lite' of https://github.com/inclusionAI/AReaL into lite
garrett4wade Jul 24, 2025
86ee687
PullRequest: 431 [Fix] Fix environment of lite
garrett4wade Jul 25, 2025
04c8da4
PullRequest: 440 [FIX] fix update weight from disk
fishcrap Jul 25, 2025
7998055
PullRequest: 442 [lite] Refactor `RemoteSGLangEngine` into two parts:…
nuzant Jul 29, 2025
e825b99
PullRequest: 456 [lite] [Bug] Use `ProcessPoolExecutor` to calculate …
nuzant Jul 31, 2025
7a77fab
PullRequest: 460 [lite][fix] add a warning when reward computation ti…
garrett4wade Jul 31, 2025
7d1c852
PullRequest: 465 [lite][fix] Fix issues raised by tsao
garrett4wade Jul 31, 2025
58395f4
Merge branch 'lite' of https://code.alipay.com/inclusionAI/AReaL into…
garrett4wade Aug 1, 2025
8fb7564
PullRequest: 463 [FEAT] add config converter
fishcrap Aug 1, 2025
a962eb6
PullRequest: 466 [lite] Add seeding in training scripts and pad to ma…
garrett4wade Aug 1, 2025
c9cac38
PullRequest: 467 [lite][fix] remove logging functionality in stats_lo…
garrett4wade Aug 1, 2025
dd44bb7
Merge branch 'lite' of https://code.alipay.com/inclusionAI/AReaL into…
garrett4wade Aug 1, 2025
a4b5073
.
garrett4wade Aug 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 25 additions & 16 deletions docs/contrib.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,41 @@
# Contribution Guide

Thank you for your interest in contributing to AReaL! We welcome contributions from everyone, whether you're fixing bugs, improving documentation, or adding new system and algorithmic features.
Thank you for your interest in contributing to AReaL! We welcome contributions from
everyone, whether you're fixing bugs, improving documentation, or adding new system and
algorithmic features.

## Setting Up Your Development Environment

New contributors do not have write permissions to the official repository. Please fork the repository and clone your fork locally. AReaL is fully Python-based, making installation straightforward.
New contributors do not have write permissions to the official repository. Please fork
the repository and clone your fork locally. AReaL is fully Python-based, making
installation straightforward.

```bash
git clone https://github.com/${your-username}/AReaL
cd AReaL
pip3 install -r requirements.txt
pip3 install -e .
```

## Issue Guidelines

### Issue Templates

Please follow the [issue template on GitHub](https://github.com/inclusionAI/AReaL/tree/main/.github/ISSUE_TEMPLATE). Issues can be:
Please follow the
[issue template on GitHub](https://github.com/inclusionAI/AReaL/tree/main/.github/ISSUE_TEMPLATE).
Issues can be:

- Bug reports
- Feature requests
- Feature requests
- Refactor requests

The required fields in the template help reduce communication overhead when resolving issues. **Issues with arbitrary formatting may be ignored.**
The required fields in the template help reduce communication overhead when resolving
issues. **Issues with arbitrary formatting may be ignored.**

## Pull Request Guidelines

There are no specific PR templates, but **pull requests should be related to a well-templated issue**. Your PR should:
There are no specific PR templates, but **pull requests should be related to a
well-templated issue**. Your PR should:

- Explain how the issue is resolved
- Describe the benefits this change will provide
- Reference the related issue number
Expand All @@ -46,29 +55,29 @@ isort . && black .
AReaL's unit tests are based on the `pytest` framework:

```bash
# Run all tests (excluding GPU tests)
pytest -m "not gpu"

# Run a specific test case
pytest tests/test_something.py
# Run all tests
pytest -s -v areal/tests/
```

**Note**: Running all tests may take several hours to complete.

## Documentation

Writing documentation is an excellent starting point for new contributors. The documentation is located in the `docs` folder and built using [Jupyter Book](https://jupyterbook.org/en/stable/intro.html).
Writing documentation is an excellent starting point for new contributors. The
documentation is located in the `docs` folder and built using
[Jupyter Book](https://jupyterbook.org/en/stable/intro.html).

### Adding New Documentation

1. Create your documentation files in the `docs` folder
2. Add the file path to `docs/_toc.yaml`
3. Build the documentation:
1. Add the file path to `docs/_toc.yaml`
1. Build the documentation:

```bash
jb build docs
```

4. Preview your changes by opening the HTML files in `docs/_build/html`

This process allows you to see how your documentation will appear before submitting your contribution.
This process allows you to see how your documentation will appear before submitting your
contribution.
2 changes: 1 addition & 1 deletion docs/customization/agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Finally, let's complete the implementation by collecting trajectories in the
class MultiTurnWorkflow(RolloutWorkflow):
# ... previous methods ...

async def arun_episode(self, engine: InferenceEngine, data):
async def arun_episode(self, engine: InferenceEngine, data) -> TensorDict:
# ... episode logic above ...

while reward == 0 and t < self.max_turns:
Expand Down