.. _l-classes:

Classes
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                     | class parent | truncated documentation                                                                                                 |
+===========================================================================================================+==============+=========================================================================================================================+
| :class:`ImbalancedSplitException <pandas_streaming.df.connex_split.ImbalancedSplitException>`             |              | Raised when an imbalanced split is detected.                                                                            |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`JsonIterator2Stream <pandas_streaming.df.dataframe_io_helpers.JsonIterator2Stream>`               |              | Transforms an iterator on :epkg:`JSON` items into a stream which returns an items as a string every time method ...     |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`JsonPerRowsStream <pandas_streaming.df.dataframe_io_helpers.JsonPerRowsStream>`                   |              | Reads a :epkg:`json` streams and adds ``,``, ``[``, ``]`` to convert a stream containing one :epkg:`json` object ...    |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`StreamingDataFrame <pandas_streaming.df.dataframe.StreamingDataFrame>`                            |              | Defines a streaming dataframe. The goal is to reduce the memory footprint. The class takes a function which creates ... |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`StreamingDataFrameSchemaError <pandas_streaming.df.dataframe.StreamingDataFrameSchemaError>`      |              | Reveals an issue with inconsistant schemas.                                                                             |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`StreamingInefficientException <pandas_streaming.exc.exc_streaming.StreamingInefficientException>` |              | Kind of operations doable with a :epkg:`pandas:DataFrame` but which should not be done in streaming mode.               |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`StreamingSeries <pandas_streaming.df.dataframe.StreamingSeries>`                                  |              | Seens as a :class:`StreamingDataFrame` of one column.                                                                   |
+-----------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+