dataeval.metrics.bias.BalanceOutput
===================================

.. py:class:: dataeval.metrics.bias.BalanceOutput



   Output class for :func:`balance` bias metric

   .. attribute:: balance

      Estimate of mutual information between metadata factors and class label

      :type: NDArray[np.float64]

   .. attribute:: factors

      Estimate of inter/intra-factor mutual information

      :type: NDArray[np.float64]

   .. attribute:: classwise

      Estimate of mutual information between metadata factors and individual class labels

      :type: NDArray[np.float64]

   .. attribute:: factor_names

      Names of each metadata factor

      :type: list[str]

   .. attribute:: class_list

      Array of the class labels present in the dataset

      :type: NDArray


   .. py:method:: plot(row_labels = None, col_labels = None, plot_classwise = False)

      Plot a heatmap of balance information

      :param row_labels: List/Array containing the labels for rows in the histogram
      :type row_labels: ArrayLike or None, default None
      :param col_labels: List/Array containing the labels for columns in the histogram
      :type col_labels: ArrayLike or None, default None
      :param plot_classwise: Whether to plot per-class balance instead of global balance
      :type plot_classwise: bool, default False