Skip to content
This repository has been archived by the owner on Apr 18, 2023. It is now read-only.

The readme #45

Merged
merged 2 commits into from Aug 21, 2017
Merged

The readme #45

merged 2 commits into from Aug 21, 2017

Conversation

willtebbutt
Copy link
Member

A temporary README to plug the gap. Clearly doesn't resolve #16 fully, but at least we have a readme.

A temporary README to plug the gap. Clearly doesn't resolve #16 .
@codecov
Copy link

codecov bot commented Aug 20, 2017

Codecov Report

Merging #45 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #45   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          13     13           
  Lines         240    240           
=====================================
  Hits          240    240

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a77a382...91bdd11. Read the comment docs.

Copy link
Member

@iamed2 iamed2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You requested a review so I went full copy-editor 😉

Nabla.jl is a reverse-mode automatic differentiation package targetting machine learning use cases. 
As such, we have prioritised support for linear algebra optimisations and higher-order functions over the ability to take higher-order derivatives (Nabla currently only supports first-order derivatives).

Nabla is currently under active development and improved documentation will be made available soon. 
Until then, the code in the [examples](src/examples) folder best indicates how to use the package. 
Given the early stage of development, we anticipate a number of bugs and performance issues. 
If you encounter any of these or have any particular feature requests, please raise an issue and let us know.

More or less Eric's suggestions, but added `(for example)` to indicate that linear algebra + higher order functions over higher-order derivatives is not the only decision which has been motivated by the ML goal (I don't want to give the impression that this is the only thing we've done as a consequence of the ML priority)
@willtebbutt willtebbutt merged commit b326aa5 into master Aug 21, 2017
@willtebbutt willtebbutt deleted the temporary-readme branch August 21, 2017 22:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
2 participants