Repository navigation
docs(tutorials): rewrite index as table with Colab badge column #640
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
burtenshaw
merged 7 commits into
openenv:main
from
sergiopaniego:feature/tutorials-index
May 5, 2026
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
dac1f76
docs(tutorials): rewrite tutorials index with per-tutorial descriptions
sergiopaniego 1ce6d1f
docs(tutorials): add Open in Colab column to tutorials index table
sergiopaniego acb8f7c
docs(tutorials): add Colab badge for rubrics tutorial
sergiopaniego 85b680c
docs(tutorials): add Colab badge for MCP tutorial
sergiopaniego 8f3913c
fix(tutorials): fix Wordle GRPO Colab badge URL
sergiopaniego 2fd0f99
Merge branch 'main' into feature/tutorials-index
burtenshaw bc86934
merge main into tutorials index
burtenshaw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,25 @@ | ||
| # Tutorials | ||
|
|
||
| Welcome to the OpenEnv tutorials! These guides will help you get started with using and building environments with OpenEnv. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| If you're new to OpenEnv, we recommend starting with the [Getting Started](/auto_getting_started/index) series to understand the core concepts and basic usage patterns. | ||
|
|
||
| ## Available Tutorials | ||
|
|
||
| - **[OpenEnv Tutorial](openenv-tutorial.md)** - A comprehensive introduction to OpenEnv, covering installation, basic usage, and core concepts. | ||
| - **[Wordle GRPO Training](wordle-grpo.md)** - Learn how to train an agent to play Wordle using Group Relative Policy Optimization (GRPO). | ||
| - **[RL Training with 2048](rl-training-2048.md)** - Train a language model to play 2048 using GRPO reinforcement learning. *(GPU Required)* | ||
| | Tutorial | What it covers | GPU | Notebook | | ||
| |----------|---------------|-----|----------| | ||
| | [OpenEnv Tutorial](openenv-tutorial.md) | Full introduction to OpenEnv: install, connect to a hosted environment, step through an episode, define a reward function, and run a basic training loop. Start here if you're new. | No | [](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/OpenEnv_Tutorial.ipynb) | | ||
| | [Wordle GRPO](wordle-grpo.md) | Train an agent to play Wordle using GRPO via TRL's `environment_factory`. Shows the multi-turn tool-calling loop: the model guesses a word each turn and receives letter-position feedback until it wins or the episode ends. | Yes | [](https://github.com/huggingface/trl/blob/main/examples/notebooks/openenv_wordle_grpo.ipynb) | | ||
| | [RL Training with 2048](rl-training-2048.md) | Train a language model to play the 2048 tile-sliding game with GRPO. Covers game-state representation and reward shaping for a puzzle environment. | Yes | — | | ||
| | [End-to-end walkthrough](end-to-end-walkthrough.md) | The full pipeline in one page: connect to `reasoning_gym`, wire it into TRL via `environment_factory`, fine-tune with GRPO on `chain_sum`, read the reward delta from training logs, and push the checkpoint to the Hub. | Yes | [](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/end_to_end_walkthrough.ipynb) | | ||
| | [SFT warm-up for GRPO](sft-warmup.md) | When a base model's initial reward is near zero, use SFT to bootstrap format compliance before starting RL. Covers: collecting teacher rollouts with `CollectRunner`, filtering by reward, training with `SFTTrainer`, and measuring the before/after delta. | Yes | [](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/sft_warmup.ipynb) | | ||
| | [Rubrics: composable reward computation](rubrics.md) | Build multi-criteria reward functions from reusable primitives (`WeightedSum`, `LLMJudge`, `Gate`). Shows how to compose, weight, and introspect rubrics inside an environment's `step()` method. | No | [](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/rubrics.ipynb) | | ||
| | [MCP tools in OpenEnv environments](mcp-environment.md) | How to use the Model Context Protocol (MCP) tool interface across training, offline eval, and external serving. Covers `ListToolsAction`, `CallToolAction`, and the MCP lifecycle from reset to close. | No | [](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/mcp_environment.ipynb) | | ||
| | [Evaluating agents with Inspect AI](evaluation-inspect.md) | Wrap an OpenEnv environment in an Inspect AI `Task` (dataset + solver + scorer), run it via `InspectAIHarness`, and get a structured `EvalResult` with accuracy scores. No training required — useful as a standalone eval pass on any checkpoint. | No | [](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/evaluation_inspect.ipynb) | | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 2 | ||
| :maxdepth: 1 | ||
| :hidden: | ||
| openenv-tutorial | ||
| wordle-grpo | ||
| rl-training-2048 | ||
| end-to-end-walkthrough | ||
| sft-warmup | ||
| rubrics | ||
| mcp-environment | ||
| evaluation-inspect | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.