5pjGRSrSSKrSSKrSSKJr SSKJrJrJr SSK r SSK J r J r J r JrJrJrJrJrJrJrJrJr SSKJr SSKJrJr SS KJrJrJrJ r J!r!J"r"J#r#J$r$J%r%J&r& SS K'J(r(J)r) SS K*J+r+ SS K,J-r-J.r. \&"S S9r/\&"SS9r0\/Rc\0SS9 \&"SS9r2\/Rc\2SS9 \\3\("SS94r4\S\3S\3S-S\3S-S\\4Sj5r5\/RmS/SQS9SrS\\3S-\("SS94S\\3S-\)"SS S94S!\-S"\\3S-\)"S#S94S$\S%\ S&\S'\S(\"S\.S)\\7\)"S*S+S94S\!SS4S,jj5r8\/RmS-S.S/0S0S1/S29SsS\4S3\\9\3\("S4S94S5\\3S-\)"S6S7S8S94S$\S&\S9\\:S-\)"S:S;S94S\.S\!SS4S<jj5r;\/RmS=S.S/0S>S?/S29StS\4S3\\9\3\("S@S94S5\\3S-\)"S6S7S8S94S$\S&\S\.S\!SS4SAjj5r<\/RmSBSCSD/S9SuSE\\3\("SFS94SG\\3\("SHS94S\.S\!SS4 SIjj5r=\/RmSJ/SKQS9SvS\\3S-\("SLS94SM\\7\)"SNSOS94SP\\7\)"SQSRSSS94S\.S\!SS4 STjj5r>\0RmS/SUQS9SS\ SSSS4S\\3S-\("SVS94S!\-SW\\?\)"SXSSY\ SZ3S[94S\\\?S-\)"S]SS^S[94S"\\3S-\)"S_S94S\.S\!SS4S`jj5r@\0RmSaSb/S9SuS\.S\!SS4Scjj5rA\0RmSdSe/S9SwSf\\3\("SgS94SP\\7\)"SQSRSSS94S\.S\!SS4 Shjj5rBSi\3\9\3-S\34SjjrCS\S\34SkjrD\2RmSaSl/S9SuS\4S\.S\!SS4Smjj5rE\2RmSJSn/S9SuS\4So\\?\("SpS94S\.S\!SS4 Sqjj5rFg)xzCContains commands to run and manage sandboxes on Hugging Face Jobs.N)contextmanager) AnnotatedAnyIterator) DEFAULT_IDLE_TIMEOUT DEFAULT_IMAGEDEFAULT_SANDBOXES_PER_HOST MODE_LABEL MODE_POOL POOL_LABEL SANDBOX_LABEL SHARED_ID_SEPSandbox SandboxPoolSandboxProcess_split_sandbox_id)delete_pool_cache)CLIError SandboxError) EnvFileOptEnvOptSecretsFileOpt SecretsOptTokenOpt VolumesOpt get_hf_api parse_env_map parse_volumes typer_factory)ArgumentOption)out) FlavorOpt NamespaceOptz.Run and manage sandboxes on Hugging Face Jobs.)helpzBWarm pools of host VMs and spawn cheap shared sandboxes from them.pool)namez8List and stop background processes running in a sandbox.processz1The sandbox id as printed by `hf sandbox create`. sandbox_id namespacetokenreturnc## [R"XUS9nUv UR5 g!UR5 f=f7f)zIReattach to a sandbox and close the HTTP client when the command is done.r+r,N)rconnectclose)r*r+r,sandboxs W/var/www/html/pdf-tiff/venv/lib/python3.13/site-packages/huggingface_hub/cli/sandbox.py_connectr4Bs3oojUKG   sA.AAAcreate)zhf sandbox createzhf sandbox create ubuntu:24.04z%hf sandbox create --flavor a10g-smallz@hf sandbox create --pool pool-ab12cd34ef56 --env LOG_LEVEL=debug)examplesimagezDocker image (needs /bin/sh).z--poolzJSpawn a cheap shared sandbox in this pool (from `hf sandbox pool create`).flavor idle_timeoutzTAuto-terminate the sandbox after this much inactivity (e.g. '10m'). Defaults to 10m.envsecretsenv_file secrets_filevolumeforward_hf_tokenz--forward-hf-tokenz0Inject your HF token as HF_TOKEN in the sandbox.c [R"5n UbUO[n UbUc UcU(a [S5eU(dU(a [S5e[R"XU S9R [ XF5U U S9n[R"SURURU[R"5U - SS3S 9 [R"S URS 35 [R"S URS 35 g[R "U=(d [U=(d SU [ XF5[ XW5[U5U U U S9 nUR5 [R"SURUR [R"5U - SS3S9 [R"S URS 35 [R"S URS 35 g)a~Create a sandbox: a dedicated VM by default, or a cheap shared one with `--pool`. Env and idle-timeout apply to the sandbox in both modes. With `--pool`, the image and flavor come from the pool, so passing them here is an error; `--secrets` is also rejected since pooled sandboxes have no encrypted-secrets channel (use `--env`). Define a pool first with `hf sandbox pool create`. NzQ--pool fixes the image/flavor (and volumes aren't supported); drop those options.zF--pool can't encrypt secrets; pass them with --env/--env-file instead.r/)r:r9r?z Sandbox ready.1fs)idhostr'elapsedz$Run a command with `hf sandbox exec z -- echo hello`.z#Terminate it with `hf sandbox kill `. cpu-basic) r7r8r9r:r;volumesr+r?r,)rCr7rE)timerrrr0r5rr#resultrChost_idhintrrrr1r7)r7r'r8r9r:r;r<r=r>r+r?r,startidlesbxr2s r3sandbox_createrPLsL IIKE'3<9MD    2fno o lcd d!!$5IPPc,-Q  ?svvCKKdW[W`W`WbejWjknVoopTqr 7x?OPQ 6svvhbABnn$}$ # (g4f%) G MMOJJ7::W]]tyy{]bObcfNgghLijHH3GJJ -- python -c "print(42)"z1hf sandbox exec -w /app -- pytest -x)context_settingsr6commandzThe command to run.workdirz-wz --workdirzWorking directory. exec_timeoutz --timeoutz)Kill the command after this many seconds.c S[SS4SjnS[SS4Sjn [XUS9n U R[U5[ X45UUUU SS9n SSS5 W R (aJ[ R"S US 35 [RRU R=(d S S 9eU RS :wa8[RRU RbU RS 9eSS 9eg!,(df  N=f)zRun a command in a sandbox, streaming output. Exits with the command's exit code. To start a long-running command in the background instead of waiting for it, use `hf sandbox spawn`. datar-Nc~[RRU5 [RR5 gN)sysstdoutwriteflushrYs r3 write_stdout"sandbox_exec..write_stdout$  rQc~[RRU5 [RR5 gr[)r\stderrr^r_r`s r3 write_stderr"sandbox_exec..write_stderrrcrQr/F)r:cwdtimeout on_stdout on_stderrcheckzCommand timed out after zs.|)coderr) strr4runlistr timed_outr#errorclick exceptionsExit exit_code) r*rUrVr:r<rWr+r,rarfr2rJs r3 sandbox_execrxs43434 * ?7 Mc, ""  @ ,\N"=>##)9)9)@S#AA 1##V=M=M=Y)9)9#aa_`#aa @ ?s (C99 Dspawnz;hf sandbox spawn -- python -m http.server 8000z8hf sandbox spawn -w /app -- uvicorn app:appz%The command to run in the background.cV[XUS9nUR[U5[X45USS9nSSS5 [R "SUWR S9 [R"SUS35 [R"S US UR S35 g!,(df  Np=f) zStart a long-running command in the background and return its pid (don't wait). List a sandbox's processes with `hf sandbox process ls` and stop one with `hf sandbox process kill`. r/T)r:rh backgroundNzProcess startedr2pidz+List processes with `hf sandbox process ls rFz&Stop it with `hf sandbox process kill  )r4rprqrr#rJr}rL) r*rUrVr:r<r+r,r2r)s r3 sandbox_spawnrs, * ?7++d7ms1MSZgk+l @JJ *'++FHH::,b IJHH5j\7;;-r RS @ ?s %B B(cpz2hf sandbox cp data.csv :/data/data.csvz7hf sandbox cp :/app/result.json result.jsonsrcz,Source: a local path or :.dstz1Destination: a local path or :.cS[S[[S-[44SjnU"U5upVU"U5upxUSLUSL:Xa [S5eUb/[XRUS9n U RR Xh5 SSS5 O3Uce[XrUS9n U RR Xh5 SSS5 [R"SXS9 g!,(df  N$=f!,(df  N5=f) zCCopy a file between the local machine and a sandbox (docker-style).refr-NcSU;a<URS5(d&URSS5up[U5S:aX4$SU4$)N:)./~r) startswithsplitlen)rr*paths r3parsesandbox_cp..parsesK #:cnn_=="yya0 J:"!''SyrQzHExactly one of SRC and DST must be a sandbox path (:).r/Copied)rr) rotuplerr4filesdownloaduploadr#rJ) rrr+r,r src_sandboxsrc_path dst_sandboxdst_pathr2s r3 sandbox_cprs35tS1"#JK!#JKt!45abb ke D MM " "8 6E D&&& ke D MM  4EJJxS* E DE DsC C C C%kill)zhf sandbox kill zKhf sandbox kill # kills a whole shared host (all its sandboxes)zhf sandbox kill --allz$The sandbox or host id to terminate.all_z--allz2Terminate every sandbox and host in the namespace.yesz-yz--yesz$Answer Yes to prompts automatically.c[US9nU(a[URSS/[S0US95nU(d[R "S5 g[R "S[U5S 3US 9 UH1nURURURRS 9 M3 [R"S [U5S 9 gUc [S5e[X5up[U;a:[!XUS9n U R#5 SSS5 [R"SUS9 gUR)XS 9nUR*=(d 0R-[.5[0:Xa][R "SUS3US 9 URURURRS 9 [R"SUS9 g[!XUS9n U R#5 SSS5 [R"SUS9 g!,(df  N=f![$an [['U 55U eSn A ff=f!,(df  N\=f![$an [['U 55U eSn A ff=f)z@Terminate a sandbox, a whole shared host, or everything (--all).r,RUNNING SCHEDULING1statuslabelsr+zNo running sandboxes.N Terminate zA sandbox job(s) (including shared hosts and all their sandboxes)?rjob_idr+ Terminated)jobsz*Provide a sandbox id, a host id, or --all.r/zSandbox terminated)rCzTerminate shared host z and all of its sandboxes?zHost terminated)rrq list_jobsr r#textconfirmr cancel_jobrCownerr(rJrrrr4rrro inspect_jobrgetr r ) r*rrr+r,apirjobsidnsr2es r3 sandbox_killr s 5 !C CMM)\)BM[^K_ktMuv HH, -  jT +lmsvwC NN#&&CIINNN C  H IH6 I> H H H H3H..H36 III I+I&&I+)zhf sandbox pool createz5hf sandbox pool create python:3.12 --flavor cpu-basicz7hf sandbox pool create --per-host 50 --idle-timeout 30mz+Docker image for the hosts (needs /bin/sh).per_hostz --per-hostz&Sandboxes packed per host VM (default z).)minr& max_hostsz --max-hostsz'Optional cap on the number of host VMs.zZShut a host down once it has had no sandboxes for this long (e.g. '10m'). Defaults to 10m.c [R"5nU=(d [n[UU=(d SUUUbUO[UUS9nURn UR n [ R"SU UU=(d SU S[R"5U- SS3S9 [ R"S U S 35 [ R"S U S 35 g) zRWarm a pool: boot one host VM now, tagged so it can be found later by its pool id.rGN)r7r8sandboxes_per_hostrr9r+r,z Pool createdrrArB)rCr7r8rDrEz/Spawn a sandbox with `hf sandbox create --pool rFz=Delete the pool (and its hosts) with `hf sandbox pool delete ) rIrrrr(host_idsr#rJrL) r7r8rrr9r+r,rMr'pool_idrs r3 pool_createrGs4 IIKE  "]E $#%1%=\CW DiiG}}HJJ $ a[99;&s+1- HH>wir JKHHLWIUW XYrQz ls | listzhf sandbox pool lsc [US9n0nURS[[0US9HnUR=(d 0R [ 5nU(dM4[UR[5(a URO0nURUUUR=(d URURUR SS5SS.5nUS==S - ss'M [UR55n[ R""US S 9 U(d[ R$"S 5 g[ R$"S 5 g)z9List running sandbox pools (grouped from their host VMs).rrr SBX_CAPACITYr)rCr7r8rhostsrrrCid_keyz)Create one with `hf sandbox pool create`.z5Spawn a sandbox with `hf sandbox create --pool `.N)rrr r rrr isinstance environmentdict setdefault docker_imagespace_idr8rqvaluesr#tablerL) r+r,rpoolsrr}r:inforowss r3pool_lsrzs 5 !C')E}}Iz96MYb}czzR$$Z0 !+COOT!B!Bcoo ))9S\\**GGNB7     W  d   DIId4  <= HIrQz delete | rmz hf sandbox pool delete rzPool id to delete.c [US9n[URSS/[[[ U0US95nU(d&[ U5 [R"SUS35 g[R"S[U5S US 3US 9 UH1nURURURRS 9 M3 [ U5 [R"S U[U5S9 g)zDTerminate every host VM of a pool (and therefore all its sandboxes).rrrrzNo running hosts for pool 'z'.Nrz host(s) of pool 'z' (and all their sandboxes)?rrz Pool deleted)rChosts_terminated)rrqrr r r rr#rrrrrCrr(rJ)rrr+r,rrrs r3 pool_deleters 5 !C  |, :w?   E '" .wir:;KK*SZL(:7)C_`fij cff ?gJJ~'CJGrQcmdcR[U[5(aU$SRU5$)Nr~)rrojoin)rs r3_fmt_cmdrs!S#&&39CHHSM9rQcdUR(agURcS$SURS3$)Nrunningexitedzexited ())rrw)r)s r3 _fmt_statusrs3((08UARAR@SST6UUrQz"hf sandbox process ls c[XUS9nUR5nSSS5 WVs/sH.oUR[U5[ UR 5S.PM0 nn[ R"USS9 U(d[ R"SUS35 g[ R"SUS 35 g!,(df  N=fs snf) zUList the background processes running in a sandbox (started with `hf sandbox spawn`).r/N)r}rrr}rz!Start one with `hf sandbox spawn z -- `.z'Stop one with `hf sandbox process kill z `.) r4 processesr}rrrr#rrL)r*r+r,r2rprs r3 process_lsrs * ?7%%'  @V_ `V_QREE[^HQUUO LV_D `IId5!  4ZL LM ::,hOP @ ? `sB15C1 B?z*hf sandbox process kill r}z.The pid as printed by `hf sandbox process ls`.c ^[XUS9n[U4SjUR55S5nUc[STSUS35eUR 5 SSS5 [ R "SUTS9 g!,(df  N%=f) z/Stop a background process running in a sandbox.r/c3J># UHoRT:XdMUv M g7fr[)r}).0rr}s r3 process_kill..sG#6a%%3,#6s# #NzNo process with pid z in sandbox rzProcess stoppedr|)r4nextrrrr#rJ)r*r}r+r,r2r)s ` r3 process_killrsx * ?7G7#4#4#6GN ?1#l:,aPQ Q  @ JJ *#> @ ?s A A55 B) NNNNNNNNNNFN)NNNNNN)NNNNN)NN)NFFNN)FNN)G__doc__r\rI contextlibrtypingrrrrthuggingface_hub._sandboxrrr r r r r rrrrrhuggingface_hub._sandbox_cacherhuggingface_hub.errorsrr _cli_utilsrrrrrrrrrr _frameworkr!r"_outputr#rr$r% sandbox_clipool_cli add_group process_cliro SandboxIdArgr4rUboolrPrqfloatrxrrrintrrrrrrrrQr3rs+J %++     =9   ))!QR b c hV,![\ k 2h,_``a C$JsTzhW^N_  TX  #'" )>C S4Z/N!OO P>C  d xjk m >C  >C d jk m>C >C>C>C!>C >C !>C"  f)0bcc#>C( )>C* +>C>CB  .5?;\` "(b(b tCy(0E"FF G(bsTz6$ BV#WW X(b  (b  (b   f[/Z[[ (b(b (b (b(bV  .5EB\`"TT tCy(0W"XX YTsTz6$ BV#WW XT  T  T  T T TT* <A# + 3&TUU V+ 3&YZZ [++  +  ++@  `dhm_d" /4#*h4Z&[[\/4 D&/cdd e/4 4g4Z[[ \/4 /4  /4  /4/4d  bf #  "(Z S4Z/\!]] ^(Z (Z |+QRlQmmo)pq s(Z d F=a6_``(Z d pq s(Z(Z (Z  !(Z(ZV +)=(>?"JJ J J@J> 0 1 `e" H sH*>?? @H 4g4Z[[ \HH  H  H H4:#S /:c:VVCV  [,P+QR# Q Q Q  Q QS Q  V'S&TU# ? ? 3&VWW X ? ?  ?  ?V ?rQ