data_describe.core.summary
=================================

.. py:module:: data_describe.core.summary





.. autoapisummary::

   data_describe.core.summary.data_summary


.. py:class:: SummaryWidget(input_data=None, summary=None, **kwargs)

   Bases: :class:`data_describe._widget.BaseWidget`

   Container for data summary.

   This class (object) is returned from the ``data_summary`` function. The
   attributes documented below can be accessed or extracted.

   .. attribute:: input_data

      The input data.

   .. attribute:: summary

      The summary statistics.

      :type: DataFrame

   .. method:: show(self, viz_backend=None, **kwargs)


      The default display for this output.

      Returns the summary data as a Pandas dataframe.

      :param viz_backend: The visualization backend.
      :param \*\*kwargs: Keyword arguments.

      :raises ValueError: Summary data is missing.

      :returns: The correlation matrix plot.



.. function:: data_summary(data, compute_backend=None)

   Summary statistics and data description.

   :param data: The dataframe
   :param compute_backend: The compute backend.

   :returns: The dataframe with metrics in rows