






# HF Trainer benchmarking tool
#
# This tool can be used to run and compare multiple dimensions of the HF Trainers args.
#
# It then prints a report once in github format with all the information that needs to be shared
# with others and second time in a console-friendly format, so it's easier to use for tuning things up.
#
# The main idea is:
#
#     ./trainer-benchmark.py --base-cmd '<cmd args that don't change>' \
#     --variations '--tf32 0|--tf32 1' '--fp16 0|--fp16 1|--bf16 1' \
#     --target-metric-key train_samples_per_second
#
# The variations can be any command line argument that you want to compare and not just dtype as in
# the example.
#
# --variations allows you to compare variations in multiple dimensions.
#
# as the first dimention has 2 options and the second 3 in our example, this will run the trainer 6
# times adding one of:
#
#    1. --tf32 0 --fp16 0
#    2. --tf32 0 --fp16 1
#    3. --tf32 0 --bf16 1
#    4. --tf32 1 --fp16 0
#    5. --tf32 1 --fp16 1
#    6. --tf32 1 --bf16 1
#
# and print the results. This is just a cartesian product - and more than 2 dimensions can be used.
#
# If you want to rely on defaults, this:
#    --variations '--tf32 0|--tf32 1' '--fp16 0|--fp16 1|--bf16 1'
# is identical to this:
#    --variations '--tf32 0|--tf32 1' '|--fp16|--bf16'
#
# the leading empty variation in the 2nd dimension is a valid variation.
#
# So here we get the following 6 variations:
#
#    1. --tf32 0
#    2. --tf32 0 --fp16
#    3. --tf32 0 --bf16
#    4. --tf32 1
#    5. --tf32 1 --fp16
#    6. --tf32 1 --bf16
#
# In this particular case we don't know what the default tf32 setting is as it's normally
# pytorch-version dependent). That's why it's best to do an explicit setting of each variation:
#    `--tf32 0|--tf32 1`
#
# Here is a full example of a train:
#
# CUDA_VISIBLE_DEVICES=0 python ./scripts/benchmark/trainer-benchmark.py \
# --base-cmd \
# ' examples/pytorch/translation/run_translation.py --model_name_or_path t5-small \
# --output_dir output_dir --do_train --label_smoothing 0.1 --logging_strategy no \
# --save_strategy no --per_device_train_batch_size 32 --max_source_length 512 \
# --max_target_length 512 --num_train_epochs 1 --overwrite_output_dir \
# --source_lang en --target_lang ro --dataset_name wmt16 --dataset_config "ro-en" \
# --source_prefix "translate English to Romanian: " --warmup_steps 50 \
# --max_train_samples 20000 --dataloader_num_workers 2 ' \
# --target-metric-key train_samples_per_second --repeat-times 1 --variations \
# '|--fp16|--bf16' '--tf32 0|--tf32 1' --report-metric-keys train_loss \
# --repeat-times 1 --base-variation '--tf32 0'
#
# and here is a possible output:
#
#
# | Variation       |     Train |   Diff |   Train |
# |                 |   samples |      % |    loss |
# |                 |       per |        |         |
# |                 |    second |        |         |
# |:----------------|----------:|-------:|--------:|
# | --tf32 0        |    285.11 |      0 |    2.51 |
# | --tf32 1        |    342.09 |     20 |    2.51 |
# | --fp16 --tf32 0 |    423.49 |     49 |    2.51 |
# | --fp16 --tf32 1 |    423.13 |     48 |    2.51 |
# | --bf16 --tf32 0 |    416.80 |     46 |    2.52 |
# | --bf16 --tf32 1 |    415.87 |     46 |    2.52 |
#
#
# So you can quickly compare the different outcomes.
#
# Typically running each experiment once is enough, but if the environment is unstable you can
# re-run each multiple times, e.g., 3 using --repeat-times 3 and it will report the averaged results.
#
# By default it'll use the lowest result as the base line to use as 100% and then compare the rest to
# it as can be seen from the table above, but you can also specify which combination is the one to use as
# the baseline, e.g., to change to another entry use: --base-variation '--tf32 1 --fp16 0'
#
# --target-metric-key is there to tell the program which metrics to compare - the different metric keys are
# inside output_dir/all_results.json. e.g., to measure eval performance instead of train use:
#    --target-metric-key eval_samples_per_second
# but of course you will need to adjust the --base-cmd value in the example to perform evaluation as
# well (as currently it doesn't)
#

import argparse
import datetime
import io
import itertools
import json
import math
import os
import platform
import re
import shlex
import subprocess
import sys
from pathlib import Path
from statistics import fmean

import pandas as pd
import torch
from tqdm import tqdm

import transformers


A__           =							float("""nan""")
class   _lowerCAmelCase		:







							def __init__(				self     :    Union[str, Any]	,					__snake_case     :    Any		):
										lowerCamelCase						:Optional[int]						  =     sys.stdout
										lowerCamelCase						:Optional[int]						  =     open(__snake_case	,					'''a'''		)







							def __getattr__(				self     :    str	,					__snake_case     :    List[str]		):
										return getattr(self.stdout	,					__snake_case		)







							def 				snake_case  (				self     :    Optional[int]	,					__snake_case     :    Dict		):
										self.stdout.write(__snake_case		)
										# strip tqdm codes
										self.file.write(re.sub(R'''^.*\r'''	,					''''''	,					__snake_case	,					0	,					re.M		)		)





def  _lowerCamelCase					(   a_				: Tuple=80						,			a_				: str=False):
			lowerCamelCase						:Tuple						  =     []

			# deal with critical env vars
			lowerCamelCase						:Dict						  =     ['''CUDA_VISIBLE_DEVICES''']
			for key in env_keys:
						lowerCamelCase						:Optional[int]						  =     os.environ.get(a_						,			a_)
						if val is not None:
									cmd.append(F"{key}={val}")

    # python executable (not always needed if the script is executable)
			lowerCamelCase						:str						  =     sys.executable if full_python_path else sys.executable.split('''/''')[-1]
			cmd.append(a_)

			# now the normal args
			cmd += list(map(shlex.quote						,			sys.argv))

			# split up into up to MAX_WIDTH lines with shell multi-line escapes
			lowerCamelCase						:List[Any]						  =     []
			lowerCamelCase						:Optional[int]						  =     ''''''
			while len(a_) > 0:
						current_line += F"{cmd.pop(0)} "
						if len(a_) == 0 or len(a_) + len(cmd[0]) + 1 > max_width - 1:
									lines.append(a_)
									lowerCamelCase						:List[Any]						  =     ''''''
			return "\\\n".join(a_)





def  _lowerCamelCase					(   a_				: str						,			a_				: Optional[int]):
			# unwrap multi-line input
			lowerCamelCase						:Optional[int]						  =     re.sub(R'''[\\\n]+'''						,			''' '''						,			args.base_cmd)

			# remove --output_dir if any and set our own
			lowerCamelCase						:int						  =     re.sub('''--output_dir\s+[^\s]+'''						,			''''''						,			args.base_cmd)
			args.base_cmd += F" --output_dir {output_dir}"

			# ensure we have --overwrite_output_dir
			lowerCamelCase						:Optional[Any]						  =     re.sub('''--overwrite_output_dir\s+'''						,			''''''						,			args.base_cmd)
			args.base_cmd += " --overwrite_output_dir"

			return [sys.executable] + shlex.split(args.base_cmd)





def  _lowerCamelCase					(   a_				: Tuple						,			a_				: List[str]						,			a_				: str						,			a_				: List[Any]						,			a_				: List[str]						,			a_				: List[Any]						,			a_				: Tuple):
			# Enable to debug everything but the run itself, to do it fast and see the progress.
			# This is useful for debugging the output formatting quickly - we can remove it later once
			# everybody is happy with the output
			if 0:
						import random
						from time import sleep

						sleep(0)
						return dict(
						    {k: random.uniform(0						,			1_00) for k in metric_keys}						,			**{target_metric_key: random.choice([nan, 10.31, 100.2, 55.6_666, 222.22_222_222])}						,			)

			lowerCamelCase						:Union[str, Any]						  =     subprocess.run(a_						,			capture_output=a_						,			text=a_)

			if verbose:
						print('''STDOUT'''						,			result.stdout)
						print('''STDERR'''						,			result.stderr)

			# save the streams
			lowerCamelCase						:Dict						  =     variation.replace(''' '''						,			'''-''')
			with open(Path(a_) / F"log.{prefix}.stdout.txt"						,			'''w''') as f:
						f.write(result.stdout)
			with open(Path(a_) / F"log.{prefix}.stderr.txt"						,			'''w''') as f:
						f.write(result.stderr)

			if result.returncode != 0:
						if verbose:
									print('''failed''')
						return {target_metric_key: nan}

			with io.open(F"{output_dir}/all_results.json"						,			'''r'''						,			encoding='''utf-8''') as f:
						lowerCamelCase						:List[str]						  =     json.load(a_)

			# filter out just the keys we want
			return {k: v for k, v in metrics.items() if k in metric_keys}





def  _lowerCamelCase					(   a_				: List[str]						,			a_				: List[str]						,			a_				: Optional[Any]						,			a_				: List[Any]						,			a_				: Dict						,			a_				: int						,			a_				: Any						,			a_				: str						,			a_				: List[str]						,			a_				: int						,			):
			lowerCamelCase						:Dict						  =     []
			lowerCamelCase						:List[Any]						  =     []
			lowerCamelCase						:Any						  =     F"{id}: {variation:<{longest_variation_len}}"
			lowerCamelCase						:int						  =     F"{preamble}: "
			lowerCamelCase						:str						  =     set(report_metric_keys + [target_metric_key])
			for i in tqdm(range(a_)						,			desc=a_						,			leave=a_):
						lowerCamelCase						:Union[str, Any]						  =     process_run_single(
						    a_						,			a_						,			a_						,			a_						,			a_						,			a_						,			a_)
						lowerCamelCase						:Optional[Any]						  =     single_run_metrics[target_metric_key]
						if not math.isnan(a_):
									metrics.append(a_)
									results.append(a_)
									outcome += "✓"
						else:
									outcome += "✘"
			lowerCamelCase						:List[str]						  =     F"\33[2K\r{outcome}"
			if len(a_) > 0:
						lowerCamelCase						:Tuple						  =     {k: fmean([x[k] for x in metrics]) for k in metrics[0].keys()}
						lowerCamelCase						:Union[str, Any]						  =     round(mean_metrics[target_metric_key]						,			2)
						lowerCamelCase						:Optional[int]						  =     F"{outcome} {mean_target}"
						if len(a_) > 1:
									results_str += F" {tuple(round(a_						,			2) for x in results)}"
						print(a_)
						lowerCamelCase						:Union[str, Any]						  =     variation
						return mean_metrics
			else:
						print(a_)
						return {variation_key: variation, target_metric_key: nan}





def  _lowerCamelCase					(   ):
			lowerCamelCase						:List[str]						  =     torch.cuda.get_device_properties(torch.device('''cuda'''))
			return F"\nDatetime    : {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}\n\nSoftware:\ntransformers: {transformers.__version__}\ntorch       : {torch.__version__}\ncuda        : {torch.version.cuda}\npython      : {platform.python_version()}\n\nHardware:\n{torch.cuda.device_count()} GPUs      : {properties.name}, {properties.total_memory/2**30:0.2f}GB\n"





def  _lowerCamelCase					(   a_				: int						,			a_				: Any						,			a_				: str						,			a_				: Optional[Any]						,			a_				: Optional[Any]):
			lowerCamelCase						:Any						  =     pd.DataFrame(a_)
			lowerCamelCase						:Any						  =     '''variation'''
			lowerCamelCase						:List[Any]						  =     '''diff_%'''

			lowerCamelCase						:Any						  =     nan
			if base_variation is not None and len(df[df[variation_key] == base_variation]):
						# this may still return nan
						lowerCamelCase						:Tuple						  =     df.loc[df[variation_key] == base_variation][target_metric_key].item()
			if math.isnan(a_):
						# as a fallback, use the minimal value as the sentinel
						lowerCamelCase						:Optional[int]						  =     df.loc[df[target_metric_key] != nan][target_metric_key].min()

			# create diff column if possible
			if not math.isnan(a_):
						lowerCamelCase						:Dict						  =     df.apply(
						    lambda a_: round(1_00 * (r[target_metric_key] - sentinel_value) / sentinel_value)
						    if not math.isnan(r[target_metric_key])
						    else 0						,			axis='''columns'''						,			)

			# re-order columns
			lowerCamelCase						:Tuple						  =     [variation_key, target_metric_key, diff_key, *report_metric_keys]
			lowerCamelCase						:Dict						  =     df.reindex(a_						,			axis='''columns''')  # reorder cols

			# capitalize
			lowerCamelCase						:List[str]						  =     df.rename(str.capitalize						,			axis='''columns''')

			# make the cols as narrow as possible
			lowerCamelCase						:Optional[Any]						  =     df.rename(lambda a_: c.replace('''_'''						,			'''<br>''')						,			axis='''columns''')
			lowerCamelCase						:Union[str, Any]						  =     df.rename(lambda a_: c.replace('''_'''						,			'''\n''')						,			axis='''columns''')

			lowerCamelCase						:Any						  =     ['''''', '''Copy between the cut-here-lines and paste as is to github or a forum''']
			report += ["----------8<-----------------8<--------"]
			report += ["*** Results:", df_github.to_markdown(index=a_						,			floatfmt='''.2f''')]
			report += ["```"]
			report += ["*** Setup:", get_versions()]
			report += ["*** The benchmark command line was:", get_original_command()]
			report += ["```"]
			report += ["----------8<-----------------8<--------"]
			report += ["*** Results (console):", df_console.to_markdown(index=a_						,			floatfmt='''.2f''')]

			print('''\n\n'''.join(a_))





def  _lowerCamelCase					(   ):
			lowerCamelCase						:Dict						  =     argparse.ArgumentParser()
			parser.add_argument(
			    '''--base-cmd'''						,			default=a_						,			type=a_						,			required=a_						,			help='''Base cmd'''						,			)
			parser.add_argument(
			    '''--variations'''						,			default=a_						,			type=a_						,			nargs='''+'''						,			required=a_						,			help='''Multi-dimensional variations, example: \'|--fp16|--bf16\' \'|--tf32\''''						,			)
			parser.add_argument(
			    '''--base-variation'''						,			default=a_						,			type=a_						,			help='''Baseline variation to compare to. if None the minimal target value will be used to compare against'''						,			)
			parser.add_argument(
			    '''--target-metric-key'''						,			default=a_						,			type=a_						,			required=a_						,			help='''Target metric key in output_dir/all_results.json, e.g., train_samples_per_second'''						,			)
			parser.add_argument(
			    '''--report-metric-keys'''						,			default=''''''						,			type=a_						,			help='''Report metric keys - other metric keys from output_dir/all_results.json to report, e.g., train_loss. Use a single argument e.g., \'train_loss train_samples'''						,			)
			parser.add_argument(
			    '''--repeat-times'''						,			default=1						,			type=a_						,			help='''How many times to re-run each variation - an average will be reported'''						,			)
			parser.add_argument(
			    '''--output_dir'''						,			default='''output_benchmark'''						,			type=a_						,			help='''The output directory where all the benchmark reports will go to and additionally this directory will be used to override --output_dir in the script that is being benchmarked'''						,			)
			parser.add_argument(
			    '''--verbose'''						,			default=a_						,			action='''store_true'''						,			help='''Whether to show the outputs of each run or just the benchmark progress'''						,			)
			lowerCamelCase						:Optional[Any]						  =     parser.parse_args()

			lowerCamelCase						:List[Any]						  =     args.output_dir
			Path(a_).mkdir(exist_ok=a_)
			lowerCamelCase						:List[str]						  =     get_base_command(a_						,			a_)

			# split each dimension into its --foo variations
			lowerCamelCase						:int						  =     [list(map(str.strip						,			re.split(R'''\|'''						,			a_))) for x in args.variations]
			# build a cartesian product of dimensions and convert those back into cmd-line arg strings,
			# while stripping white space for inputs that were empty
			lowerCamelCase						:Optional[int]						  =     list(map(str.strip						,			map(''' '''.join						,			itertools.product(*a_))))
			lowerCamelCase						:Tuple						  =     max(len(a_) for x in variations)

			# split wanted keys
			lowerCamelCase						:Tuple						  =     args.report_metric_keys.split()

			# capture prints into a log file for convenience
			lowerCamelCase						:Dict						  =     F"benchmark-report-{datetime.datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}.txt"
			print(F"\nNote: each run's output is also logged under {output_dir}/log.*.std*.txt")
			print(F"and this script's output is also piped into {report_fn}")

			lowerCamelCase						:Optional[Any]						  =     Tee(a_)

			print(F"\n*** Running {len(a_)} benchmarks:")
			print(F"Base command: {' '.join(a_)}")

			lowerCamelCase						:Dict						  =     '''variation'''
			lowerCamelCase						:Optional[Any]						  =     []
			for id, variation in enumerate(tqdm(a_						,			desc='''Total completion: '''						,			leave=a_)):
						lowerCamelCase						:int						  =     base_cmd + variation.split()
						results.append(
						    process_run(
						        id + 1						,			a_						,			a_						,			a_						,			a_						,			args.target_metric_key						,			a_						,			args.repeat_times						,			a_						,			args.verbose						,			))

			process_results(a_						,			args.target_metric_key						,			a_						,			args.base_variation						,			a_)


if __name__ == "__main__":
			main()




import os
from typing import Optional

import fsspec
from fsspec.archive import AbstractArchiveFileSystem
from fsspec.utils import DEFAULT_BLOCK_SIZE
class   _lowerCAmelCase		(     __SCREAMING_SNAKE_CASE				):
							_UpperCAmelCase						    =     ''
							_UpperCAmelCase						    =     (
							    None  # protocol passed in prefix to the url. ex: "gzip", for gzip://file.txt::http://foo.bar/file.txt.gz
							)
							_UpperCAmelCase						    =     None  # compression type in fsspec. ex: "gzip"
							_UpperCAmelCase						    =     None  # extension of the filename to strip. ex: "".gz" to get file.txt from file.txt.gz







							def __init__(				self     :    str	,					__snake_case     :    str = ""	,					__snake_case     :    Optional[str] = None	,					__snake_case     :    Optional[dict] = None	,					**__snake_case     :    Dict		):
										super().__init__(self	,					**__snake_case		)
										# always open as "rb" since fsspec can then use the TextIOWrapper to make it work for "r" mode
										lowerCamelCase						:Optional[Any]						  =     fsspec.open(
										    __snake_case	,					mode='''rb'''	,					protocol=__snake_case	,					compression=self.compression	,					client_kwargs={
										        '''requote_redirect_url''': False,  # see https://github.com/huggingface/datasets/pull/5459
										        '''trust_env''': True,  # Enable reading proxy env variables.
										        **(target_options or {}).pop('''client_kwargs'''	,					{}		),  # To avoid issues if it was already passed.
										    }	,					**(target_options or {})	,					)
										lowerCamelCase						:List[str]						  =     os.path.basename(self.file.path.split('''::'''		)[0]		)
										lowerCamelCase						:Dict						  =     (
										    self.compressed_name[: self.compressed_name.rindex('''.'''		)]
										    if '''.''' in self.compressed_name
										    else self.compressed_name
										)
										lowerCamelCase						:List[str]						  =     None







							@classmethod
							def 				snake_case  (				cls     :    Any	,					__snake_case     :    Any		):
										# compressed file paths are always relative to the archive root
										return super()._strip_protocol(__snake_case		).lstrip('''/'''		)







							def 				snake_case  (				self     :    Any		):
										if self.dir_cache is None:
													lowerCamelCase						:Optional[Any]						  =     {**self.file.fs.info(self.file.path		), '''name''': self.uncompressed_name}
													lowerCamelCase						:Optional[Any]						  =     {f['''name''']: f}







							def 				snake_case  (				self     :    Union[str, Any]	,					__snake_case     :    str		):
										return self.file.open().read()







							def 				snake_case  (				self     :    Optional[int]	,					__snake_case     :    str	,					__snake_case     :    str = "rb"	,					__snake_case     :    int=None	,					__snake_case     :    Optional[int]=True	,					__snake_case     :    str=None	,					**__snake_case     :    str	,					):
										lowerCamelCase						:List[str]						  =     self._strip_protocol(__snake_case		)
										if mode != "rb":
													raise ValueError(F"Tried to read with mode {mode} on file {self.file.path} opened with mode 'rb'"		)
										return self.file.open()


class   _lowerCAmelCase		(     __SCREAMING_SNAKE_CASE				):
							_UpperCAmelCase						    =     'bz2'
							_UpperCAmelCase						    =     'bz2'
							_UpperCAmelCase						    =     '.bz2'


class   _lowerCAmelCase		(     __SCREAMING_SNAKE_CASE				):
							_UpperCAmelCase						    =     'gzip'
							_UpperCAmelCase						    =     'gzip'
							_UpperCAmelCase						    =     '.gz'


class   _lowerCAmelCase		(     __SCREAMING_SNAKE_CASE				):
							_UpperCAmelCase						    =     'lz4'
							_UpperCAmelCase						    =     'lz4'
							_UpperCAmelCase						    =     '.lz4'


class   _lowerCAmelCase		(     __SCREAMING_SNAKE_CASE				):
							_UpperCAmelCase						    =     'xz'
							_UpperCAmelCase						    =     'xz'
							_UpperCAmelCase						    =     '.xz'


class   _lowerCAmelCase		(     __SCREAMING_SNAKE_CASE				):
							_UpperCAmelCase						    =     'zstd'
							_UpperCAmelCase						    =     'zstd'
							_UpperCAmelCase						    =     '.zst'







							def __init__(				self     :    str	,					__snake_case     :    str	,					__snake_case     :    str = "rb"	,					__snake_case     :    Optional[str] = None	,					__snake_case     :    Optional[dict] = None	,					__snake_case     :    int = DEFAULT_BLOCK_SIZE	,					**__snake_case     :    int	,					):
										super().__init__(
										    fo=__snake_case	,					mode=__snake_case	,					target_protocol=__snake_case	,					target_options=__snake_case	,					block_size=__snake_case	,					**__snake_case	,					)
										# We need to wrap the zstd decompressor to avoid this error in fsspec==2021.7.0 and zstandard==0.15.2:
										#
										# File "/Users/user/.virtualenvs/hf-datasets/lib/python3.7/site-packages/fsspec/core.py", line 145, in open
										#     out.close = close
										# AttributeError: 'zstd.ZstdDecompressionReader' object attribute 'close' is read-only
										#
										# see https://github.com/intake/filesystem_spec/issues/725
										lowerCamelCase						:Tuple						  =     self.file.__enter__
										class   _lowerCAmelCase		:







																	def __init__(				self     :    Dict	,					__snake_case     :    Tuple		):
																				lowerCamelCase						:Optional[int]						  =     file_







																	def __enter__(				self     :    Optional[int]		):
																				self._file.__enter__()
																				return self







																	def __exit__(				self     :    str	,					*__snake_case     :    Optional[Any]	,					**__snake_case     :    List[Any]		):
																				self._file.__exit__(*__snake_case	,					**__snake_case		)







																	def __iter__(				self     :    Optional[Any]		):
																				return iter(self._file		)







																	def 				snake_case  (				self     :    List[Any]		):
																				return next(self._file		)







																	def __getattr__(				self     :    Any	,					__snake_case     :    str		):
																				return getattr(self._file	,					__snake_case		)

										def fixed_enter(*__snake_case     :    Optional[int]	,					**__snake_case     :    str		):
													return WrappedFile(_enter(*__snake_case	,					**__snake_case		)		)

										lowerCamelCase						:Dict						  =     fixed_enter



