diff --git a/README.md b/README.md index 5e1180d4..3473afe1 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,7 @@ [![codecov.io](http://codecov.io/github/invenia/Nabla.jl/coverage.svg?branch=master)](http://codecov.io/github/invenia/Nabla.jl?branch=master) [![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://invenia.github.io/Nabla.jl/stable) [![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://invenia.github.io/Nabla.jl/latest) + +Nabla.jl is a reverse-mode automatic differentiation package. Although it is a general purpose tool, the decisions made regarding our priorities for development are motivated from the perspective of its usefulness in Machine Learning. For example, we have prioritised having excellent support for linear algebra optimisations and higher-order functions, rather than making it possible to take higher-order derivatives (i.e. Nabla *currently* only supports first-order derivatives). + +It is currently under active development, and improved documentation will be made available soon. Until then, take a look at the code in the examples folder for an indication of how to use the package. Given the early stage of development, we anticipate the presence of a number of bugs and performance issues. If you think you may have run into any of these, or have any particular feature requests, please raise an issue and let us know.