Flux.jl/latest/index.html

272 lines
7.4 KiB
HTML
Raw Normal View History

2017-01-16 01:04:23 +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>
Home · Flux
</title>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
2017-01-16 15:37:04 +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 class="current">
<a class="toctext" href="index.html">
Home
</a>
2017-02-01 08:59:51 +00:00
<ul class="internal">
2017-02-24 15:52:14 +00:00
<li>
<a class="toctext" href="#Where-do-I-start?-1">
Where do I start?
</a>
</li>
2017-02-01 08:59:51 +00:00
<li>
<a class="toctext" href="#Installation-1">
Installation
</a>
</li>
</ul>
2017-01-17 20:06:28 +00:00
</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>
<li>
2017-01-18 12:45:25 +00:00
<a class="toctext" href="examples/logreg.html">
2017-03-09 00:26:06 +00:00
Simple MNIST
2017-01-18 01:18:15 +00:00
</a>
</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>
<a class="toctext" href="contributing.html">
Contributing &amp; Help
</a>
</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>
<a href="index.html">
Home
</a>
</li>
</ul>
2017-06-05 15:10:58 +00:00
<a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/837173d65baa9ed49c33b36564147a2ec780d55c/docs/src/index.md">
2017-01-17 20:06:28 +00:00
<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>
2017-05-03 18:59:55 +00:00
<em>
... Initialising Photon Beams ...
</em>
</p>
<p>
2017-05-03 19:17:54 +00:00
Flux is a library for machine learning, implemented in Julia. In a nutshell, it simply lets you run normal Julia code on a backend like TensorFlow. It also provides many conveniences for doing deep learning.
2017-01-18 01:02:10 +00:00
</p>
<p>
2017-05-03 19:17:54 +00:00
Flux is very flexible. You can use a convenient Keras-like API if you want something simple, but you can also drop down to straight mathematics, or build your own abstractions. You can even use Flux&#39;s utilities (like optimisers) with a completely different backend (like
2017-05-03 18:18:35 +00:00
<a href="https://github.com/denizyuret/Knet.jl">
Knet
</a>
) or mix and match approaches.
2017-01-17 20:06:28 +00:00
</p>
<p>
2017-05-03 18:18:35 +00:00
Note that Flux is in alpha. Many things work but the API is still in a state of... well, it might change.
2017-05-02 12:52:47 +00:00
</p>
<p>
<strong>
Note:
</strong>
If you&#39;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.
2017-01-17 20:06:28 +00:00
</p>
2017-02-24 15:52:14 +00:00
<h2>
<a class="nav-anchor" id="Where-do-I-start?-1" href="#Where-do-I-start?-1">
Where do I start?
</a>
</h2>
2017-01-17 20:06:28 +00:00
<p>
2017-05-03 18:59:55 +00:00
<em>
... Charging Ion Capacitors ...
</em>
</p>
<p>
2017-02-24 15:52:14 +00:00
The
2017-02-24 15:59:13 +00:00
<a href="examples/logreg.html">
2017-02-24 15:52:14 +00:00
examples
</a>
2017-05-04 16:19:01 +00:00
give a feel for high-level usage.
2017-02-24 15:52:14 +00:00
</p>
<p>
2017-05-04 16:19:01 +00:00
If you want to know why Flux is unique, or just don&#39;t want to see
2017-01-18 01:02:10 +00:00
<em>
2017-02-24 15:52:14 +00:00
those digits
2017-01-18 01:02:10 +00:00
</em>
2017-02-24 15:52:14 +00:00
again, check out the
2017-02-24 15:59:13 +00:00
<a href="models/basics.html">
2017-02-24 15:52:14 +00:00
model building guide
</a>
2017-05-04 16:19:01 +00:00
instead.
</p>
<p>
Flux is meant to be played with. These docs have lots of code snippets; try them out in
<a href="http://junolab.org">
Juno
</a>
!
2017-02-01 08:59:51 +00:00
</p>
<h2>
<a class="nav-anchor" id="Installation-1" href="#Installation-1">
Installation
</a>
</h2>
<p>
<em>
2017-05-03 18:59:55 +00:00
... Inflating Graviton Zeppelins ...
2017-02-01 08:59:51 +00:00
</em>
</p>
2017-03-08 20:55:13 +00:00
<pre><code class="language-julia">Pkg.update()
Pkg.add(&quot;Flux.jl&quot;)</code></pre>
2017-02-01 08:59:51 +00:00
<p>
You&#39;ll also need a backend to run real training, if you don&#39;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&#39;re not sure):
2017-01-17 20:06:28 +00:00
</p>
2017-03-01 14:38:54 +00:00
<pre><code class="language-julia">Pkg.add(&quot;MXNet&quot;) # or &quot;TensorFlow&quot;
Pkg.test(&quot;Flux&quot;) # Make sure everything installed properly</code></pre>
2017-05-02 12:52:47 +00:00
<p>
<strong>
Note:
</strong>
TensorFlow integration may not work properly on Julia v0.6 yet.
</p>
2017-01-17 20:06:28 +00:00
<footer>
<hr/>
2017-01-18 23:22:30 +00:00
<a class="next" href="models/basics.html">
2017-01-17 20:06:28 +00:00
<span class="direction">
Next
</span>
<span class="title">
2017-02-01 13:48:25 +00:00
Model Building Basics
2017-01-17 20:06:28 +00:00
</span>
</a>
</footer>
</article>
</body>
</html>