.. _l-modules:

Modules
=======

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


Summary
+++++++

+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                             | truncated documentation                                                                                                                                                                                     |
+====================================================+=============================================================================================================================================================================================================+
| :ref:`__init__ <f-init>`                           | module ``pandas_streaming``    Module *pandas_streaming*.  Processes large datasets with :epkg:`pandas` by  reimplementing streeaming versions of  :epkg:`pandas` functionalites.      :githublink:`%|py|9` |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                          | module ``pandas_streaming.data``    Shortcuts to *df*.      :githublink:`%|py|5`                                                                                                                            |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                         | module ``pandas_streaming.df``    Shortcuts to *df*.      :githublink:`%|py|5`                                                                                                                              |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                        | module ``pandas_streaming.exc``    Shortcuts to *exc*.      :githublink:`%|py|5`                                                                                                                            |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`connex_split <f-connexsplit>`                | module ``pandas_streaming.df.connex_split``    Implements a connex split between train and test.      :githublink:`%|py|6`                                                                                  |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dataframe <f-dataframe>`                     | module ``pandas_streaming.df.dataframe``    Defines a streaming dataframe.      :githublink:`%|py|7`                                                                                                        |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dataframe_helpers <f-dataframehelpers>`      | module ``pandas_streaming.df.dataframe_helpers``    Helpers for dataframes.      :githublink:`%|py|6`                                                                                                       |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dataframe_io <f-dataframeio>`                | module ``pandas_streaming.df.dataframe_io``    Saves and reads a :epkg:`dataframe` into a :epkg:`zip` file.      :githublink:`%|py|6`                                                                       |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dataframe_io_helpers <f-dataframeiohelpers>` | module ``pandas_streaming.df.dataframe_io_helpers``    Saves and reads a :epkg:`dataframe` into a :epkg:`zip` file.      :githublink:`%|py|6`                                                               |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dataframe_split <f-dataframesplit>`          | module ``pandas_streaming.df.dataframe_split``    Implements different methods to split a dataframe.      :githublink:`%|py|6`                                                                              |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dummy <f-dummy>`                             | module ``pandas_streaming.data.dummy``    Dummy datasets.      :githublink:`%|py|6`                                                                                                                         |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`exc_streaming <f-excstreaming>`              | module ``pandas_streaming.exc.exc_streaming``    Defines a streming dataframe.      :githublink:`%|py|6`                                                                                                    |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    pandas_streaming/__init__
    pandas_streaming/data/__init__
    pandas_streaming/data/dummy
    pandas_streaming/df/__init__
    pandas_streaming/df/connex_split
    pandas_streaming/df/dataframe
    pandas_streaming/df/dataframe_helpers
    pandas_streaming/df/dataframe_io
    pandas_streaming/df/dataframe_io_helpers
    pandas_streaming/df/dataframe_split
    pandas_streaming/exc/__init__
    pandas_streaming/exc/exc_streaming