=======
Metrics
=======

Pypianoroll provides several objective metrics proposed in the literature. These objective metrics could be used to evaluate a music generation system by comparing the statistical difference between the training data and the generated samples.


Functions
=========

.. autofunction:: pypianoroll.empty_beat_rate
    :noindex:

.. autofunction:: pypianoroll.n_pitches_used
    :noindex:

.. autofunction:: pypianoroll.n_pitch_classes_used
    :noindex:

.. autofunction:: pypianoroll.pitch_range_tuple
    :noindex:

.. autofunction:: pypianoroll.pitch_range
    :noindex:

.. autofunction:: pypianoroll.qualified_note_rate
    :noindex:

.. autofunction:: pypianoroll.polyphonic_rate
    :noindex:

.. autofunction:: pypianoroll.drum_in_pattern_rate
    :noindex:

.. autofunction:: pypianoroll.in_scale_rate
    :noindex:

.. autofunction:: pypianoroll.tonal_distance
    :noindex: