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

Documentation #16

Open
willtebbutt opened this issue May 24, 2017 · 2 comments · Fixed by #45
Open

Documentation #16

willtebbutt opened this issue May 24, 2017 · 2 comments · Fixed by #45

Comments

@willtebbutt
Copy link
Member

  1. Find a decent git-hostable package for producing documentation.
  2. Cover interface (how do I get gradients / how do I add my own sensitivities + reference to useful documents explaining RMAD) + provide plenty of examples and explain design choices + provide benchmarks comparing with other RMAD packages.
  3. Cover the inner-workings of the package + explain design choices. Discuss limitations.
@rofinn
Copy link
Member

rofinn commented Jul 13, 2017

The general consensus in the julia community seems to be Documenter.jl which just uses github pages. If the API is mostly stable it might be worth getting a bit of documentation setup with some very short examples.

@omus
Copy link
Contributor

omus commented Aug 18, 2017

At the very least a README should be added to at least inform readers what this package does.

willtebbutt added a commit that referenced this issue Aug 20, 2017
@willtebbutt
The readme
eb163e2 
A temporary README to plug the gap. Clearly doesn't resolve #16 .
@willtebbutt willtebbutt mentioned this issue Aug 20, 2017
Merged
willtebbutt added a commit that referenced this issue Aug 21, 2017
@willtebbutt
The readme (#45)
b326aa5 
* The readme

A temporary README to plug the gap. Clearly doesn't resolve #16 .

* Update README.md

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)
@omus omus reopened this Aug 22, 2017
@willtebbutt willtebbutt mentioned this issue Oct 17, 2017
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

The readme invenia/Nabla.jl
3 participants
@omus @willtebbutt @rofinn