o 0iu@srddlZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlmZddlmZmZddl mZddlZddlZddlmZdd lmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCd d ZDeD\ZEZFZGd eHfd dZIeIeFddZJdddZKeKdddZLddZMddZNddZOddZPddZQd d!ZRd"d#ZSd$d%ZTd&d'ZUd(d)ZVd*d+ZWd,d-ZXd.d/ZYd0d1ZZd2d3Z[d4d5Z\d6d7Z]d8d9Z^d:d;Z_dd?Zad@dAZbdBdCZcdDdEZddFdGZedHdIZfdJdKZgdLdMZhdNdOZidPdQZjdRdSZkdTdUZldVdWZmdXdYZndZd[Zod\d]Zpdd^d_Zqd`daZrdbdcZsdddeZtdfdgZudhdiZvdjdkZwdldmZxdndoZydpdqZzdrdsZ{dtduZ|dvdwZ}dxdyZ~dzd{Zd|d}Zd~dZeeAe5e<e4goe ZddZddZddZGddde jZGddde jZGddde jZddZGdddZddZdd efddZddeHd efddZddZddZGdddeZddeHefddZded efddZe ddedeed efddZddZdS)N)contextmanager)partial)Path)OptionalUnion)mock)AcceleratorState)+check_cuda_fp8_capabilitycompare_versionsgatheris_aim_availableis_bnb_availableis_clearml_availableis_comet_ml_availableis_cuda_availableis_datasets_availableis_deepspeed_availableis_dvclive_availableis_fp8_availableis_fp16_availableis_habana_gaudi1is_hpu_availableis_import_timer_availableis_matplotlib_availableis_mlflow_availableis_mlu_availableis_mps_availableis_musa_availableis_npu_availableis_pandas_availableis_pippy_availableis_pytest_availableis_schedulefree_availableis_sdaa_availableis_swanlab_availableis_tensorboard_availableis_timm_availableis_torch_versionis_torch_xla_availableis_torchao_available*is_torchdata_stateful_dataloader_availableis_torchvision_availableis_trackio_availableis_transformer_engine_available%is_transformer_engine_mxfp8_availableis_transformers_availableis_triton_availableis_wandb_availableis_xpu_available str_to_boolcCs tr dtjtjjfStrdtjtjjfStddr&ddtjjfStr0ddddfSt r=d tj tj jfSt rJd tj tj jfSt rWd tjtjjfStrdd tjtjjfStrqd tjtjjfStr~dtjtjjfSddddfS)Nxlacudaz2.0) min_versionmpscSdSNrr<r<r<_/sda-disk/www/egybert/egybert_env/lib/python3.10/site-packages/accelerate/test_utils/testing.py[zget_backend..mlusdaamusanpuxpuhpucpucSr:r;r<r<r<r<r=r>ir?)r)torchr6 device_countmemory_allocatedrrr8current_allocated_memoryrr@r$rArrBrrCr3rDrrEr<r<r<r= get_backendSs* rKreturncKs\ddg}|D]#\}}t|tr|r|d|q|dur+|d|d|q|S)z Wraps around `kwargs` to help simplify launching from `subprocess`. Example: ```python # returns ['accelerate', 'launch', '--num_processes=2', '--device_count=2'] get_launch_command(num_processes=2, device_count=2) ``` acceleratelaunchz--N=)items isinstanceboolappend)kwargscommandkvr<r<r=get_launch_commandos rXg?) num_processesmonitor_intervalFcCsVztj|}Wn ty|}Y|Swzt|}W|Sty*td|dw)NzIf set, z must be yes or no.)osenvironKeyErrorr4 ValueError)keydefaultvalue_valuer<r<r=parse_flag_from_envs   rcRUN_SLOW)r`cCstd|S)z+Decorator that skips a test unconditionallyzTest was skipped)unittestskip test_caser<r<r=rfsrfcCttd|S)z Decorator marking a test as slow. Slow tests are skipped by default. Set the RUN_SLOW environment variable to a truthy value to run them. z test is slow)re skipUnless_run_slow_testsrgr<r<r=slowsrlcCsttdkd|S)zu Decorator marking a test that must be only ran on the CPU. These tests are skipped when a GPU is available. rFztest requires only a CPUrerj torch_devicergr<r<r= require_cpurocCttdkd|S)z Decorator marking a test that requires a hardware accelerator backend. These tests are skipped when there are no hardware accelerator available. rFtest requires a GPUrmrgr<r<r=require_non_cpurscCttot d|S)z Decorator marking a test that requires CUDA. These tests are skipped when there are no GPU available or when TorchXLA is available. rr)rerjrr)rgr<r<r= require_cudarvcCs ttr t p td|S)z Decorator marking a test that requires CUDA or HPU. These tests are skipped when there are no GPU available or when TorchXLA is available. ztest requires a GPU or HPU)rerjrr)rrgr<r<r=require_cuda_or_hpu rxcCttd|S)zn Decorator marking a test that requires XPU. These tests are skipped when there are no XPU available. test requires a XPU)rerjr3rgr<r<r= require_xpur|cCs(tot }t}t|p|d|S)z Decorator marking a test that requires CUDA or XPU. These tests are skipped when there are no GPU available or when TorchXLA is available. ztest requires a CUDA GPU or XPU)rr)r3rerj)rhcuda_condition xpu_conditionr<r<r=require_cuda_or_xpusrcCrq)zB Decorator marking a test that should be skipped for XPU. rDztest requires a non-XPUrmrgr<r<r=require_non_xpurprcCrq)zB Decorator marking a test that should be skipped for HPU. rEztest requires a non-HPUrmrgr<r<r=require_non_hpurprcCrz)zj Decorator marking a test that requires FP16. These tests are skipped when FP16 is not supported. ztest requires FP16 support)rerjrrgr<r<r= require_fp16rcCs:t}tjr ts d}trtrd}t|d|S)zh Decorator marking a test that requires FP8. These tests are skipped when FP8 is not supported. Fztest requires FP8 support) rrGr6 is_availabler rrrerj)rhfp8_is_availabler<r<r= require_fp8s  rcCsttddd|S)N>=z2.5.0z$test requires FSDP2 (torch >= 2.5.0))rerjr(rgr<r<r= require_fsdp2srcCrz)zn Decorator marking a test that requires MLU. These tests are skipped when there are no MLU available. ztest require a MLU)rerjrrgr<r<r= require_mlur}rcCrz)zp Decorator marking a test that requires SDAA. These tests are skipped when there are no SDAA available. ztest require a SDAA)rerjr$rgr<r<r= require_sdaa r}rcCrz)zp Decorator marking a test that requires MUSA. These tests are skipped when there are no MUSA available. ztest require a MUSA)rerjrrgr<r<r= require_musar}rcCrz)zn Decorator marking a test that requires NPU. These tests are skipped when there are no NPU available. ztest require a NPU)rerjrrgr<r<r= require_npur}rcCrz)z Decorator marking a test that requires MPS backend. These tests are skipped when torch doesn't support `mps` backend. z0test requires a `mps` backend support in `torch`)rerjrrgr<r<r= require_mpsrrcCsttotd|S)zv Decorator marking a test that requires transformers and datasets. These tests are skipped when they are not. z$test requires the Hugging Face suite)rerjr0rrgr<r<r=require_huggingface_suite's  rcCrz)zi Decorator marking a test that requires transformers. These tests are skipped when they are not. z&test requires the transformers library)rerjr0rgr<r<r=require_transformers1r}rcCrz)za Decorator marking a test that requires timm. These tests are skipped when they are not. ztest requires the timm library)rerjr'rgr<r<r= require_timm8r}rcCrz)zh Decorator marking a test that requires torchvision. These tests are skipped when they are not. z%test requires the torchvision library)rerjr,rgr<r<r=require_torchvision?r}rcCrz)zc Decorator marking a test that requires triton. These tests are skipped when they are not. z test requires the triton library)rerjr1rgr<r<r=require_tritonFr}rcCrz)zi Decorator marking a test that requires schedulefree. These tests are skipped when they are not. z&test requires the schedulefree library)rerjr#rgr<r<r=require_schedulefreeMr}rcCrz)zi Decorator marking a test that requires bitsandbytes. These tests are skipped when they are not. z&test requires the bitsandbytes library)rerjrrgr<r<r= require_bnbTr}rcCsttddd|S)zp Decorator marking a test that requires TPUs. These tests are skipped when there are no TPUs available. T) check_is_tpuztest requires TPUrerjr)rgr<r<r= require_tpu[srcCstt d|S)z Decorator marking a test as requiring an environment without TorchXLA. These tests are skipped when TorchXLA is available. z%test requires an env without TorchXLArrgr<r<r=require_non_torch_xlabrtrcCsttdko tdkd|S)z Decorator marking a test that requires a single device. These tests are skipped when there is no hardware accelerator available or number of devices is more than one. rFr9z)test requires a single device accelerator)rerjrnrHrgr<r<r=require_single_devicejs rcCttjdkd|S)z Decorator marking a test that requires CUDA on a single GPU. These tests are skipped when there are no GPU available or number of GPUs is more than one. r9rrrerjrGr6rHrgr<r<r=require_single_gputrwrcCr)z Decorator marking a test that requires CUDA on a single XPU. These tests are skipped when there are no XPU available or number of xPUs is more than one. r9r{rerjrGrDrHrgr<r<r=require_single_xpu|rwrcCsttdkd|S)z Decorator marking a test that requires a multi-device setup. These tests are skipped on a machine without multiple devices. r9z,test requires multiple hardware accelerators)rerjrHrgr<r<r=require_multi_devicertrcCttjdkd|S)z Decorator marking a test that requires a multi-GPU setup. These tests are skipped on a machine without multiple GPUs. r9ztest requires multiple GPUsrrgr<r<r=require_multi_gpurwrcCr)z Decorator marking a test that requires a multi-XPU setup. These tests are skipped on a machine without multiple XPUs. r9ztest requires multiple XPUsrrgr<r<r=require_multi_xpurwrcCs ttsto tdkd|S)z Decorator marking a test that requires a multi-GPU setup. These tests are skipped on a machine without multiple GPUs or XPUs. r9z#test requires multiple GPUs or XPUs)rerjrr3rHrgr<r<r=require_multi_gpu_or_xpuryrcCrz)z| Decorator marking a test that requires DeepSpeed installed. These tests are skipped when DeepSpeed isn't installed ztest requires DeepSpeed)rerjrrgr<r<r=require_deepspeedr}rcCs"ttddo tdddd|S)zn Decorator marking a test that requires TP installed. These tests are skipped when TP isn't installed rz2.3.0 transformersz4.52.0zGtest requires torch version >= 2.3.0 and transformers version >= 4.52.0)rerjr(r rgr<r<r= require_tps rcCs0|dur tt|dSttd|d||S)z Decorator marking that a test requires a particular torch version to be tested. These tests are skipped when an installed torch version is less than the required one. N)versionrztest requires torch version >= )rrequire_torch_min_versionrerjr()rhrr<r<r=rs rcCrz)z Decorator marking a test that requires tensorboard installed. These tests are skipped when tensorboard isn't installed ztest requires Tensorboard)rerjr&rgr<r<r=require_tensorboardrrcCrz)zt Decorator marking a test that requires wandb installed. These tests are skipped when wandb isn't installed ztest requires wandb)rerjr2rgr<r<r= require_wandbr}rcCrz)zx Decorator marking a test that requires trackio installed. These tests are skipped when trackio isn't installed ztest requires trackio)rerjr-rgr<r<r=require_trackior}rcCrz)zz Decorator marking a test that requires comet_ml installed. These tests are skipped when comet_ml isn't installed ztest requires comet_ml)rerjrrgr<r<r=require_comet_mlr}rcCrz)zp Decorator marking a test that requires aim installed. These tests are skipped when aim isn't installed ztest requires aim)rerjr rgr<r<r= require_aimr}rcCrz)zx Decorator marking a test that requires clearml installed. These tests are skipped when clearml isn't installed ztest requires clearml)rerjrrgr<r<r=require_clearmlr}rcCrz)zx Decorator marking a test that requires dvclive installed. These tests are skipped when dvclive isn't installed ztest requires dvclive)rerjrrgr<r<r=require_dvcliver}rcCrz)zx Decorator marking a test that requires swanlab installed. These tests are skipped when swanlab isn't installed ztest requires swanlab)rerjr%rgr<r<r=require_swanlabr}rcCrz)zv Decorator marking a test that requires pandas installed. These tests are skipped when pandas isn't installed ztest requires pandas)rerjr rgr<r<r=require_pandasr}rcCrz)zv Decorator marking a test that requires mlflow installed. These tests are skipped when mlflow isn't installed ztest requires mlflow)rerjrrgr<r<r=require_mlflowr}rcCru)z Decorator marking a test that requires pippy installed. These tests are skipped when pippy isn't installed It is also checked if the test is running on a Gaudi1 device which doesn't support pippy. ztest requires pippy)rerjr!rrgr<r<r= require_pippyrwrcCrz)z Decorator marking a test that requires tuna interpreter installed. These tests are skipped when tuna isn't installed ztest requires tuna interpreter)rerjrrgr<r<r=require_import_timerrrcCrz)z Decorator marking a test that requires transformers engine installed. These tests are skipped when transformers engine isn't installed z!test requires transformers engine)rerjr.rgr<r<r=require_transformer_enginerrcCrz)z Decorator marking a test that requires transformers engine MXFP8 block scaling available. These tests are skipped when transformers engine MXFP8 block scaling isn't available z5test requires transformers engine MXFP8 block scaling)rerjr/rgr<r<r= require_transformer_engine_mxfp8 s rcCrz)zx Decorator marking a test that requires torchao installed. These tests are skipped when torchao isn't installed ztest requires torchao)rerjr*rgr<r<r=require_torchao*r}rcCrz)z Decorator marking a test that requires matplotlib installed. These tests are skipped when matplotlib isn't installed ztest requires matplotlib)rerjrrgr<r<r=require_matplotlib1rrcCri)z Decorator marking that a test requires at least one tracking library installed. These tests are skipped when none are installed zYtest requires at least one tracker to be available and for `comet_ml` to not be installed)rerj_atleast_one_tracker_availablergr<r<r=require_trackers?s rcCrz)z Decorator marking a test that requires torchdata.stateful_dataloader. These tests are skipped when torchdata with stateful_dataloader module isn't installed. z+test requires torchdata.stateful_dataloader)rerjr+rgr<r<r=%require_torchdata_stateful_dataloaderJs rcCs"trddl}|jd|S|S)a Decorator marking a test with order(1). When pytest-order plugin is installed, tests marked with this decorator are guaranteed to run first. This is especially useful in some test settings like on a Gaudi instance where a Gaudi device can only be used by a single process at a time. So we make sure all tests that run in a subprocess are launched first, to avoid device allocation conflicts. If pytest is not installed, test will be returned as is. rNr9)r"pytestmarkorder)rhrr<r<r= run_firstVs rc@s4eZdZdZdZeddZeddZddZd S) TempDirTestCasea A TestCase class that keeps a single `tempfile.TemporaryDirectory` open for the duration of the class, wipes its data at the start of a test, and then destroys it at the end of the TestCase. Useful for when a class or API requires a single constant folder throughout it's use, such as Weights and Biases The temporary directory location will be stored in `self.tmpdir` TcCstt|_dS)zECreates a `tempfile.TemporaryDirectory` and stores it in `cls.tmpdir`N)rtempfilemkdtemptmpdirclsr<r<r= setUpClassuszTempDirTestCase.setUpClasscCs"tj|jrt|jdSdS)z1Remove `cls.tmpdir` after test suite has finishedN)r[pathexistsrshutilrmtreerr<r<r= tearDownClasszszTempDirTestCase.tearDownClasscCsD|jr|jdD]}|r|q |rt|q dSdS)zt|ttfr |n|g|_|jD] }|||jqdS)aQ Add custom mocks for tests that should be repeated on each test. Should be called during `MockingTestCase.setUp`, after `super().setUp()`. Args: mocks (`mock.Mock` or list of `mock.Mock`): Mocks that should be added to the `TestCase` after `TestCase.setUpClass` has been run N)rQtuplelistrstart addCleanupstop)rrmr<r<r= add_mockss  zMockingTestCase.add_mocksN) rrrrrrMockrrr<r<r<r=rs"rcCs`t}|d|j}t|}|d}t|jdD] }t |||s-dSq dS)NrFT) r clonetodevicer rFrangeshaperGequal)tensorstatetensorsir<r<r=are_the_same_tensorss  rc@seZdZddZdS) _RunOutputcCs||_||_||_dSN) returncodestdoutstderr)rrrrr<r<r=__init__s z_RunOutput.__init__N)rrrrr<r<r<r=rs rcs& |IdH}|r||ndSqr)readline)streamcallbackliner<r<r= _read_streams rc s|r tdd|tj|dg|ddR|tjjtjj|dIdH}ggd fdd tjtt|j fd d tt|j fd d g|d IdHt |IdHS)Nz Running:  rr9)stdinrrenvcs2|d}||st|||ddSdS)Nutf-8)file)decoderstriprSprint)rsinkpipelabel)quietr<r=tees  z_stream_subprocess..teec|tjddS)Nzstdout:r )sysrl)outr r<r=r>z$_stream_subprocess..cr)Nzstderr:r)rrr)errr r<r=r>r)timeout)r) rjoinasynciocreate_subprocess_exec subprocessPIPEwait create_taskrrrr)cmdrrrr echopr<)rrr r r=_stream_subprocesss.  r!Trc Cst|D]\}}t|trt|||<qt}|t||||||d} d|} | j dkrCd| j } t d| d| j d| | S)N)rrrr rrr 'z' failed with returncode z, The combined stderr from workers follows: ) enumeraterQrstrrget_event_looprun_until_completer!rrr RuntimeError) rrrrr rrcloopresultcmd_strrr<r<r=execute_subprocess_asyncs"     r.cCs*tjdd}tdd|dtj}t|S)z Returns an int value of worker's numerical id under `pytest-xdist`'s concurrent workers `pytest -n N` regime, or 0 if `-n 1` or `pytest-xdist` isn't being used. PYTEST_XDIST_WORKERgw0z^gwrr)r[r\getresubMint)workerr<r<r=pytest_xdist_worker_idsr7cCsd}t}||S)z Returns a port number that can be fed to `torch.distributed.launch`'s `--master_port` argument. Under `pytest-xdist` it adds a delta number based on a worker id so that concurrent tests don't try to use the same port at once. is     /               ! !  )