.. license:
    Copyright 2015 - 2025
    André Malo or his licensors, as applicable

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.


======================================
 Pyliblinear - a liblinear python API
======================================

|**pyliblinear**| is an API for `liblinear
<http://www.csie.ntu.edu.tw/~cjlin/liblinear/>`_ without using ctypes.
It aims for more pythonic access to liblinear's features, especially
featuring streams of data and lazy evaluations whereever possible.

Supported python versions are Python 2.7 and Python 3.6+.


Documentation
~~~~~~~~~~~~~

.. toctree::
    :hidden:

    apidoc/index


- :ref:`Documentation Search <search>` (needs javascript)
- :ref:`API Documentation <apidoc>` (generated)


.. comment:
    Rationale, Advocacy, Key Features
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    WRITEME.


Development Status
~~~~~~~~~~~~~~~~~~

Beta.

The API is not stabilized yet. There also may be a few kinks here and
there. But generally it works as expected.


.. placeholder: Download


License
~~~~~~~

|pyliblinear| is available under the terms and conditions of the "Apache
License, Version 2.0." You'll find the detailed licensing terms in the
root directory of the source distribution package or online at
`http://www.apache.org/licenses/LICENSE-2.0
<http://www.apache.org/licenses/LICENSE-2.0>`_.

|pyliblinear| ships
with a copy of `liblinear
<http://www.csie.ntu.edu.tw/~cjlin/liblinear/>`_, which is licensed
under the terms of the `3-clause BSD license
<http://opensource.org/licenses/BSD-3-Clause>`_.


Bugs
~~~~

No bugs, of course. ;-)
But if you've found one or have an idea how to improve |pyliblinear|,
feel free to send a pull request on `github
<https://github.com/ndparker/pyliblinear>`_ or send a mail to
<pyliblinear-bugs@perlig.de>.


Author Information
~~~~~~~~~~~~~~~~~~

|pyliblinear| was written and is maintained by André Malo.


.. vim: ft=rest tw=72
