:py:mod:`pycmtensor.results`
============================

.. py:module:: pycmtensor.results

.. autoapi-nested-parse::

   PyCMTensor results module



Module Contents
---------------

.. py:class:: Results


   Class object to hold model results

   .. py:method:: rho_square()

      Returns the rho square statistics


   .. py:method:: rho_square_bar()

      Returns the rho square bar statistics


   .. py:method:: loglikelihood_ratio_test()

      Returns the log likelihood ratio test statistics


   .. py:method:: AIC()

      Returns the Akaike Information Criterion


   .. py:method:: BIC()

      Returns the Bayesian Information Criterion


   .. py:method:: benchmark()

      Returns a pandas DataFrame of a summary of the model benchmark


   .. py:method:: model_statistics()

      Returns a pandas DataFrame of a summary of the model training


   .. py:method:: beta_statistics()

      Returns a pandas DataFrame of the model beta statistics


   .. py:method:: model_correlation_matrix()

      Returns a pandas DataFrame of the model correlation matrix


   .. py:method:: model_robust_correlation_matrix()

      Returns a pandas DataFrame of the model (robust) correlation matrix