Skip to content
Snippets Groups Projects
user avatar
Manuel Guenther authored
e5af1ceb
History
https://travis-ci.org/bioidiap/bob.learn.mlp.svg?branch=master http://img.shields.io/badge/docs-latest-orange.png https://coveralls.io/repos/bioidiap/bob.learn.mlp/badge.png http://img.shields.io/github/tag/bioidiap/bob.learn.mlp.png http://img.shields.io/pypi/v/bob.learn.mlp.png http://img.shields.io/pypi/dm/bob.learn.mlp.png

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

The latest version of the documentation can be found here.

Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx:

$ 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:

$ nosetests -sv

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:

$ nosetests --with-coverage --cover-package=bob.learn.mlp

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.