README.rst 3.33 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
.. Fri 13 Dec 2013 12:35:22 CET

5 6
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
   :target: http://pythonhosted.org/bob.learn.libsvm/index.html
7 8
.. image:: http://img.shields.io/badge/docs-latest-orange.png
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.learn.libsvm/master/index.html
9 10 11 12
.. image:: https://travis-ci.org/bioidiap/bob.learn.libsvm.svg?branch=master
   :target: https://travis-ci.org/bioidiap/bob.learn.libsvm?branch=master
.. image:: https://coveralls.io/repos/bioidiap/bob.learn.libsvm/badge.svg?branch=master
   :target: https://coveralls.io/r/bioidiap/bob.learn.libsvm?branch=master
13 14
.. image:: https://img.shields.io/badge/github-master-0000c0.png
   :target: https://github.com/bioidiap/bob.learn.libsvm/tree/master
André Anjos's avatar
André Anjos committed
15 16 17 18
.. image:: http://img.shields.io/pypi/v/bob.learn.libsvm.png
   :target: https://pypi.python.org/pypi/bob.learn.libsvm
.. image:: http://img.shields.io/pypi/dm/bob.learn.libsvm.png
   :target: https://pypi.python.org/pypi/bob.learn.libsvm
André Anjos's avatar
André Anjos committed
19

20 21 22
==================================
 Bob's Python bindings for LIBSVM
==================================
André Anjos's avatar
André Anjos committed
23

André Anjos's avatar
André Anjos committed
24
This package contains a set of Pythonic bindings for LIBSVM.
André Anjos's avatar
André Anjos committed
25

26 27 28
External Software Requirements
------------------------------

29 30 31
This package requires you have ``LIBSVM`` installed on your system.
If ``LIBSVM`` is installed on a standard location, this package will find it automatically.
You can just skip to the installation instructions.
32

33 34
In case you have installed ``LIBSVM`` on a non-standard location (e.g. your home directory), then you can specify the path to the root of that installation using the environment variable ``BOB_PREFIX_PATH``, **before** building and installing the package.
For example, if ``BOB_PREFIX_PATH`` is set to ``/home/user/libsvm-3.12``, then we will search for the header file ``svm.h`` in ``/home/user/libsvm-3.12/include`` and expect that the library file file is found under ``/home/user/libsvm-3.12/lib``.
35

36
If you are installing this package via ``pip`` for example, just set the environment variable like this::
37

André Anjos's avatar
André Anjos committed
38
  $ BOB_PREFIX_PATH=/home/user/libsvm-3.12 pip install bob.learn.libsvm
39

40
If you are installing this package via ``zc.buildout``, we recommend you use our `bob.buildout <http://pypi.python.org/pypi/bob.buildout>`_ extension and set the ``[environ]`` section to define ``BOB_PREFIX_PATH``.
41

André Anjos's avatar
André Anjos committed
42 43
Installation
------------
44 45 46
To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_.
For Bob_ to be able to work properly, some dependent packages are required to be installed.
Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.
André Anjos's avatar
André Anjos committed
47 48 49

Documentation
-------------
50 51
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.learn.libsvm/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.learn.libsvm/master/index.html>`_ of the documentation.
For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.
André Anjos's avatar
André Anjos committed
52

53
.. _bob: https://www.idiap.ch/software/bob