Buckets:

HuggingFaceDocBuilder's picture
download
raw
9.38 kB
import{s as Ye,n as Ae,o as Pe}from"../chunks/scheduler.2b22cead.js";import{S as Be,i as Ne,e as s,s as i,c as r,h as Ie,a as o,d as n,b as a,f as We,g as p,j as f,k as Se,l as Ue,m as l,n as m,t as u,o as c,p as d}from"../chunks/index.1a0e8013.js";import{C as qe,H as v,E as Ee}from"../chunks/MermaidChart.svelte_svelte_type_style_lang.e2bf9d10.js";import{C as _e}from"../chunks/CodeBlock.fb3fd2b3.js";function Xe(be){let $,X,q,z,h,V,g,F,T,Me="This environment exposes a Calendar Gym tools through the OpenEnv reset/step/state interface. The server runs a FastAPI app that serves the OpenEnv endpoints.",Q,_,D,b,O,M,R,w,we=`On Server health success response will be:
<code>{&quot;status&quot;:&quot;healthy&quot;,&quot;service&quot;:&quot;calendar-env&quot;}</code>`,K,y,ee,x,te,C,ne,L,le,k,ye="For a quick demo, simply update <code>llm_api_key</code> in <code>scenario_config.json</code> and run:",ie,J,ae,H,xe="The existing config includes a sample scenario for testing.",se,j,oe,G,Ce="To customize for your use case, edit <code>scenario_config.json</code> and update these fields:",re,Z,Le="<strong>llm variables:</strong>",pe,W,ke="<li><code>llm_api_key</code> - Your OpenAI/Anthropic/Google API key (or set via env var)</li> <li><code>llm_model</code> - Model name (e.g., <code>gpt-4o-mini</code>, <code>claude-3-5-sonnet-20241022</code>)</li> <li><code>llm_provider</code> - Provider: <code>openai</code>, <code>anthropic</code>, or <code>google</code></li>",me,S,Je="<strong>Scenario Variables</strong>",ue,Y,He="<li><code>user_prompt</code> - Task for the agent to complete</li> <li><code>system_prompt</code> - Instructions for agent behavior</li> <li><code>context</code> - The auth headers for gym like (x-access-token)</li> <li><code>seed_database_file</code> - Path to SQL file for custom data</li> <li><code>verifiers</code> - SQL queries to validate task completion</li> <li><code>expected_tools</code> - Tools agent should use (for tracking)</li>",ce,A,de,P,je="<strong>Run scenario-based benchmark:</strong>",fe,B,$e,N,Ge="Output will be saved to <code>response_output/</code> folder with execution details, tool calls, and verification results.",ve,I,Ze=`<strong>Notebook Evaluation:</strong>
For interactive evaluation and testing, use the: <a href="client_notebooks/OpenEnv_and_mcp_Single_Gym_Client_Meta_Turing.ipynb"><code>Jupyter notebook</code></a>`,he,U,ge,E,Te;return h=new qe({props:{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"}}),g=new v({props:{title:"Calendar Environment",local:"calendar-environment",headingTag:"h1"}}),_=new v({props:{title:"Server Setup",local:"server-setup",headingTag:"h2"}}),b=new v({props:{title:"Docker (Recommended)",local:"docker-recommended",headingTag:"h3"}}),M=new _e({props:{code:"Y2QlMjBlbnZzJTJGY2FsZW5kYXJfZW52JTBBZG9ja2VyJTIwYnVpbGQlMjAtdCUyMGNhbGVuZGFyLWVudiUzQWxhdGVzdCUyMC4lMEFkb2NrZXIlMjBydW4lMjAtLXJtJTIwLXAlMjA4MDA0JTNBODAwNCUyMGNhbGVuZGFyLWVudiUzQWxhdGVzdCUwQWN1cmwlMjBodHRwJTNBJTJGJTJGbG9jYWxob3N0JTNBODAwNCUyRmhlYWx0aA==",highlighted:`<span class="hljs-built_in">cd</span> envs/calendar_env
docker build -t calendar-env:latest .
docker run --<span class="hljs-built_in">rm</span> -p 8004:8004 calendar-env:latest
curl http://localhost:8004/health`,lang:"bash",wrap:!1}}),y=new v({props:{title:"Without Docker",local:"without-docker",headingTag:"h3"}}),x=new _e({props:{code:"Y2QlMjBlbnZzJTJGY2FsZW5kYXJfZW52JTBBcHl0aG9uMyUyMC1tJTIwdmVudiUyMHZlbnYlMEFzb3VyY2UlMjB2ZW52JTJGYmluJTJGYWN0aXZhdGUlMEFwaXAlMjBpbnN0YWxsJTIwLXIlMjByZXF1aXJlbWVudHMudHh0JTBBdXZpY29ybiUyMHNlcnZlci5hcHAlM0FhcHAlMjAtLWhvc3QlMjAwLjAuMC4wJTIwLS1wb3J0JTIwODAwNA==",highlighted:`<span class="hljs-built_in">cd</span> envs/calendar_env
python3 -m venv venv
<span class="hljs-built_in">source</span> venv/bin/activate
pip install -r requirements.txt
uvicorn server.app:app --host 0.0.0.0 --port 8004`,lang:"bash",wrap:!1}}),C=new v({props:{title:"Client Setup",local:"client-setup",headingTag:"h2"}}),L=new v({props:{title:"Quick Start (Demo)",local:"quick-start-demo",headingTag:"h3"}}),J=new _e({props:{code:"cHl0aG9uJTIwY2xpZW50LnB5JTIwLS1zY2VuYXJpbyUyMHNjZW5hcmlvX2NvbmZpZy5qc29u",highlighted:"python client.py --scenario scenario_config.json",lang:"bash",wrap:!1}}),j=new v({props:{title:"Configure Scenario",local:"configure-scenario",headingTag:"h3"}}),A=new v({props:{title:"Run Client",local:"run-client",headingTag:"h3"}}),B=new _e({props:{code:"cHl0aG9uJTIwY2xpZW50LnB5JTIwLS1zY2VuYXJpbyUyMHNjZW5hcmlvX2NvbmZpZy5qc29uJTIw",highlighted:"python client.py --scenario scenario_config.json ",lang:"bash",wrap:!1}}),U=new Ee({props:{source:"https://github.com/huggingface/openenv/blob/main/docs/source/environments/calendar.md"}}),{c(){$=s("meta"),X=i(),q=s("p"),z=i(),r(h.$$.fragment),V=i(),r(g.$$.fragment),F=i(),T=s("p"),T.textContent=Me,Q=i(),r(_.$$.fragment),D=i(),r(b.$$.fragment),O=i(),r(M.$$.fragment),R=i(),w=s("p"),w.innerHTML=we,K=i(),r(y.$$.fragment),ee=i(),r(x.$$.fragment),te=i(),r(C.$$.fragment),ne=i(),r(L.$$.fragment),le=i(),k=s("p"),k.innerHTML=ye,ie=i(),r(J.$$.fragment),ae=i(),H=s("p"),H.textContent=xe,se=i(),r(j.$$.fragment),oe=i(),G=s("p"),G.innerHTML=Ce,re=i(),Z=s("p"),Z.innerHTML=Le,pe=i(),W=s("ul"),W.innerHTML=ke,me=i(),S=s("p"),S.innerHTML=Je,ue=i(),Y=s("ul"),Y.innerHTML=He,ce=i(),r(A.$$.fragment),de=i(),P=s("p"),P.innerHTML=je,fe=i(),r(B.$$.fragment),$e=i(),N=s("p"),N.innerHTML=Ge,ve=i(),I=s("p"),I.innerHTML=Ze,he=i(),r(U.$$.fragment),ge=i(),E=s("p"),this.h()},l(e){const t=Ie("svelte-u9bgzb",document.head);$=o(t,"META",{name:!0,content:!0}),t.forEach(n),X=a(e),q=o(e,"P",{}),We(q).forEach(n),z=a(e),p(h.$$.fragment,e),V=a(e),p(g.$$.fragment,e),F=a(e),T=o(e,"P",{"data-svelte-h":!0}),f(T)!=="svelte-w7rmu4"&&(T.textContent=Me),Q=a(e),p(_.$$.fragment,e),D=a(e),p(b.$$.fragment,e),O=a(e),p(M.$$.fragment,e),R=a(e),w=o(e,"P",{"data-svelte-h":!0}),f(w)!=="svelte-55byjs"&&(w.innerHTML=we),K=a(e),p(y.$$.fragment,e),ee=a(e),p(x.$$.fragment,e),te=a(e),p(C.$$.fragment,e),ne=a(e),p(L.$$.fragment,e),le=a(e),k=o(e,"P",{"data-svelte-h":!0}),f(k)!=="svelte-115v6jp"&&(k.innerHTML=ye),ie=a(e),p(J.$$.fragment,e),ae=a(e),H=o(e,"P",{"data-svelte-h":!0}),f(H)!=="svelte-4hdsfb"&&(H.textContent=xe),se=a(e),p(j.$$.fragment,e),oe=a(e),G=o(e,"P",{"data-svelte-h":!0}),f(G)!=="svelte-1vxytmn"&&(G.innerHTML=Ce),re=a(e),Z=o(e,"P",{"data-svelte-h":!0}),f(Z)!=="svelte-whswe5"&&(Z.innerHTML=Le),pe=a(e),W=o(e,"UL",{"data-svelte-h":!0}),f(W)!=="svelte-9it212"&&(W.innerHTML=ke),me=a(e),S=o(e,"P",{"data-svelte-h":!0}),f(S)!=="svelte-16om2f4"&&(S.innerHTML=Je),ue=a(e),Y=o(e,"UL",{"data-svelte-h":!0}),f(Y)!=="svelte-3snh32"&&(Y.innerHTML=He),ce=a(e),p(A.$$.fragment,e),de=a(e),P=o(e,"P",{"data-svelte-h":!0}),f(P)!=="svelte-il8nfz"&&(P.innerHTML=je),fe=a(e),p(B.$$.fragment,e),$e=a(e),N=o(e,"P",{"data-svelte-h":!0}),f(N)!=="svelte-g9zdak"&&(N.innerHTML=Ge),ve=a(e),I=o(e,"P",{"data-svelte-h":!0}),f(I)!=="svelte-1nynkb2"&&(I.innerHTML=Ze),he=a(e),p(U.$$.fragment,e),ge=a(e),E=o(e,"P",{}),We(E).forEach(n),this.h()},h(){Se($,"name","hf:doc:metadata"),Se($,"content",ze)},m(e,t){Ue(document.head,$),l(e,X,t),l(e,q,t),l(e,z,t),m(h,e,t),l(e,V,t),m(g,e,t),l(e,F,t),l(e,T,t),l(e,Q,t),m(_,e,t),l(e,D,t),m(b,e,t),l(e,O,t),m(M,e,t),l(e,R,t),l(e,w,t),l(e,K,t),m(y,e,t),l(e,ee,t),m(x,e,t),l(e,te,t),m(C,e,t),l(e,ne,t),m(L,e,t),l(e,le,t),l(e,k,t),l(e,ie,t),m(J,e,t),l(e,ae,t),l(e,H,t),l(e,se,t),m(j,e,t),l(e,oe,t),l(e,G,t),l(e,re,t),l(e,Z,t),l(e,pe,t),l(e,W,t),l(e,me,t),l(e,S,t),l(e,ue,t),l(e,Y,t),l(e,ce,t),m(A,e,t),l(e,de,t),l(e,P,t),l(e,fe,t),m(B,e,t),l(e,$e,t),l(e,N,t),l(e,ve,t),l(e,I,t),l(e,he,t),m(U,e,t),l(e,ge,t),l(e,E,t),Te=!0},p:Ae,i(e){Te||(u(h.$$.fragment,e),u(g.$$.fragment,e),u(_.$$.fragment,e),u(b.$$.fragment,e),u(M.$$.fragment,e),u(y.$$.fragment,e),u(x.$$.fragment,e),u(C.$$.fragment,e),u(L.$$.fragment,e),u(J.$$.fragment,e),u(j.$$.fragment,e),u(A.$$.fragment,e),u(B.$$.fragment,e),u(U.$$.fragment,e),Te=!0)},o(e){c(h.$$.fragment,e),c(g.$$.fragment,e),c(_.$$.fragment,e),c(b.$$.fragment,e),c(M.$$.fragment,e),c(y.$$.fragment,e),c(x.$$.fragment,e),c(C.$$.fragment,e),c(L.$$.fragment,e),c(J.$$.fragment,e),c(j.$$.fragment,e),c(A.$$.fragment,e),c(B.$$.fragment,e),c(U.$$.fragment,e),Te=!1},d(e){e&&(n(X),n(q),n(z),n(V),n(F),n(T),n(Q),n(D),n(O),n(R),n(w),n(K),n(ee),n(te),n(ne),n(le),n(k),n(ie),n(ae),n(H),n(se),n(oe),n(G),n(re),n(Z),n(pe),n(W),n(me),n(S),n(ue),n(Y),n(ce),n(de),n(P),n(fe),n($e),n(N),n(ve),n(I),n(he),n(ge),n(E)),n($),d(h,e),d(g,e),d(_,e),d(b,e),d(M,e),d(y,e),d(x,e),d(C,e),d(L,e),d(J,e),d(j,e),d(A,e),d(B,e),d(U,e)}}}const ze='{"title":"Calendar Environment","local":"calendar-environment","sections":[{"title":"Server Setup","local":"server-setup","sections":[{"title":"Docker (Recommended)","local":"docker-recommended","sections":[],"depth":3},{"title":"Without Docker","local":"without-docker","sections":[],"depth":3}],"depth":2},{"title":"Client Setup","local":"client-setup","sections":[{"title":"Quick Start (Demo)","local":"quick-start-demo","sections":[],"depth":3},{"title":"Configure Scenario","local":"configure-scenario","sections":[],"depth":3},{"title":"Run Client","local":"run-client","sections":[],"depth":3}],"depth":2}],"depth":1}';function Ve(be){return Pe(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class Re extends Be{constructor($){super(),Ne(this,$,Ve,Xe,Ye,{})}}export{Re as component};

Xet Storage Details

Size:
9.38 kB
·
Xet hash:
aa82c891ebe23ae646aaae9a13e1eaa284f15f241ec4f00933604a4a4942986f

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.