.. title:: RegressionResult

lisa.regression.RegressionResult
================================


.. autoclass:: lisa.regression::RegressionResult
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.regression.RegressionResult.failure_delta_pc`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            Delta between old and new failure rate in percent.
      * - :attr:`~lisa.regression.RegressionResult.failure_pc`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            Tuple of failure rate in percent for old an new series.
      * - :attr:`~lisa.regression.RegressionResult.fix_validation_min_iter_nr`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            Number of iterations required to validate a fix that would "revert" a regression.
      * - :attr:`~lisa.regression.RegressionResult.p_val`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            P-value of the statistical test.
      * - :attr:`~lisa.regression.RegressionResult.sample_size`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            Tuple of sample sizes for old and new series.
      * - :attr:`~lisa.regression.RegressionResult.significant`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            True if there is a significant difference in failure rate, False otherwise.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.regression.RegressionResult.from_result_list`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            Build a :class:`RegressionResult` from two list of :class:`lisa.tests.base.Result`, or objects that can be converted to `bool`.
      * - :meth:`~lisa.regression.RegressionResult.get_p_val`
        -
         
         .. withrefctx::
            :module: lisa.regression
            :class: lisa.regression.RegressionResult
         
         
            Compute the p-value of the statistical test, with the given alternative hypothesis.
   


Properties
----------


.. autoproperty:: lisa.regression::RegressionResult.failure_delta_pc



.. autoproperty:: lisa.regression::RegressionResult.failure_pc



.. autoproperty:: lisa.regression::RegressionResult.fix_validation_min_iter_nr



.. autoproperty:: lisa.regression::RegressionResult.p_val



.. autoproperty:: lisa.regression::RegressionResult.sample_size



.. autoproperty:: lisa.regression::RegressionResult.significant



Methods
-------


.. automethod:: lisa.regression::RegressionResult.from_result_list



.. automethod:: lisa.regression::RegressionResult.get_p_val