TastyPancakes
/
Flux.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

contributing guide

This commit is contained in:
Mike J Innes 2017-02-28 14:00:19 +00:00
parent 4c0e915c00
commit 50d36079eb
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/contributing.md
View File

@ -1,3 +1,9 @@
# Contributing
[WIP]
If you need help, please ask on the [Julia forum](https://discourse.julialang.org/) or on Flux's [Gitter](https://gitter.im/MikeInnes/Flux.jl).
Right now, the best way to help out is to try out the examples and report any issues or missing features as you find them. The second best way is to help us spread the word, perhaps by [starring the repo](https://github.com/MikeInnes/Flux.jl).
If you're interested in hacking on Flux, most of the code is pretty straightforward. Adding new layer definitions or cost functions is simple using the Flux DSL itself, and things like data utilities and training processes are all plain Julia code. The `compiler` directory is a bit more involved and is documented in [internals](interals.html), but most changes won't need to touch that.
If you get stuck or need anything, let us know!