*******************************************************
High-level Training and Test Tool --- :mod:`classifier`
*******************************************************

.. automodule:: libshorttext.classifier
        :members:
        :undoc-members:
        :inherited-members:
        :show-inheritance:

Utility Functions
=================

Utility functions provide the basic training and test procedures. The following
example shows how to use these utility functions.

        >>> from libshorttext.classifier import *
        >>> # training
        >>> model, svm_file = train_text('train_file')
        >>> # test
        >>> results = predict_text('test_file', model)
        >>> # save the predicted results
        >>> results.save('result_path')


.. autofunction:: libshorttext.classifier.train_text

.. autofunction:: libshorttext.classifier.train_converted_text

.. autofunction:: libshorttext.classifier.predict_text

.. autofunction:: libshorttext.classifier.predict_single_text


Classifier Model --- :class:`TextModel`
=======================================
.. autoclass:: libshorttext.classifier.TextModel
        :members:
        :undoc-members:
        :inherited-members:
        :show-inheritance:


Results of Prediction --- :class:`PredictionResult`
===================================================
.. autoclass:: libshorttext.classifier.PredictionResult
        :members:
        :undoc-members:
        :inherited-members:
        :show-inheritance:

.. _learner:

The Middle-level Classification Module --- :mod:`learner`
=========================================================

.. automodule:: libshorttext.classifier.learner
        :members:
        :undoc-members:
        :inherited-members:
        :show-inheritance:

Utility Functions of :mod:`learner`
-----------------------------------

.. autofunction:: libshorttext.classifier.learner.train

.. autofunction:: libshorttext.classifier.learner.predict

.. autofunction:: libshorttext.classifier.learner.predict_one

The Middle-level Model --- :class:`LearnerModel`
------------------------------------------------

.. autoclass:: libshorttext.classifier.learner.LearnerModel
        :members:
        :undoc-members:
        :show-inheritance:


.. _learner_param:

Parameters of the :class:`LearnerModule`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The parameter of :class:`LearnerModel` is wrapped in a structure class ---
:class:`LearnerParameter`. In the following, we will introduce 
:class:`LearnerParameter` and LibShortText's parameters for LIBSVM-format data.


.. autoclass:: libshorttext.classifier.learner.LearnerParameter
        :members:
        :undoc-members:
        :show-inheritance: