\jGdZddlZddlZddlmZddlmZmZmZddl Z ddl m Z m Z m Z mZmZmZmZmZmZmZmZmZddlmZddlmZmZdd lmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&dd l'm(Z(m)Z)dd l*m+Z+dd l,m-Z-m.Z.e&d Z/e&dZ0e/jce0de&dZ2e/jce2dee3e(dfZ4ede3de3dzde3dzdeefdZ5e/jmdgd drdee3dze(dfdee3dze)dd fd!e-d"ee3dze)d#fd$ed%e d&ed'ed(e"de.d)ee7e)d*d+fde!ddfd,Z8e/jmd-d.d/id0d1g2 dsde4d3ee9e3e(d4fd5ee3dze)d6d7d8fd$ed&ed9ee:dze)d:d;fde.de!ddfd<Z;e/jmd=d.d/id>d?g2 dtde4d3ee9e3e(d@fd5ee3dze)d6d7d8fd$ed&ede.de!ddfdAZe0jmdgdUdde ddddfdee3dze(dVfd!e-dWee?e)dXddYe dZ[fd\ee?dze)d]dd^[fd"ee3dze)d_fde.de!ddfd`Z@e0jmdadbg dude.de!ddfdcZAe0jmdddeg dwdfee3e(dgfdPee7e)dQdRdSfde.de!ddf dhZBdie3e9e3zde3fdjZCdede3fdkZDe2jmdadlg dude4de.de!ddfdmZEe2jmdJdng dude4doee?e(dpfde.de!ddf dqZFy)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#Ktj|||} ||jy#|jwxYww)zIReattach to a sandbox and close the HTTP client when the command is done.r+r,N)rconnectclose)r*r+r,sandboxs N/root/.hermes/venv/lib/python3.12/site-packages/huggingface_hub/cli/sandbox.py_connectr4Bs6oojIUKG   sA1AAAcreate)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 tj} ||nt} ||||r td|s|r tdtj|| | j t ||| | }tjd|j|j|tj| z dd tjd |jd tjd |jd ytj |xst|xsd| t ||t ||t|| | |  }|jtjd|j|j tj| z ddtjd |jd tjd |jd y)aCreate 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!!$)5IPPc8,-Q  ?svvCKKdW[W`W`WbejWjknVoopTqr 7x?OPQ 6svvhbABnn$}$ #x (g|4f%) 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 dtddfd}dtddfd} t|||5} | jt|t |||||| d} ddd j rGt jd |d tjj| jxsd | jd k7r=tjj| j| j d y#1swYxYw)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~tjj|tjjyN)sysstdoutwriteflushrYs r3 write_stdoutz"sandbox_exec..write_stdout$  rQc~tjj|tjjyr[)r\stderrr^r_r`s r3 write_stderrz"sandbox_exec..write_stderrrbrQr/F)r:cwdtimeout on_stdout on_stderrcheckzCommand timed out after zs.|)coderr) strr4runlistr timed_outr#errorclick exceptionsExit exit_code) r*rUrVr:r<rWr+r,rarer2rJs r3 sandbox_execrvs43434 *  ?  7 Mc8, ""    ,\N"=>##)9)9)@S#AA 1##V=M=M=Y)9)9#aa_`#aa   s ,C;;Dspawnz;hf sandbox spawn -- python -m http.server 8000z8hf sandbox spawn -w /app -- uvicorn app:appz%The command to run in the background.c\t|||5}|jt|t|||d}dddt j d|j t jd|dt jd |d |j dy#1swYkxYw) 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:rf backgroundNzProcess startedr2pidz+List processes with `hf sandbox process ls rFz&Stop it with `hf sandbox process kill  )r4rnrorr#rJr{rL) r*rUrVr:r<r+r,r2r)s r3 sandbox_spawnr}s, *  ?m7++d7msH1MSZgk+lmJJ *'++FHH::,b IJHH5j\7;;-r RS mms )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 :.cdtdttdztffd}||\}}||\}}|du|duk(r td|4t|||5} | jj ||dddn7|Jt|||5} | jj ||dddtjd||y#1swY"xYw#1swY.xYw) zCCopy a file between the local machine and a sandbox (docker-style).refr-Ncd|vr8|jds'|jdd\}}t|dkDr||fSd|fS)N:)./~r) startswithsplitlen)rr*paths r3parsezsandbox_cp..parsesL #:cnn_="yya0 J:"!4''SyrQzHExactly one of SRC and DST must be a sandbox path (:).r/Copied)rr) rmtuplerr4filesdownloaduploadr#rJ) rrr+r,r src_sandboxsrc_path dst_sandboxdst_pathr2s r3 sandbox_cprs35tS1"#JK!#JKt!45abb kYe D 7 MM " "8X 6 7 7&&& kYe D 5 MM 8 4 5JJxSc*  7 7 5 5sCCCC&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.ct|}|rt|jddgtdi|}|st j dyt j dt|d | |D]3}|j|j|jj 5t jd t| y| tdt||\}} t|vr@ t!|||5} | j#dddt jd|y|j)|| }|j*xsij-t.t0k(rdt j d|d| |j|j|jj t jd|y t!|||5} | j#dddt jd|y#1swYxYw#t$$r} tt'| | d} ~ wwxYw#1swYTxYw#t$$r} tt'| | d} ~ wwxYw)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)rro list_jobsr r#textconfirmr cancel_jobrCownerr(rJrrrr4rrrm inspect_jobrgetr r ) r*rrr+r,apirjobsidnsr2es r3 sandbox_killr s 5 !C CMM)\)BM[^K_ktMuv HH, -  jT +lmsvw DC NN#&&CIINNN C D $H99H>I I I0I++I0)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 tj}|xst}t||xsd||||nt||}|j} |j } t jd| ||xsd| dtj|z ddt jd | d t jd | d y) 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 jt|}i}|jdtti|D]}|jxsij t }|s)t|jtr |jni}|j|||jxs |j|j|j dddd}|dxxd z cc<t|j}t!j"|d |st!j$d yt!j$d y)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_idr8rovaluesr#tablerL) r+r,rpoolsrr{r:inforowss r3pool_lsrzs 5 !C')E}}Iz96MYb}czzR$$Z0 !+COOT!Bcoo ))9S\\**GGNB7     W     DIId4  <= HIrQz delete | rmz hf sandbox pool delete rzPool id to delete.c t|}t|jddgttt |i|}|s%t |tjd|dytjdt|d |d | |D]3}|j|j|jj 5t |tjd |t|y)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)rrorr r r rr#rrrrrCrr(rJ)rrr+r,rrrs r3 pool_deleters 5 !C  |, :w?   E '" .wir:;KK*SZL(:7)C_`fij@ cff ?@gJJ~'CJGrQcmdcHt|tr|Sdj|S)Nr|)rrmjoin)rs r3_fmt_cmdrsS#&39CHHSM9rQcX|jry|jdSd|jdS)Nrunningexitedzexited ())rru)r)s r3 _fmt_statusrs3((08UARAR@SST6UUrQz"hf sandbox process ls c~t|||5}|j}dddDcgc].}|jt|t |j d0}}t j|d|st jd|dyt jd|d y#1swYxYwcc}w) 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_ `QRAEE[^HQUUO L `D `IId5!  4ZL LM ::,hOP(( `sB.3B:.B7z*hf sandbox process kill r{z.The pid as printed by `hf sandbox process ls`.c t|||5}tfd|jDd}|tdd|d|j dddt j d|y#1swY"xYw) z/Stop a background process running in a sandbox.r/c3BK|]}|jk(s|ywr[)r{).0rr{s r3 zprocess_kill..sGa!%%3,GsNzNo process with pid z in sandbox rzProcess stoppedrz)r4nextrrrr#rJ)r*r{r+r,r2r)s ` r3 process_killrs *  ?7G7#4#4#6GN ?1#l:,aPQ Q   JJ *#> s AA99B) NNNNNNNNNNFN)NNNNNN)NNNNN)NN)NFFNN)FNN)G__doc__r\rI contextlibrtypingrrrrrhuggingface_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_clirm SandboxIdArgr4rUboolrProfloatrvr}rrintrrrrrrrrQr3rs+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