213 lines
6.0 KiB
HTML
213 lines
6.0 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
|
<title>
|
|
Contributing & Help · Flux
|
|
</title>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(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');
|
|
|
|
</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>
|
|
<link href="../flux.css" rel="stylesheet" type="text/css"/>
|
|
</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>
|
|
<li>
|
|
<span class="toctext">
|
|
Building Models
|
|
</span>
|
|
<ul>
|
|
<li>
|
|
<a class="toctext" href="models/basics.html">
|
|
Model Building Basics
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="models/templates.html">
|
|
Model Templates
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="models/recurrent.html">
|
|
Recurrence
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="models/debugging.html">
|
|
Debugging
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<span class="toctext">
|
|
Other APIs
|
|
</span>
|
|
<ul>
|
|
<li>
|
|
<a class="toctext" href="apis/batching.html">
|
|
Batching
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="apis/backends.html">
|
|
Backends
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="apis/storage.html">
|
|
Storing Models
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<span class="toctext">
|
|
In Action
|
|
</span>
|
|
<ul>
|
|
<li>
|
|
<a class="toctext" href="examples/logreg.html">
|
|
Logistic Regression
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="examples/char-rnn.html">
|
|
Char RNN
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="current">
|
|
<a class="toctext" href="contributing.html">
|
|
Contributing & Help
|
|
</a>
|
|
<ul class="internal"></ul>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="internals.html">
|
|
Internals
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article id="docs">
|
|
<header>
|
|
<nav>
|
|
<ul>
|
|
<li>
|
|
<a href="contributing.html">
|
|
Contributing & Help
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/1c317eeefec910170cc72a4fe09ac54e187b3624/docs/src/contributing.md">
|
|
<span class="fa">
|
|
|
|
</span>
|
|
Edit on GitHub
|
|
</a>
|
|
</nav>
|
|
<hr/>
|
|
</header>
|
|
<h1>
|
|
<a class="nav-anchor" id="Contributing-1" href="#Contributing-1">
|
|
Contributing
|
|
</a>
|
|
</h1>
|
|
<p>
|
|
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>
|
|
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
|
|
<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!
|
|
</p>
|
|
<footer>
|
|
<hr/>
|
|
<a class="previous" href="examples/char-rnn.html">
|
|
<span class="direction">
|
|
Previous
|
|
</span>
|
|
<span class="title">
|
|
Char RNN
|
|
</span>
|
|
</a>
|
|
<a class="next" href="internals.html">
|
|
<span class="direction">
|
|
Next
|
|
</span>
|
|
<span class="title">
|
|
Internals
|
|
</span>
|
|
</a>
|
|
</footer>
|
|
</article>
|
|
</body>
|
|
</html>
|