266 lines
7.8 KiB
HTML
266 lines
7.8 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
|
<title>
|
|
Home · 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 class="current">
|
|
<a class="toctext" href="index.html">
|
|
Home
|
|
</a>
|
|
<ul class="internal">
|
|
<li>
|
|
<a class="toctext" href="#Where-do-I-start?-1">
|
|
Where do I start?
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="#Installation-1">
|
|
Installation
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</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">
|
|
Simple MNIST
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="examples/char-rnn.html">
|
|
Char RNN
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="contributing.html">
|
|
Contributing & Help
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a class="toctext" href="internals.html">
|
|
Internals
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article id="docs">
|
|
<header>
|
|
<nav>
|
|
<ul>
|
|
<li>
|
|
<a href="index.html">
|
|
Home
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/efcb9650da31c183b94b839f66aa3467d007c33f/docs/src/index.md">
|
|
<span class="fa">
|
|
|
|
</span>
|
|
Edit on GitHub
|
|
</a>
|
|
</nav>
|
|
<hr/>
|
|
</header>
|
|
<h1>
|
|
<a class="nav-anchor" id="Flux-1" href="#Flux-1">
|
|
Flux
|
|
</a>
|
|
</h1>
|
|
<p>
|
|
Flux is a high-level interface for machine learning, implemented in Julia.
|
|
</p>
|
|
<p>
|
|
Flux aims to be an intuitive and powerful notation, close to the mathematics, that provides advanced features like auto-unrolling and closures. Simple models are trivial, while the most complex architectures are tractable, taking orders of magnitude less code than in other frameworks. Meanwhile, the Flux compiler provides excellent error messages and tools for debugging when things go wrong.
|
|
</p>
|
|
<p>
|
|
So what's the catch? Flux is at an early "working prototype" stage; many things work but the API is still in a state of... well, it might change. If you're interested to find out what works, read on!
|
|
</p>
|
|
<p>
|
|
<strong>
|
|
Note:
|
|
</strong>
|
|
If you're using Julia v0.5 please see
|
|
<a href="http://mikeinnes.github.io/Flux.jl/v0.1.1/">
|
|
this version
|
|
</a>
|
|
of the docs instead.
|
|
</p>
|
|
<h2>
|
|
<a class="nav-anchor" id="Where-do-I-start?-1" href="#Where-do-I-start?-1">
|
|
Where do I start?
|
|
</a>
|
|
</h2>
|
|
<p>
|
|
The
|
|
<a href="examples/logreg.html">
|
|
examples
|
|
</a>
|
|
are the best way to get a feel for how Flux looks. This a great way to start if you're a relative newbie to machine learning or neural networks; you should be able to get the examples running fairly easily.
|
|
</p>
|
|
<p>
|
|
If you have more experience with ML, or you just don't want to see
|
|
<em>
|
|
those digits
|
|
</em>
|
|
again, check out the
|
|
<a href="models/basics.html">
|
|
model building guide
|
|
</a>
|
|
instead. The Guide attempts to motivate Flux's programming model and approach with examples. However, it also gets into advanced usage very quickly; it's not necessary to memorise all the details to use Flux effectively.
|
|
</p>
|
|
<p>
|
|
The sections on
|
|
<a href="models/recurrent.html">
|
|
Recurrence
|
|
</a>
|
|
,
|
|
<a href="models/debugging.html">
|
|
Debugging
|
|
</a>
|
|
and
|
|
<a href="apis/batching.html">
|
|
Batching
|
|
</a>
|
|
best illustrate what makes Flux unique.
|
|
</p>
|
|
<h2>
|
|
<a class="nav-anchor" id="Installation-1" href="#Installation-1">
|
|
Installation
|
|
</a>
|
|
</h2>
|
|
<p>
|
|
<em>
|
|
... Charging Ion Capacitors ...
|
|
</em>
|
|
</p>
|
|
<pre><code class="language-julia">Pkg.update()
|
|
Pkg.add("Flux.jl")</code></pre>
|
|
<p>
|
|
You'll also need a backend to run real training, if you don't have one already. Choose from
|
|
<a href="https://github.com/dmlc/MXNet.jl">
|
|
MXNet
|
|
</a>
|
|
or
|
|
<a href="https://github.com/malmaud/TensorFlow.jl">
|
|
TensorFlow
|
|
</a>
|
|
(MXNet is the recommended option if you're not sure):
|
|
</p>
|
|
<pre><code class="language-julia">Pkg.add("MXNet") # or "TensorFlow"
|
|
Pkg.test("Flux") # Make sure everything installed properly</code></pre>
|
|
<p>
|
|
<strong>
|
|
Note:
|
|
</strong>
|
|
TensorFlow integration may not work properly on Julia v0.6 yet.
|
|
</p>
|
|
<footer>
|
|
<hr/>
|
|
<a class="next" href="models/basics.html">
|
|
<span class="direction">
|
|
Next
|
|
</span>
|
|
<span class="title">
|
|
Model Building Basics
|
|
</span>
|
|
</a>
|
|
</footer>
|
|
</article>
|
|
</body>
|
|
</html>
|