openenv/pr_839/en/_app/immutable/nodes/59.b5ea6ba2.js

import{s as j,n as J,o as Q}from"../chunks/scheduler.2b22cead.js";import{S as K,i as V,e as b,s as o,c as $,h as X,a as f,d as n,b as r,f as z,g as y,j as A,k as D,l as Z,m as a,n as _,t as O,o as T,p as C}from"../chunks/index.1a0e8013.js";import{C as tt,H as W,E as et}from"../chunks/MermaidChart.svelte_svelte_type_style_lang.9d81ac4e.js";function nt(B){let s,E,v,x,i,P,l,k,d,I,c,F="The Getting Started Series walks you from zero to deploying your own environment in five short parts. No GPU required.",L,g,Y='<thead><tr><th>Part</th> <th>What it covers</th> <th>Notebook</th></tr></thead> <tbody><tr><td>1 — Introduction &amp; Quick Start</td> <td>What OpenEnv is, why it exists, and your first environment in under 10 minutes</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/openenv_introduction_quickstart.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td>2 — Using Environments</td> <td>Connect to environments, create policies, run evaluations</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/openenv_using_environments.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td>3 — Building Environments</td> <td>Create a custom environment from scratch</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/openenv_building_environments.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="../getting_started/environment-builder">4 — Packaging &amp; Deploying</a></td> <td>Package with Docker and deploy to Hugging Face</td> <td>—</td></tr> <tr><td><a href="../getting_started/contributing-envs">5 — Contributing to Hugging Face</a></td> <td>Publish, fork, and share environments on the Hub</td> <td>—</td></tr></tbody>',R,h,H,p,q="Already familiar with the basics? These tutorials cover specific workflows in depth.",G,m,U='<thead><tr><th>Tutorial</th> <th>What it covers</th> <th>GPU</th> <th>Notebook</th></tr></thead> <tbody><tr><td><a href="openenv-tutorial">OpenEnv Tutorial</a></td> <td>Full introduction to OpenEnv: install, connect to a hosted environment, step through an episode, define a reward function, and run a basic training loop.</td> <td>No</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/OpenEnv_Tutorial.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="end-to-end-walkthrough">End-to-end walkthrough</a></td> <td>The full pipeline: connect to <code>reasoning_gym</code>, wire it into TRL via <code>environment_factory</code>, fine-tune with GRPO, and push the checkpoint to the Hub.</td> <td>Yes</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/end_to_end_walkthrough.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="mcp-environment">Building and using MCP environments</a></td> <td>Consume and build MCP-backed environments: list and call tools through <code>step()</code>, register Python functions as tools with FastMCP.</td> <td>No</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/mcp_environment.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="rubrics">Rubrics</a></td> <td>Compose reward functions from reusable pieces using <code>Gate</code>, <code>WeightedSum</code>, <code>LLMJudge</code>, and <code>TrajectoryRubric</code>.</td> <td>No</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/rubrics.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="wordle-grpo">Wordle GRPO</a></td> <td>Train an agent to play Wordle using GRPO via TRL’s <code>environment_factory</code>.</td> <td>Yes</td> <td><a href="https://colab.research.google.com/github/huggingface/trl/blob/main/examples/notebooks/openenv_wordle_grpo.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="rl-training-2048">RL Training with 2048</a></td> <td>Train a language model to play 2048 using GRPO. Covers game-state representation and reward shaping.</td> <td>Yes</td> <td>—</td></tr> <tr><td><a href="evaluation-inspect">Evaluating agents with Inspect AI</a></td> <td>Wrap an OpenEnv environment in an Inspect AI <code>Task</code>, run it via <code>InspectAIHarness</code>, and get a structured <code>EvalResult</code>.</td> <td>No</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/evaluation_inspect.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr> <tr><td><a href="browsergym-harness">BrowserGym Harness Rollouts</a></td> <td>Drive BrowserGym through the OpenEnv harness runtime when a trainer needs token sampling, logprobs, and reward assignment inside the training loop.</td> <td>Yes</td> <td>—</td></tr> <tr><td><a href="sft-warmup">Collecting rollouts for supervised training</a></td> <td>Run a teacher model to collect reward-labeled rollouts, filter them, and fine-tune a student with TRL’s <code>SFTTrainer</code> as a warm-start for GRPO.</td> <td>Yes</td> <td><a href="https://colab.research.google.com/github/huggingface/OpenEnv/blob/main/examples/sft_warmup.ipynb" rel="nofollow"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></td></tr></tbody>',M,u,S,w,N;return i=new tt({props:{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"}}),l=new W({props:{title:"Tutorials",local:"tutorials",headingTag:"h1"}}),d=new W({props:{title:"New to OpenEnv? Start Here",local:"new-to-openenv-start-here",headingTag:"h2"}}),h=new W({props:{title:"Topic Tutorials",local:"topic-tutorials",headingTag:"h2"}}),u=new et({props:{source:"https://github.com/huggingface/openenv/blob/main/docs/source/tutorials/index.md"}}),{c(){s=b("meta"),E=o(),v=b("p"),x=o(),$(i.$$.fragment),P=o(),$(l.$$.fragment),k=o(),$(d.$$.fragment),I=o(),c=b("p"),c.textContent=F,L=o(),g=b("table"),g.innerHTML=Y,R=o(),$(h.$$.fragment),H=o(),p=b("p"),p.textContent=q,G=o(),m=b("table"),m.innerHTML=U,M=o(),$(u.$$.fragment),S=o(),w=b("p"),this.h()},l(t){const e=X("svelte-u9bgzb",document.head);s=f(e,"META",{name:!0,content:!0}),e.forEach(n),E=r(t),v=f(t,"P",{}),z(v).forEach(n),x=r(t),y(i.$$.fragment,t),P=r(t),y(l.$$.fragment,t),k=r(t),y(d.$$.fragment,t),I=r(t),c=f(t,"P",{"data-svelte-h":!0}),A(c)!=="svelte-hi2vy3"&&(c.textContent=F),L=r(t),g=f(t,"TABLE",{"data-svelte-h":!0}),A(g)!=="svelte-a9fs9q"&&(g.innerHTML=Y),R=r(t),y(h.$$.fragment,t),H=r(t),p=f(t,"P",{"data-svelte-h":!0}),A(p)!=="svelte-1fnfi0n"&&(p.textContent=q),G=r(t),m=f(t,"TABLE",{"data-svelte-h":!0}),A(m)!=="svelte-wh7ai4"&&(m.innerHTML=U),M=r(t),y(u.$$.fragment,t),S=r(t),w=f(t,"P",{}),z(w).forEach(n),this.h()},h(){D(s,"name","hf:doc:metadata"),D(s,"content",at)},m(t,e){Z(document.head,s),a(t,E,e),a(t,v,e),a(t,x,e),_(i,t,e),a(t,P,e),_(l,t,e),a(t,k,e),_(d,t,e),a(t,I,e),a(t,c,e),a(t,L,e),a(t,g,e),a(t,R,e),_(h,t,e),a(t,H,e),a(t,p,e),a(t,G,e),a(t,m,e),a(t,M,e),_(u,t,e),a(t,S,e),a(t,w,e),N=!0},p:J,i(t){N||(O(i.$$.fragment,t),O(l.$$.fragment,t),O(d.$$.fragment,t),O(h.$$.fragment,t),O(u.$$.fragment,t),N=!0)},o(t){T(i.$$.fragment,t),T(l.$$.fragment,t),T(d.$$.fragment,t),T(h.$$.fragment,t),T(u.$$.fragment,t),N=!1},d(t){t&&(n(E),n(v),n(x),n(P),n(k),n(I),n(c),n(L),n(g),n(R),n(H),n(p),n(G),n(m),n(M),n(S),n(w)),n(s),C(i,t),C(l,t),C(d,t),C(h,t),C(u,t)}}}const at='{"title":"Tutorials","local":"tutorials","sections":[{"title":"New to OpenEnv? Start Here","local":"new-to-openenv-start-here","sections":[],"depth":2},{"title":"Topic Tutorials","local":"topic-tutorials","sections":[],"depth":2}],"depth":1}';function ot(B){return Q(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class lt extends K{constructor(s){super(),V(this,s,ot,nt,j,{})}}export{lt as component};