The core package,
colearn, contains only the MachineLearningInterface and a simple driver that
implements the Collective Learning Protocol.
To install only the core package:
To make collective learning easier to use we have defined extra packages with helpers for model development in Keras and Pytorch.
To install with Keras/Pytorch extras:
To install both the Keras and Pytorch extras use:
To run stand-alone examples:
For more examples see the Examples Page
Installing From Source¶
Alternatively, to install the latest code from the repo:
- Download the source code from github:
- Create and launch a clean virtual environment with Python 3.7. (This library has currently only been tested with Python 3.7).
Install the package from source:
Run one of the examples:
If you are developing the colearn library then install it in editable mode so that new changes are effective immediately:
Running the tests¶
Tests can be run with:
To run the documentation, first install mkdocs and plugins: