.. _rez-benchmark:

=============
rez-benchmark
=============

.. program:: rez-benchmark

Usage
=====

.. code-block:: text

   rez benchmark [-h] [--out RESULTS_DIR] [--iterations N] [--histogram]
                        [--compare RESULTS_DIR] [-v]
   

description
===========

Run a benchmarking suite for runtime resolves.


Options
=======

.. option:: --out <results_dir>

   Output dir 

   **Default**: ``out``

.. option:: --iterations <n>

   Run every resolve N times and take the average 

   **Default**: 1

.. option:: --histogram 

   Show an ASCII histogram of resolve times (from results in :option:`--out`)

.. option:: --compare <results_dir>

   Compare RESULTS_DIR to results specified via :option:`--out`. Ie, if ``mean_delta`` is negative, then RESULTS_DIR resolves are faster on average than those in :option:`--out` dir

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity