Data structures
***************

:mod:`modpipe.serialize` -- Serialization of data structures
============================================================

.. module:: modpipe.serialize
   :synopsis: Serialization of data structures

This module contains classes that represent some fundamental objects used
in ModPipe (such as a :class:`Hit` or :class:`Model`). It also contains
methods to *serialize* these objects, i.e. to write them out to or read
them in from files (or any file-like object).

.. autoclass:: Hit

.. autoclass:: Model

.. autofunction:: write_hits_file

.. autofunction:: write_models_file

.. autofunction:: read_hits_file

.. autofunction:: read_models_file

For an example of using this module, see :ref:`using-lib`.