***********************
Noise model diagnostics
***********************

.. module:: pints.residuals_diagnostics

Pints includes functionality to generate diagnostic plots of the residuals. These tools may be useful to evaluate the validity of a noise model.

Plotting functions:

- :func:`plot_residuals_autocorrelation`
- :func:`plot_residuals_binned_autocorrelation`
- :func:`plot_residuals_binned_std`
- :func:`plot_residuals_distance`
- :func:`plot_residuals_vs_output`

Diagnostics:

- :func:`acorr`
- :func:`calculate_residuals`


Plotting functions
------------------

.. autofunction:: plot_residuals_autocorrelation

.. autofunction:: plot_residuals_binned_autocorrelation

.. autofunction:: plot_residuals_binned_std

.. autofunction:: plot_residuals_distance

.. autofunction:: plot_residuals_vs_output


Diagnostics
-----------

.. autofunction:: acorr

.. autofunction:: calculate_residuals