README.rst 2.75 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>
.. Thu 24 Apr 17:24:10 2014 CEST

André Anjos's avatar
André Anjos committed
5
6
.. image:: https://travis-ci.org/bioidiap/bob.learn.mlp.svg?branch=master
   :target: https://travis-ci.org/bioidiap/bob.learn.mlp
7
8
.. image:: http://img.shields.io/badge/docs-latest-orange.png
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.learn.mlp/master/index.html
André Anjos's avatar
André Anjos committed
9
10
11
12
13
14
15
16
.. image:: https://coveralls.io/repos/bioidiap/bob.learn.mlp/badge.png
   :target: https://coveralls.io/r/bioidiap/bob.learn.mlp
.. image:: http://img.shields.io/github/tag/bioidiap/bob.learn.mlp.png
   :target: https://github.com/bioidiap/bob.learn.mlp
.. image:: http://img.shields.io/pypi/v/bob.learn.mlp.png
   :target: https://pypi.python.org/pypi/bob.learn.mlp
.. image:: http://img.shields.io/pypi/dm/bob.learn.mlp.png
   :target: https://pypi.python.org/pypi/bob.learn.mlp
André Anjos's avatar
André Anjos committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

===============================================================
 Python bindings for Bob's Multi-Layer Perceptron and Trainers
===============================================================

This package contains a set of Pythonic bindings for Bob's MLP and Trainers.

Installation
------------

Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
the package and run test units.

Documentation
-------------

33
34
35
The latest version of the documentation can be found `here <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.learn.mlp/master/index.html>`_.

Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx::
André Anjos's avatar
André Anjos committed
36
37
38
39
40
41
42
43
44
45
46

  $ sphinx-build -b html doc sphinx

This shall place in the directory ``sphinx``, the current version for the
documentation of the package.

Testing
-------

You can run a set of tests using the nose test runner::

47
  $ nosetests -sv
André Anjos's avatar
André Anjos committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

.. warning::

   If Bob <= 1.2.1 is installed on your python path, nose will automatically
   load the old version of the insulate plugin available in Bob, which will
   trigger the loading of incompatible shared libraries (from Bob itself), in
   to your working binary. This will cause a stack corruption. Either remove
   the centrally installed version of Bob, or build your own version of Python
   in which Bob <= 1.2.1 is not installed.

You can run our documentation tests using sphinx itself::

  $ sphinx-build -b doctest doc sphinx

You can test overall test coverage with::

André Anjos's avatar
André Anjos committed
64
  $ nosetests --with-coverage --cover-package=bob.learn.mlp
André Anjos's avatar
André Anjos committed
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

The ``coverage`` egg must be installed for this to work properly.

Development
-----------

To develop this package, install using ``zc.buildout``, using the buildout
configuration found on the root of the package::

  $ python bootstrap.py
  ...
  $ ./bin/buildout

Tweak the options in ``buildout.cfg`` to disable/enable verbosity and debug
builds.