Skip to content

src-d/lookout-sdk-ml

Repository files navigation

lookout-sdk-ml

Lookout Python SDK for stateful analyzers, typically using Machine Learning.

Read the Docs Travis build status Code coverage Docker build status PyPi package status stability: beta Apache 2.0 license

OverviewInstallationHow To UseContributionsLicense

Overview

This is a Python package which provides API to create stateful analyzers for the Lookout framework. "Stateful" means that such analyzers update "state" after each push to repository. In machine learning terms, a state is a model and updating state is training. Thus all the Lookout analyzers which use machine learning are based on this API.

You benefit from lookout-sdk-ml if you:

  • Code in Python.
  • Want to create a stateful analyzer for Lookout.
  • Find the lookout-sdk too low level.

Installation

You need Python 3.5 or later.

pip3 install lookout-sdk-ml

How To Use

Please refer to the getting started guide.

Contributions

Contributions are very welcome and desired! Please follow the code of conduct and read the contribution guidelines.

License

Apache-2.0, see license.md.