Skip to content

Update and simplify tutorial#383

Open
sergiopaniego wants to merge 5 commits intometa-pytorch:mainfrom
sergiopaniego:update-tutorial
Open

Update and simplify tutorial#383
sergiopaniego wants to merge 5 commits intometa-pytorch:mainfrom
sergiopaniego:update-tutorial

Conversation

@sergiopaniego
Copy link
Contributor

@sergiopaniego sergiopaniego commented Feb 16, 2026

Summary

This PR updates and simplifies the tutorial both the notebook and doc page.
The new structure tries to be more direct in showing the main features and links to additional content for more details.

The new tutorial needs to be run with updated envs since it uses async so, although I have tested it using updated envs that pull OpenEnv from main, that would need to be updated for it to work

Could depend on #293

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation
  • New environment
  • Refactoring

Alignment Checklist

Before submitting, verify:

  • I have read .claude/docs/PRINCIPLES.md and this PR aligns with our principles
  • I have checked .claude/docs/INVARIANTS.md and no invariants are violated
  • I have run /pre-submit-pr (or bash .claude/hooks/lint.sh and tests) and addressed all issues

RFC Status

  • Not required (bug fix, docs, minor refactoring)
  • RFC exists: #___
  • RFC needed (will create before merge)

Test Plan

Running the notebook! :)

Claude Code Review

"N/A"

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Feb 16, 2026
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 16, 2026

Greptile Summary

Simplified and modernized the OpenEnv tutorial, reducing content from ~1260 lines to 220 lines while maintaining essential information. The new structure is more direct and focuses on practical getting-started content.

Major changes:

  • Removed verbose multi-part tutorial structure with extensive explanations
  • Eliminated in-notebook demo code execution (number guessing game, policy comparisons)
  • Replaced OpenSpiel-focused examples with modern environments (Echo, Wordle, BrowserGym)
  • Streamlined to focus on: installation, architecture overview, environment usage, deployment, and integration
  • Updated links to use relative markdown paths for docs, absolute URLs for external notebooks
  • Maintained all critical information: Gymnasium API, Docker isolation, type safety, HuggingFace deployment

Benefits:

  • Faster onboarding - users can start in minutes vs reading extensive theory
  • More actionable - links to deeper guides for those who need them
  • Better reflects current OpenEnv ecosystem with updated environment examples
  • Easier to maintain - less content to keep synchronized

Confidence Score: 5/5

  • This PR is completely safe to merge - documentation-only changes with no code modifications
  • Documentation-only PR with no code changes, no security concerns, no invariant violations. The simplification improves user experience by making the tutorial more direct and actionable. All code examples use valid async syntax and reference real deployed environments.
  • No files require special attention

Important Files Changed

Filename Overview
docs/tutorials/openenv-tutorial.md Simplified tutorial from 1260 lines to 220 lines - removed verbose explanations and demo code, replaced with concise getting-started content and direct environment examples
examples/OpenEnv_Tutorial.ipynb Mirrored markdown simplification - condensed from elaborate multi-part tutorial to focused quick-start notebook with practical environment usage examples

Last reviewed commit: b8ec925

Copy link
Collaborator

@burtenshaw burtenshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks nice to me. But I'll let @init27 review the notebook as the author.

@burtenshaw burtenshaw requested a review from init27 February 16, 2026 18:39
Copy link
Contributor

@init27 init27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much for updating this @sergiopaniego!

Actually, I would request keeping the old style, since the notebook is designed to be an e2e onboarding for RL + OpenEnv.

Based on the 8-9 workshops we have done in-person, my experience is the audience generally still requires an onboard to RL so I would prefer keeping the concepts and onboarding in there please.

@burtenshaw
Copy link
Collaborator

Thanks for the feedback @init27

@sergiopaniego Could we focus the PR on just the md docs example? I think there it makes sense to have a more concise page to bootstrap users' projects.

Copy link
Collaborator

@burtenshaw burtenshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the docs changes look good. LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants