2017-01-16 16:51:09 +00:00
<!DOCTYPE html>
2017-01-17 20:06:28 +00:00
< html lang = "en" >
< head >
< meta charset = "UTF-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title >
2017-01-18 01:18:15 +00:00
Contributing & Help · Flux
2017-01-17 20:06:28 +00:00
< / title >
< script >
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
2017-01-16 16:51:09 +00:00
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-36890222-9', 'auto');
ga('send', 'pageview');
2017-01-17 20:06:28 +00:00
< / script >
< link href = "https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel = "stylesheet" type = "text/css" / >
< link href = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/styles/default.min.css" rel = "stylesheet" type = "text/css" / >
< link href = "https://fonts.googleapis.com/css?family=Lato|Ubuntu+Mono" rel = "stylesheet" type = "text/css" / >
< link href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel = "stylesheet" type = "text/css" / >
< link href = "assets/documenter.css" rel = "stylesheet" type = "text/css" / >
< script >
documenterBaseURL="."
< / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main = "assets/documenter.js" > < / script >
< script src = "../versions.js" > < / script >
2017-01-17 20:27:28 +00:00
< link href = "../flux.css" rel = "stylesheet" type = "text/css" / >
2017-01-17 20:06:28 +00:00
< / head >
< body >
< nav class = "toc" >
< h1 >
Flux
< / h1 >
< form class = "search" action = "search.html" >
< select id = "version-selector" onChange = "window.location.href=this.value" >
< option value = "#" selected = "selected" disabled = "disabled" >
Version
< / option >
< / select >
< input id = "search-query" name = "q" type = "text" placeholder = "Search docs" / >
< / form >
< ul >
< li >
< a class = "toctext" href = "index.html" >
Home
< / a >
< / li >
2017-01-18 12:45:25 +00:00
< li >
2017-01-18 23:22:30 +00:00
< span class = "toctext" >
Building Models
< / span >
< ul >
< li >
< a class = "toctext" href = "models/basics.html" >
2017-02-01 13:48:25 +00:00
Model Building Basics
2017-01-18 23:22:30 +00:00
< / a >
< / li >
2017-02-02 07:48:56 +00:00
< li >
< a class = "toctext" href = "models/templates.html" >
Model Templates
< / a >
< / li >
2017-01-18 23:22:30 +00:00
< li >
< a class = "toctext" href = "models/recurrent.html" >
2017-01-18 12:45:25 +00:00
Recurrence
2017-01-18 23:22:30 +00:00
< / a >
< / li >
< li >
< a class = "toctext" href = "models/debugging.html" >
2017-01-18 12:45:25 +00:00
Debugging
2017-01-18 23:22:30 +00:00
< / a >
< / li >
< / ul >
2017-01-18 12:45:25 +00:00
< / li >
2017-02-18 15:11:53 +00:00
< li >
2017-02-20 10:53:09 +00:00
< span class = "toctext" >
Other APIs
< / span >
< ul >
< li >
2017-02-20 11:05:06 +00:00
< a class = "toctext" href = "apis/batching.html" >
2017-02-18 15:11:53 +00:00
Batching
2017-02-20 10:53:09 +00:00
< / a >
< / li >
< li >
2017-02-20 11:05:06 +00:00
< a class = "toctext" href = "apis/backends.html" >
2017-02-18 15:11:53 +00:00
Backends
2017-02-20 10:53:09 +00:00
< / a >
< / li >
2017-02-28 16:50:27 +00:00
< li >
< a class = "toctext" href = "apis/storage.html" >
Storing Models
< / a >
< / li >
2017-02-20 10:53:09 +00:00
< / ul >
2017-02-18 15:11:53 +00:00
< / li >
2017-01-17 20:06:28 +00:00
< li >
< span class = "toctext" >
2017-01-18 12:45:25 +00:00
In Action
2017-01-17 20:06:28 +00:00
< / span >
< ul >
2017-01-18 01:18:15 +00:00
< li >
2017-01-18 12:45:25 +00:00
< a class = "toctext" href = "examples/logreg.html" >
Logistic Regression
2017-01-18 01:18:15 +00:00
< / a >
2017-01-17 20:06:28 +00:00
< / li >
2017-02-28 16:21:45 +00:00
< li >
< a class = "toctext" href = "examples/char-rnn.html" >
Char RNN
< / a >
< / li >
2017-01-17 20:06:28 +00:00
< / ul >
< / li >
2017-01-18 01:18:15 +00:00
< li class = "current" >
< a class = "toctext" href = "contributing.html" >
Contributing & Help
< / a >
< ul class = "internal" > < / ul >
< / li >
2017-01-18 12:45:25 +00:00
< li >
< a class = "toctext" href = "internals.html" >
Internals
< / a >
< / li >
2017-01-17 20:06:28 +00:00
< / ul >
< / nav >
< article id = "docs" >
< header >
< nav >
< ul >
< li >
2017-01-18 01:18:15 +00:00
< a href = "contributing.html" >
Contributing & Help
2017-01-17 20:06:28 +00:00
< / a >
< / li >
< / ul >
2017-02-28 17:08:59 +00:00
< a class = "edit-page" href = "https://github.com/MikeInnes/Flux.jl/tree/2de6b063adbbb3228af6534f321a0c46ff0607f6/docs/src/contributing.md" >
2017-01-17 20:06:28 +00:00
< span class = "fa" >
< / span >
Edit on GitHub
< / a >
< / nav >
< hr / >
< / header >
< h1 >
2017-01-18 01:18:15 +00:00
< a class = "nav-anchor" id = "Contributing-1" href = "#Contributing-1" >
Contributing
2017-01-17 20:06:28 +00:00
< / a >
< / h1 >
2017-01-18 01:18:15 +00:00
< p >
2017-02-28 14:05:14 +00:00
If you need help, please ask on the
< a href = "https://discourse.julialang.org/" >
Julia forum
< / a >
or on Flux' s
< a href = "https://gitter.im/MikeInnes/Flux.jl" >
Gitter
< / a >
.
< / p >
< p >
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
< a href = "https://github.com/MikeInnes/Flux.jl" >
starring the repo
< / a >
.
< / p >
< p >
2017-02-28 16:21:45 +00:00
If you' re interested in hacking on Flux, most of the
< a href = "https://github.com/MikeInnes/Flux.jl/tree/master/src" >
code
< / a >
is pretty straightforward. Adding new
< a href = "https://github.com/MikeInnes/Flux.jl/tree/master/src/layers" >
layer definitions
< / a >
or cost functions is simple using the Flux DSL itself, and things like data utilities and training processes are all plain Julia code. The
2017-02-28 14:05:14 +00:00
< code > compiler< / code >
directory is a bit more involved and is documented in
< a href = "interals.html" >
internals
< / a >
, but most changes won' t need to touch that.
< / p >
< p >
If you get stuck or need anything, let us know!
2017-01-18 01:18:15 +00:00
< / p >
2017-01-17 20:06:28 +00:00
< footer >
< hr / >
2017-02-28 16:21:45 +00:00
< a class = "previous" href = "examples/char-rnn.html" >
2017-01-17 20:06:28 +00:00
< span class = "direction" >
Previous
< / span >
< span class = "title" >
2017-02-28 16:21:45 +00:00
Char RNN
2017-01-18 12:45:25 +00:00
< / span >
< / a >
< a class = "next" href = "internals.html" >
< span class = "direction" >
Next
< / span >
< span class = "title" >
Internals
2017-01-17 20:06:28 +00:00
< / span >
< / a >
< / footer >
< / article >
< / body >
< / html >
