colearn 0.2.4

The Standalone Fetch AI Collective Learning Framework

Welcome to the Fetch.ai Collective Learning

Colearn is a library that enables privacy-preserving decentralized machine learning tasks on the FET network.

This blockchain-mediated collective learning system enables multiple stakeholders to build a shared machine learning model without needing to rely on a central authority. This library is currently in development.

The collective learning protocol allows learners to collaborate on training a model without requiring trust between the participants. Learners vote on updates to the model, and only updates which pass the quality threshold are accepted. This makes the system robust to attempts to interfere with the model by providing bad updates. For more details on the collective learning system see here

Current Version

We have released v.0.2 of the Colearn Machine Learning Interface, the first version of an interface that will allow developers to prepare for future releases. Together with the interface we provide a simple backend for local experiments. This is the first backend with upcoming blockchain ledger based backends to follow.
Future releases will use similar interfaces so that learners built with the current system will work on a different backend that integrates a distributed ledger and provides other improvements. The current framework will then be used mainly for model development and debugging. We invite all users to experiment with the framework, develop their own models, and provide feedback!

See the documentation at fetchai.github.io/colearn/

Installation

To use the latest stable release we recommend installing the package from PyPi

To install with support for Keras and Pytorch:

pip install colearn[all]

To install with just support for Keras or Pytorch:

pip install colearn[keras]
pip install colearn[pytorch]

Running the examples

Download the stand-alone examples

wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/keras_cifar.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/keras_fraud.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/keras_mnist.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/keras_mnist_diffpriv.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/keras_xray.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/mli_fraud.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/mli_random_forest_iris.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/pytorch_cifar.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/pytorch_covid.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/pytorch_mnist.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/pytorch_mnist_diffpriv.py
wget https://raw.githubusercontent.com/fetchai/colearn/master/examples/pytorch_xray.py

• Or they can be accessed from colearn/examples by cloning colearn repo

Run any example depending on what machine learning library support you've installed

# for colearn[keras] or colearn[all]
python3 keras_mnist.py
# for colearn[pytorch] or colearn[all]
python3 pytorch_mnist.py

For more instructions see the documentation at fetchai.github.io/colearn/installation

After installation we recommend running a demo , or seeing the examples