Skip to content

Latest commit

 

History

History

xfer-ml

xfer-ml: Deep Transfer Learning library for MXNet


Build Status Documentation Status codecov pypi GitHub license

Website | Documentation | Contribution Guide

What is the xfer-ml library?

xfer-ml is a library that allows quick and easy transfer of knowledge1,2,3 stored in deep neural networks implemented in MXNet. xfer-ml can be used with data of arbitrary numeric format, and can be applied to the common cases of image or text data.

xfer-ml can be used as a pipeline that spans from extracting features to training a repurposer. The repurposer is then an object that carries out predictions in the target task.

You can also use individual components of xfer-ml as part of your own pipeline. For example, you can leverage the feature extractor to extract features from deep neural networks or ModelHandler, which allows for quick building of neural networks, even if you are not an MXNet expert.

Why should I use xfer-ml?

  • Resource efficiency: you don't have to train big neural networks from scratch.
  • Data efficiency: by transferring knowledge, you can classify complex data even if you have very few labels.
  • Easy access to neural networks: you don't need to be an ML ninja in order to leverage the power of neural networks. With xfer-ml you can easily re-use them or even modify existing architectures and create your own solution.
  • Utilities for feature extraction from neural networks.
  • Rapid prototyping: ModelHandler allows you to easily modify a neural network architecture, e.g. by providing one-liners for adding / removing / freezing layers.
  • Uncertainty modeling: With the Bayesian neural network (BNN) or the Gaussian process (GP) repurposers, you can obtain uncertainty in the predictions of the rerpurposer.

Minimal demo

After defining an MXNet source model and data iterators for your target task, you can perform transfer learning with just 3 lines of code:

repurposer = xfer.LrRepurposer(source_model, feature_layer_names=['fc7'])
repurposer.repurpose(train_iterator)
predictions = repurposer.predict_label(test_iterator)

Getting Started

Installation

  • Dependencies: Primary dependencies are MXNet >=1.2 and GPy >= 1.9.5. See all requirements in setup.py.

  • Supported architectures / versions: Python 3.6+ on MacOS and Amazon Linux.

    Also tested on Python 3.4 and 3.5. Kindly note that for these Python versions, NumPy must be pre-installed for GPy (dependency of xfer-ml) to work.

  • Install with pip:
pip install xfer-ml
  • Install from source: To install xfer-ml from source, after cloning the repository run the following from the top-level directory:
pip install .

To confirm installation, run:

>>> import xfer
>>> xfer.__version__

And confirm that version returned matches the expected package version number.

Contributing

Have a look at our contributing guide, thanks for the interest!

Points of contact for xfer-ml are: Jordan Massiah, Keerthana Elango, Pablo G. Moreno, Nikos Aletras, Andreas Damianou, Sebastian Flennerhag

License

xfer-ml is licensed under the Apache 2.0 License.