
# 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


UpperCamelCase_						:     int	       =							float("""nan""")




class   __lowercase						:






	def __init__(self				: Optional[Any]      ,	snake_case				: Union[str, Any]    ) ->			Optional[Any]:
							_lowercase       :	Any           =   sys.stdout
							_lowercase       :	List[str]           =   open(snake_case      ,	"a"    )






	def __getattr__(self				: List[str]      ,	snake_case				: Tuple    ) ->			Dict:
							return getattr(self.stdout      ,	snake_case    )






	def       _a(self				: Tuple      ,	snake_case				: Optional[int]    ) ->			List[Any]:
							self.stdout.write(snake_case    )
							# strip tqdm codes
							self.file.write(re.sub(R"^.*\r"      ,	""      ,	snake_case      ,	0      ,	re.M    )    )



def 		UpperCamelCase     (       _UpperCAmelCase  :   List[str]=80 ,			_UpperCAmelCase  :   List[Any]=False  )   ->			Tuple:






						'''simple docstring'''

						_lowercase       :	Any           =   []

						# deal with critical env vars
						_lowercase       :	Optional[Any]           =   ["CUDA_VISIBLE_DEVICES"]
						for key in env_keys:
												_lowercase       :	Tuple           =   os.environ.get(_UpperCAmelCase ,			_UpperCAmelCase  )
												if val is not None:
																		cmd.append(f"""{key}={val}"""  )

    # python executable (not always needed if the script is executable)
						_lowercase       :	Optional[int]           =   sys.executable if full_python_path else sys.executable.split("/"  )[-1]
						cmd.append(_UpperCAmelCase  )

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

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



def 		UpperCamelCase     (       _UpperCAmelCase  :   Dict ,			_UpperCAmelCase  :   Union[str, Any]  )   ->			List[Any]:






						'''simple docstring'''

						_lowercase       :	str           =   re.sub(R"[\\\n]+" ,			" " ,			args.base_cmd  )

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

						# ensure we have --overwrite_output_dir
						_lowercase       :	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 		UpperCamelCase     (       _UpperCAmelCase  :   Tuple ,			_UpperCAmelCase  :   int ,			_UpperCAmelCase  :   str ,			_UpperCAmelCase  :   Optional[Any] ,			_UpperCAmelCase  :   Tuple ,			_UpperCAmelCase  :   Any ,			_UpperCAmelCase  :   str  )   ->			Dict:






						'''simple docstring'''

						if 0:
												import random
												from time import sleep

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

						_lowercase       :	Union[str, Any]           =   subprocess.run(_UpperCAmelCase ,			capture_output=_UpperCAmelCase ,			text=_UpperCAmelCase  )

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

						# save the streams
						_lowercase       :	Dict           =   variation.replace(" " ,			"-"  )
						with open(Path(_UpperCAmelCase  ) / f"""log.{prefix}.stdout.txt""" ,			"w"  ) as f:
												f.write(result.stdout  )
						with open(Path(_UpperCAmelCase  ) / 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:
												_lowercase       :	Tuple           =   json.load(_UpperCAmelCase  )

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



def 		UpperCamelCase     (       _UpperCAmelCase  :   Optional[Any] ,			_UpperCAmelCase  :   Dict ,			_UpperCAmelCase  :   Optional[int] ,			_UpperCAmelCase  :   Union[str, Any] ,			_UpperCAmelCase  :   Optional[Any] ,			_UpperCAmelCase  :   Any ,			_UpperCAmelCase  :   List[str] ,			_UpperCAmelCase  :   Optional[Any] ,			_UpperCAmelCase  :   Any ,			_UpperCAmelCase  :   Optional[Any] ,			)   ->			Tuple:






						'''simple docstring'''

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



def 		UpperCamelCase     (       )   ->			Optional[Any]:






						'''simple docstring'''

						_lowercase       :	str           =   torch.cuda.get_device_properties(torch.device("cuda"  )  )
						return f"""
Datetime    : {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'  )}

Software:
transformers: {transformers.__version__}
torch       : {torch.__version__}
cuda        : {torch.version.cuda}
python      : {platform.python_version()}

Hardware:
{torch.cuda.device_count()} GPUs      : {properties.name}, {properties.total_memory/2**30:0.2f}GB
"""



def 		UpperCamelCase     (       _UpperCAmelCase  :   Any ,			_UpperCAmelCase  :   Optional[Any] ,			_UpperCAmelCase  :   Any ,			_UpperCAmelCase  :   str ,			_UpperCAmelCase  :   List[str]  )   ->			Union[str, Any]:






						'''simple docstring'''

						_lowercase       :	Any           =   pd.DataFrame(_UpperCAmelCase  )
						_lowercase       :	Dict           =   "variation"
						_lowercase       :	Any           =   "diff_%"

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

						# create diff column if possible
						if not math.isnan(_UpperCAmelCase  ):
												_lowercase       :	Optional[Any]           =   df.apply(
												    lambda _UpperCAmelCase  : round(100 * (r[target_metric_key] - sentinel_value) / sentinel_value  )
												    if not math.isnan(r[target_metric_key]  )
												    else 0 ,			axis="columns" ,			)

						# re-order columns
						_lowercase       :	int           =   [variation_key, target_metric_key, diff_key, *report_metric_keys]
						_lowercase       :	str           =   df.reindex(_UpperCAmelCase ,			axis="columns"  )  # reorder cols

						# capitalize
						_lowercase       :	Any           =   df.rename(str.capitalize ,			axis="columns"  )

						# make the cols as narrow as possible
						_lowercase       :	int           =   df.rename(lambda _UpperCAmelCase  : c.replace("_" ,			"<br>"  ) ,			axis="columns"  )
						_lowercase       :	Optional[Any]           =   df.rename(lambda _UpperCAmelCase  : c.replace("_" ,			"\n"  ) ,			axis="columns"  )

						_lowercase       :	List[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=_UpperCAmelCase ,			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=_UpperCAmelCase ,			floatfmt=".2f"  )]

						print("\n\n".join(_UpperCAmelCase  )  )



def 		UpperCamelCase     (       )   ->			Dict:






						'''simple docstring'''

						_lowercase       :	List[Any]           =   argparse.ArgumentParser()
						parser.add_argument(
						    "--base-cmd" ,			default=_UpperCAmelCase ,			type=_UpperCAmelCase ,			required=_UpperCAmelCase ,			help="Base cmd" ,			)
						parser.add_argument(
						    "--variations" ,			default=_UpperCAmelCase ,			type=_UpperCAmelCase ,			nargs="+" ,			required=_UpperCAmelCase ,			help="Multi-dimensional variations, example: '|--fp16|--bf16' '|--tf32'" ,			)
						parser.add_argument(
						    "--base-variation" ,			default=_UpperCAmelCase ,			type=_UpperCAmelCase ,			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=_UpperCAmelCase ,			type=_UpperCAmelCase ,			required=_UpperCAmelCase ,			help="Target metric key in output_dir/all_results.json, e.g., train_samples_per_second" ,			)
						parser.add_argument(
						    "--report-metric-keys" ,			default="" ,			type=_UpperCAmelCase ,			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=_UpperCAmelCase ,			help="How many times to re-run each variation - an average will be reported" ,			)
						parser.add_argument(
						    "--output_dir" ,			default="output_benchmark" ,			type=_UpperCAmelCase ,			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=_UpperCAmelCase ,			action="store_true" ,			help="Whether to show the outputs of each run or just the benchmark progress" ,			)
						_lowercase       :	Union[str, Any]           =   parser.parse_args()

						_lowercase       :	str           =   args.output_dir
						Path(_UpperCAmelCase  ).mkdir(exist_ok=_UpperCAmelCase  )
						_lowercase       :	Optional[int]           =   get_base_command(_UpperCAmelCase ,			_UpperCAmelCase  )

						# split each dimension into its --foo variations
						_lowercase       :	Dict           =   [list(map(str.strip ,			re.split(R"\|" ,			_UpperCAmelCase  )  )  ) 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
						_lowercase       :	Optional[int]           =   list(map(str.strip ,			map(" ".join ,			itertools.product(*_UpperCAmelCase  )  )  )  )
						_lowercase       :	List[str]           =   max(len(_UpperCAmelCase  ) for x in variations  )

						# split wanted keys
						_lowercase       :	List[Any]           =   args.report_metric_keys.split()

						# capture prints into a log file for convenience
						_lowercase       :	str           =   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}"""  )

						_lowercase       :	int           =   Tee(_UpperCAmelCase  )

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

						_lowercase       :	str           =   "variation"
						_lowercase       :	Dict           =   []
						for id, variation in enumerate(tqdm(_UpperCAmelCase ,			desc="Total completion: " ,			leave=_UpperCAmelCase  )  ):
												_lowercase       :	Any           =   base_cmd + variation.split()
												results.append(
												    process_run(
												        id + 1 ,			_UpperCAmelCase ,			_UpperCAmelCase ,			_UpperCAmelCase ,			_UpperCAmelCase ,			args.target_metric_key ,			_UpperCAmelCase ,			args.repeat_times ,			_UpperCAmelCase ,			args.verbose ,			)  )

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


if __name__ == "__main__":
							main()






import warnings

from ...utils import logging
from .image_processing_flava import FlavaImageProcessor


UpperCamelCase_						:     List[str]	       =							logging.get_logger(__name__)




class   __lowercase						(						__snake_case       ):






	def __init__(self				: int      ,	*snake_case				: Optional[Any]      ,	**snake_case				: Optional[Any]    ) ->			None:
							warnings.warn(
							    "The class FlavaFeatureExtractor is deprecated and will be removed in version 5 of Transformers. Please"
							    " use FlavaImageProcessor instead."      ,	snake_case      ,	)
							super().__init__(*snake_case      ,	**snake_case    )




