openenv/pr_769/en/_app/immutable/nodes/38.4eefdf93.js

import{s as We,n as ke,o as Ge}from"../chunks/scheduler.2b22cead.js";import{S as Ye,i as Ze,e as m,s,c as o,h as Qe,a as u,d as t,b as a,f as Ie,g as i,j as y,k as ve,l as Be,m as l,n as p,t as r,o as c,p as M}from"../chunks/index.1a0e8013.js";import{C as Ve,H as N}from"../chunks/Heading.d790660c.js";import{C as w}from"../chunks/CodeBlock.e14858ae.js";import{E as Xe}from"../chunks/MermaidChart.svelte_svelte_type_style_lang.5a0abd61.js";function _e(fe){let h,F,x,H,d,z,v,q,f,be="Install OpenEnv, load an environment, and run your first step.",L,b,K,J,P,j,Je=`<p>This installs the <code>openenv</code> CLI and the <code>openenv.core</code> runtime. Environment
projects can depend on <code>openenv[core]</code> when they only need the server and
client libraries.</p>`,O,$,D,T,$e=`Use <code>AutoEnv</code> and <code>AutoAction</code> when you want OpenEnv to find the matching client
and action classes for an installed or discoverable environment.`,ee,U,ne,E,Te="<code>AutoEnv.from_env()</code> accepts the common name forms:",te,g,le,C,se,A,Ue=`OpenEnv clients are async by default. Use the async client for production code,
parallel environment runs, and integrations with async frameworks.`,ae,I,oe,W,Ee="For scripts and notebooks, use <code>.sync()</code>:",ie,k,pe,G,re,Y,ge="You can run an environment from a Docker image:",ce,Z,Me,Q,Ce="Or connect to a local server:",me,B,ue,V,he,X,ye,_,Ae='<li><a href="guides/concepts">Concepts</a></li> <li><a href="environments">Explore environments</a></li> <li><a href="guides/first-environment">Build your first environment</a></li>',je,S,we,R,de;return d=new Ve({props:{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"}}),v=new N({props:{title:"Getting Started",local:"getting-started",headingTag:"h1"}}),b=new N({props:{title:"Install OpenEnv",local:"install-openenv",headingTag:"h2"}}),J=new w({props:{code:"cGlwJTIwaW5zdGFsbCUyMG9wZW5lbnY=",highlighted:"pip install openenv",lang:"bash",wrap:!1}}),$=new N({props:{title:"Try an Environment",local:"try-an-environment",headingTag:"h2"}}),U=new w({props:{code:"ZnJvbSUyMG9wZW5lbnYlMjBpbXBvcnQlMjBBdXRvQWN0aW9uJTJDJTIwQXV0b0VudiUwQSUwQWVudiUyMCUzRCUyMEF1dG9FbnYuZnJvbV9lbnYoJTIyZWNobyUyMiklMEFFY2hvQWN0aW9uJTIwJTNEJTIwQXV0b0FjdGlvbi5mcm9tX2VudiglMjJlY2hvJTIyKSUwQSUwQXdpdGglMjBlbnYuc3luYygpJTIwYXMlMjBjbGllbnQlM0ElMEElMjAlMjAlMjAlMjByZXN1bHQlMjAlM0QlMjBjbGllbnQucmVzZXQoKSUwQSUyMCUyMCUyMCUyMHByaW50KHJlc3VsdC5vYnNlcnZhdGlvbi5lY2hvZWRfbWVzc2FnZSklMjAlMjAlMjMlMjAlMjJFY2hvJTIwZW52aXJvbm1lbnQlMjByZWFkeSElMjIlMEElMEElMjAlMjAlMjAlMjByZXN1bHQlMjAlM0QlMjBjbGllbnQuc3RlcChFY2hvQWN0aW9uKG1lc3NhZ2UlM0QlMjJIZWxsbyUyQyUyME9wZW5FbnYhJTIyKSklMEElMjAlMjAlMjAlMjBwcmludChyZXN1bHQub2JzZXJ2YXRpb24uZWNob2VkX21lc3NhZ2UpJTIwJTIwJTIzJTIwJTIySGVsbG8lMkMlMjBPcGVuRW52ISUyMg==",highlighted:`<span class="hljs-keyword">from</span> openenv <span class="hljs-keyword">import</span> AutoAction, AutoEnv

env = AutoEnv.from_env(<span class="hljs-string">&quot;echo&quot;</span>)
EchoAction = AutoAction.from_env(<span class="hljs-string">&quot;echo&quot;</span>)

<span class="hljs-keyword">with</span> env.sync() <span class="hljs-keyword">as</span> client:
    result = client.reset()
    <span class="hljs-built_in">print</span>(result.observation.echoed_message)  <span class="hljs-comment"># &quot;Echo environment ready!&quot;</span>

    result = client.step(EchoAction(message=<span class="hljs-string">&quot;Hello, OpenEnv!&quot;</span>))
    <span class="hljs-built_in">print</span>(result.observation.echoed_message)  <span class="hljs-comment"># &quot;Hello, OpenEnv!&quot;</span>`,lang:"python",wrap:!1}}),g=new w({props:{code:"QXV0b0Vudi5mcm9tX2VudiglMjJlY2hvJTIyKSUwQUF1dG9FbnYuZnJvbV9lbnYoJTIyZWNoby1lbnYlMjIpJTBBQXV0b0Vudi5mcm9tX2VudiglMjJlY2hvX2VudiUyMik=",highlighted:`AutoEnv.from_env(<span class="hljs-string">&quot;echo&quot;</span>)
AutoEnv.from_env(<span class="hljs-string">&quot;echo-env&quot;</span>)
AutoEnv.from_env(<span class="hljs-string">&quot;echo_env&quot;</span>)`,lang:"python",wrap:!1}}),C=new N({props:{title:"Connect to a Running Environment",local:"connect-to-a-running-environment",headingTag:"h2"}}),I=new w({props:{code:"aW1wb3J0JTIwYXN5bmNpbyUwQSUwQWZyb20lMjBlY2hvX2VudiUyMGltcG9ydCUyMEVjaG9BY3Rpb24lMkMlMjBFY2hvRW52JTBBJTBBJTBBYXN5bmMlMjBkZWYlMjBtYWluKCklM0ElMEElMjAlMjAlMjAlMjBhc3luYyUyMHdpdGglMjBFY2hvRW52KGJhc2VfdXJsJTNEJTIyaHR0cHMlM0ElMkYlMkZvcGVuZW52LWVjaG8tZW52LmhmLnNwYWNlJTIyKSUyMGFzJTIwY2xpZW50JTNBJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwcmVzdWx0JTIwJTNEJTIwYXdhaXQlMjBjbGllbnQucmVzZXQoKSUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMHByaW50KHJlc3VsdC5vYnNlcnZhdGlvbi5lY2hvZWRfbWVzc2FnZSklMEElMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjByZXN1bHQlMjAlM0QlMjBhd2FpdCUyMGNsaWVudC5zdGVwKEVjaG9BY3Rpb24obWVzc2FnZSUzRCUyMkhlbGxvJTJDJTIwV29ybGQhJTIyKSklMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjBwcmludChyZXN1bHQucmV3YXJkKSUwQSUwQSUwQWFzeW5jaW8ucnVuKG1haW4oKSk=",highlighted:`<span class="hljs-keyword">import</span> asyncio

<span class="hljs-keyword">from</span> echo_env <span class="hljs-keyword">import</span> EchoAction, EchoEnv


<span class="hljs-keyword">async</span> <span class="hljs-keyword">def</span> <span class="hljs-title function_">main</span>():
    <span class="hljs-keyword">async</span> <span class="hljs-keyword">with</span> EchoEnv(base_url=<span class="hljs-string">&quot;https://openenv-echo-env.hf.space&quot;</span>) <span class="hljs-keyword">as</span> client:
        result = <span class="hljs-keyword">await</span> client.reset()
        <span class="hljs-built_in">print</span>(result.observation.echoed_message)

        result = <span class="hljs-keyword">await</span> client.step(EchoAction(message=<span class="hljs-string">&quot;Hello, World!&quot;</span>))
        <span class="hljs-built_in">print</span>(result.reward)


asyncio.run(main())`,lang:"python",wrap:!1}}),k=new w({props:{code:"ZnJvbSUyMGVjaG9fZW52JTIwaW1wb3J0JTIwRWNob0FjdGlvbiUyQyUyMEVjaG9FbnYlMEElMEF3aXRoJTIwRWNob0VudihiYXNlX3VybCUzRCUyMmh0dHBzJTNBJTJGJTJGb3BlbmVudi1lY2hvLWVudi5oZi5zcGFjZSUyMikuc3luYygpJTIwYXMlMjBjbGllbnQlM0ElMEElMjAlMjAlMjAlMjByZXN1bHQlMjAlM0QlMjBjbGllbnQucmVzZXQoKSUwQSUyMCUyMCUyMCUyMHJlc3VsdCUyMCUzRCUyMGNsaWVudC5zdGVwKEVjaG9BY3Rpb24obWVzc2FnZSUzRCUyMkhlbGxvJTJDJTIwV29ybGQhJTIyKSklMEElMjAlMjAlMjAlMjBwcmludChyZXN1bHQub2JzZXJ2YXRpb24uZWNob2VkX21lc3NhZ2Up",highlighted:`<span class="hljs-keyword">from</span> echo_env <span class="hljs-keyword">import</span> EchoAction, EchoEnv

<span class="hljs-keyword">with</span> EchoEnv(base_url=<span class="hljs-string">&quot;https://openenv-echo-env.hf.space&quot;</span>).sync() <span class="hljs-keyword">as</span> client:
    result = client.reset()
    result = client.step(EchoAction(message=<span class="hljs-string">&quot;Hello, World!&quot;</span>))
    <span class="hljs-built_in">print</span>(result.observation.echoed_message)`,lang:"python",wrap:!1}}),G=new N({props:{title:"Use Containers or Local Servers",local:"use-containers-or-local-servers",headingTag:"h2"}}),Z=new w({props:{code:"aW1wb3J0JTIwYXN5bmNpbyUwQSUwQWZyb20lMjBlY2hvX2VudiUyMGltcG9ydCUyMEVjaG9FbnYlMEElMEElMEFhc3luYyUyMGRlZiUyMG1haW4oKSUzQSUwQSUyMCUyMCUyMCUyMGNsaWVudCUyMCUzRCUyMGF3YWl0JTIwRWNob0Vudi5mcm9tX2RvY2tlcl9pbWFnZSglMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjJyZWdpc3RyeS5oZi5zcGFjZSUyRm9wZW5lbnYtZWNoby1lbnYlM0FsYXRlc3QlMjIlMEElMjAlMjAlMjAlMjApJTBBJTIwJTIwJTIwJTIwYXN5bmMlMjB3aXRoJTIwY2xpZW50JTNBJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwcmVzdWx0JTIwJTNEJTIwYXdhaXQlMjBjbGllbnQucmVzZXQoKSUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMHByaW50KHJlc3VsdC5vYnNlcnZhdGlvbiklMEElMEElMEFhc3luY2lvLnJ1bihtYWluKCkp",highlighted:`<span class="hljs-keyword">import</span> asyncio

<span class="hljs-keyword">from</span> echo_env <span class="hljs-keyword">import</span> EchoEnv


<span class="hljs-keyword">async</span> <span class="hljs-keyword">def</span> <span class="hljs-title function_">main</span>():
    client = <span class="hljs-keyword">await</span> EchoEnv.from_docker_image(
        <span class="hljs-string">&quot;registry.hf.space/openenv-echo-env:latest&quot;</span>
    )
    <span class="hljs-keyword">async</span> <span class="hljs-keyword">with</span> client:
        result = <span class="hljs-keyword">await</span> client.reset()
        <span class="hljs-built_in">print</span>(result.observation)


asyncio.run(main())`,lang:"python",wrap:!1}}),B=new w({props:{code:"Y2QlMjBwYXRoJTJGdG8lMkZlY2hvLWVudiUwQXV2JTIwdmVudiUwQXNvdXJjZSUyMC52ZW52JTJGYmluJTJGYWN0aXZhdGUlMEF1diUyMHBpcCUyMGluc3RhbGwlMjAtZSUyMC4lMEF1diUyMHJ1biUyMHNlcnZlciUyMC0taG9zdCUyMDAuMC4wLjAlMjAtLXBvcnQlMjA4MDAw",highlighted:`<span class="hljs-built_in">cd</span> path/to/echo-env
uv venv
<span class="hljs-built_in">source</span> .venv/bin/activate
uv pip install -e .
uv run server --host 0.0.0.0 --port 8000`,lang:"bash",wrap:!1}}),V=new w({props:{code:"ZnJvbSUyMGVjaG9fZW52JTIwaW1wb3J0JTIwRWNob0VudiUwQSUwQXdpdGglMjBFY2hvRW52KGJhc2VfdXJsJTNEJTIyaHR0cCUzQSUyRiUyRmxvY2FsaG9zdCUzQTgwMDAlMjIpLnN5bmMoKSUyMGFzJTIwY2xpZW50JTNBJTBBJTIwJTIwJTIwJTIwcmVzdWx0JTIwJTNEJTIwY2xpZW50LnJlc2V0KCk=",highlighted:`<span class="hljs-keyword">from</span> echo_env <span class="hljs-keyword">import</span> EchoEnv

<span class="hljs-keyword">with</span> EchoEnv(base_url=<span class="hljs-string">&quot;http://localhost:8000&quot;</span>).sync() <span class="hljs-keyword">as</span> client:
    result = client.reset()`,lang:"python",wrap:!1}}),X=new N({props:{title:"Next Steps",local:"next-steps",headingTag:"h2"}}),S=new Xe({props:{source:"https://github.com/huggingface/openenv/blob/main/docs/source/getting-started.md"}}),{c(){h=m("meta"),F=s(),x=m("p"),H=s(),o(d.$$.fragment),z=s(),o(v.$$.fragment),q=s(),f=m("p"),f.textContent=be,L=s(),o(b.$$.fragment),K=s(),o(J.$$.fragment),P=s(),j=m("blockquote"),j.innerHTML=Je,O=s(),o($.$$.fragment),D=s(),T=m("p"),T.innerHTML=$e,ee=s(),o(U.$$.fragment),ne=s(),E=m("p"),E.innerHTML=Te,te=s(),o(g.$$.fragment),le=s(),o(C.$$.fragment),se=s(),A=m("p"),A.textContent=Ue,ae=s(),o(I.$$.fragment),oe=s(),W=m("p"),W.innerHTML=Ee,ie=s(),o(k.$$.fragment),pe=s(),o(G.$$.fragment),re=s(),Y=m("p"),Y.textContent=ge,ce=s(),o(Z.$$.fragment),Me=s(),Q=m("p"),Q.textContent=Ce,me=s(),o(B.$$.fragment),ue=s(),o(V.$$.fragment),he=s(),o(X.$$.fragment),ye=s(),_=m("ul"),_.innerHTML=Ae,je=s(),o(S.$$.fragment),we=s(),R=m("p"),this.h()},l(e){const n=Qe("svelte-u9bgzb",document.head);h=u(n,"META",{name:!0,content:!0}),n.forEach(t),F=a(e),x=u(e,"P",{}),Ie(x).forEach(t),H=a(e),i(d.$$.fragment,e),z=a(e),i(v.$$.fragment,e),q=a(e),f=u(e,"P",{"data-svelte-h":!0}),y(f)!=="svelte-15cr7kh"&&(f.textContent=be),L=a(e),i(b.$$.fragment,e),K=a(e),i(J.$$.fragment,e),P=a(e),j=u(e,"BLOCKQUOTE",{class:!0,"data-svelte-h":!0}),y(j)!=="svelte-1sdfroe"&&(j.innerHTML=Je),O=a(e),i($.$$.fragment,e),D=a(e),T=u(e,"P",{"data-svelte-h":!0}),y(T)!=="svelte-f52bo0"&&(T.innerHTML=$e),ee=a(e),i(U.$$.fragment,e),ne=a(e),E=u(e,"P",{"data-svelte-h":!0}),y(E)!=="svelte-dhx5hr"&&(E.innerHTML=Te),te=a(e),i(g.$$.fragment,e),le=a(e),i(C.$$.fragment,e),se=a(e),A=u(e,"P",{"data-svelte-h":!0}),y(A)!=="svelte-kox64u"&&(A.textContent=Ue),ae=a(e),i(I.$$.fragment,e),oe=a(e),W=u(e,"P",{"data-svelte-h":!0}),y(W)!=="svelte-1a88nmu"&&(W.innerHTML=Ee),ie=a(e),i(k.$$.fragment,e),pe=a(e),i(G.$$.fragment,e),re=a(e),Y=u(e,"P",{"data-svelte-h":!0}),y(Y)!=="svelte-1yestys"&&(Y.textContent=ge),ce=a(e),i(Z.$$.fragment,e),Me=a(e),Q=u(e,"P",{"data-svelte-h":!0}),y(Q)!=="svelte-1jlomv7"&&(Q.textContent=Ce),me=a(e),i(B.$$.fragment,e),ue=a(e),i(V.$$.fragment,e),he=a(e),i(X.$$.fragment,e),ye=a(e),_=u(e,"UL",{"data-svelte-h":!0}),y(_)!=="svelte-itcjdl"&&(_.innerHTML=Ae),je=a(e),i(S.$$.fragment,e),we=a(e),R=u(e,"P",{}),Ie(R).forEach(t),this.h()},h(){ve(h,"name","hf:doc:metadata"),ve(h,"content",Se),ve(j,"class","note")},m(e,n){Be(document.head,h),l(e,F,n),l(e,x,n),l(e,H,n),p(d,e,n),l(e,z,n),p(v,e,n),l(e,q,n),l(e,f,n),l(e,L,n),p(b,e,n),l(e,K,n),p(J,e,n),l(e,P,n),l(e,j,n),l(e,O,n),p($,e,n),l(e,D,n),l(e,T,n),l(e,ee,n),p(U,e,n),l(e,ne,n),l(e,E,n),l(e,te,n),p(g,e,n),l(e,le,n),p(C,e,n),l(e,se,n),l(e,A,n),l(e,ae,n),p(I,e,n),l(e,oe,n),l(e,W,n),l(e,ie,n),p(k,e,n),l(e,pe,n),p(G,e,n),l(e,re,n),l(e,Y,n),l(e,ce,n),p(Z,e,n),l(e,Me,n),l(e,Q,n),l(e,me,n),p(B,e,n),l(e,ue,n),p(V,e,n),l(e,he,n),p(X,e,n),l(e,ye,n),l(e,_,n),l(e,je,n),p(S,e,n),l(e,we,n),l(e,R,n),de=!0},p:ke,i(e){de||(r(d.$$.fragment,e),r(v.$$.fragment,e),r(b.$$.fragment,e),r(J.$$.fragment,e),r($.$$.fragment,e),r(U.$$.fragment,e),r(g.$$.fragment,e),r(C.$$.fragment,e),r(I.$$.fragment,e),r(k.$$.fragment,e),r(G.$$.fragment,e),r(Z.$$.fragment,e),r(B.$$.fragment,e),r(V.$$.fragment,e),r(X.$$.fragment,e),r(S.$$.fragment,e),de=!0)},o(e){c(d.$$.fragment,e),c(v.$$.fragment,e),c(b.$$.fragment,e),c(J.$$.fragment,e),c($.$$.fragment,e),c(U.$$.fragment,e),c(g.$$.fragment,e),c(C.$$.fragment,e),c(I.$$.fragment,e),c(k.$$.fragment,e),c(G.$$.fragment,e),c(Z.$$.fragment,e),c(B.$$.fragment,e),c(V.$$.fragment,e),c(X.$$.fragment,e),c(S.$$.fragment,e),de=!1},d(e){e&&(t(F),t(x),t(H),t(z),t(q),t(f),t(L),t(K),t(P),t(j),t(O),t(D),t(T),t(ee),t(ne),t(E),t(te),t(le),t(se),t(A),t(ae),t(oe),t(W),t(ie),t(pe),t(re),t(Y),t(ce),t(Me),t(Q),t(me),t(ue),t(he),t(ye),t(_),t(je),t(we),t(R)),t(h),M(d,e),M(v,e),M(b,e),M(J,e),M($,e),M(U,e),M(g,e),M(C,e),M(I,e),M(k,e),M(G,e),M(Z,e),M(B,e),M(V,e),M(X,e),M(S,e)}}}const Se='{"title":"Getting Started","local":"getting-started","sections":[{"title":"Install OpenEnv","local":"install-openenv","sections":[],"depth":2},{"title":"Try an Environment","local":"try-an-environment","sections":[],"depth":2},{"title":"Connect to a Running Environment","local":"connect-to-a-running-environment","sections":[],"depth":2},{"title":"Use Containers or Local Servers","local":"use-containers-or-local-servers","sections":[],"depth":2},{"title":"Next Steps","local":"next-steps","sections":[],"depth":2}],"depth":1}';function Ne(fe){return Ge(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class qe extends Ye{constructor(h){super(),Ze(this,h,Ne,_e,We,{})}}export{qe as component};