:py:mod:`rhino_health.lib.metrics.cox`
======================================

.. py:module:: rhino_health.lib.metrics.cox


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.cox.InitialBeta
   rhino_health.lib.metrics.cox.Cox




.. py:class:: InitialBeta


   Bases: :py:obj:`enum.Enum`

   
   The initial beta value for the Cox metric.
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: ZERO
      :value: 'zero'

      

   .. py:attribute:: MEAN
      :value: 'mean'

      


.. py:class:: Cox(**data: Any)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`

   
   A metric that calculates the Cox proportional hazard metric for a dataset.
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: time_variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: event_variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: covariates
      :type: Optional[List[rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName]]

      

   .. py:attribute:: initial_beta
      :type: Optional[InitialBeta]

      

   .. py:attribute:: max_iterations
      :type: int
      :value: 100

      

   .. py:attribute:: accuracy
      :type: float
      :value: 1e-06