build based on a146c47

latest/contributing.html

@@ -47,19 +47,9 @@ Version
 Home
           </a>
         </li>
-        <li>
-          <span class="toctext">
-Getting Started
-          </span>
-          <ul>
         <li>
           <a class="toctext" href="manual/basics.html">
-Basics
+First Steps
-              </a>
-            </li>
-            <li>
-              <a class="toctext" href="manual/custom.html">
-Custom Layers
           </a>
         </li>
         <li>
@@ -72,6 +62,16 @@ Recurrence
 Debugging
           </a>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
           </ul>
         </li>
         <li class="current">
@@ -80,6 +80,11 @@ Contributing &amp; Help
           </a>
           <ul class="internal"></ul>
         </li>
+        <li>
+          <a class="toctext" href="internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article id="docs">
@@ -92,7 +97,7 @@ Contributing &amp; Help
               </a>
             </li>
           </ul>
-          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/2e7971fb6d95f58de7b656acddb7ffade4b2ed16/docs/src/contributing.md">
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/contributing.md">
             <span class="fa">
 
             </span>
@@ -111,12 +116,20 @@ Contributing
       </p>
       <footer>
         <hr/>
-        <a class="previous" href="manual/debugging.html">
+        <a class="previous" href="examples/logreg.html">
           <span class="direction">
 Previous
           </span>
           <span class="title">
-Debugging
+Logistic Regression
+          </span>
+        </a>
+        <a class="next" href="internals.html">
+          <span class="direction">
+Next
+          </span>
+          <span class="title">
+Internals
           </span>
         </a>
       </footer>

latest/examples/logreg.html

@@ -4,7 +4,7 @@
     <meta charset="UTF-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
     <title>
-Custom Layers · Flux
+Logistic Regression · Flux
     </title>
     <script>
 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
@@ -48,31 +48,31 @@ Home
           </a>
         </li>
         <li>
-          <span class="toctext">
+          <a class="toctext" href="../manual/basics.html">
-Getting Started
+First Steps
-          </span>
-          <ul>
-            <li>
-              <a class="toctext" href="basics.html">
-Basics
           </a>
         </li>
-            <li class="current">
-              <a class="toctext" href="custom.html">
-Custom Layers
-              </a>
-              <ul class="internal"></ul>
-            </li>
         <li>
-              <a class="toctext" href="recurrent.html">
+          <a class="toctext" href="../manual/recurrent.html">
 Recurrence
           </a>
         </li>
         <li>
-              <a class="toctext" href="debugging.html">
+          <a class="toctext" href="../manual/debugging.html">
 Debugging
           </a>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li class="current">
+              <a class="toctext" href="logreg.html">
+Logistic Regression
+              </a>
+              <ul class="internal"></ul>
+            </li>
           </ul>
         </li>
         <li>
@@ -80,6 +80,11 @@ Debugging
 Contributing &amp; Help
           </a>
         </li>
+        <li>
+          <a class="toctext" href="../internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article id="docs">
@@ -87,15 +92,15 @@ Contributing &amp; Help
         <nav>
           <ul>
             <li>
-Getting Started
+In Action
             </li>
             <li>
-              <a href="custom.html">
+              <a href="logreg.html">
-Custom Layers
+Logistic Regression
               </a>
             </li>
           </ul>
-          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/2e7971fb6d95f58de7b656acddb7ffade4b2ed16/docs/src/manual/custom.md">
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/examples/logreg.md">
             <span class="fa">
 
             </span>
@@ -105,8 +110,8 @@ Custom Layers
         <hr/>
       </header>
       <h1>
-        <a class="nav-anchor" id="Custom-Layers-1" href="#Custom-Layers-1">
+        <a class="nav-anchor" id="Logistic-Regression-with-MNIST-1" href="#Logistic-Regression-with-MNIST-1">
-Custom Layers
+Logistic Regression with MNIST
         </a>
       </h1>
       <p>
@@ -114,20 +119,20 @@ Custom Layers
       </p>
       <footer>
         <hr/>
-        <a class="previous" href="basics.html">
+        <a class="previous" href="../manual/debugging.html">
           <span class="direction">
 Previous
           </span>
           <span class="title">
-Basics
+Debugging
           </span>
         </a>
-        <a class="next" href="recurrent.html">
+        <a class="next" href="../contributing.html">
           <span class="direction">
 Next
           </span>
           <span class="title">
-Recurrence
+Contributing &amp; Help
           </span>
         </a>
       </footer>

latest/index.html

@@ -48,19 +48,9 @@ Home
           </a>
           <ul class="internal"></ul>
         </li>
-        <li>
-          <span class="toctext">
-Getting Started
-          </span>
-          <ul>
         <li>
           <a class="toctext" href="manual/basics.html">
-Basics
+First Steps
-              </a>
-            </li>
-            <li>
-              <a class="toctext" href="manual/custom.html">
-Custom Layers
           </a>
         </li>
         <li>
@@ -73,6 +63,16 @@ Recurrence
 Debugging
           </a>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
           </ul>
         </li>
         <li>
@@ -80,6 +80,11 @@ Debugging
 Contributing &amp; Help
           </a>
         </li>
+        <li>
+          <a class="toctext" href="internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article id="docs">
@@ -92,7 +97,7 @@ Home
               </a>
             </li>
           </ul>
-          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/2e7971fb6d95f58de7b656acddb7ffade4b2ed16/docs/src/index.md">
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/index.md">
             <span class="fa">
 
             </span>
@@ -113,7 +118,7 @@ Flux is a high-level interface for machine learning, implemented in Julia.
 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&#39;s the catch? Flux is at an early &quot;working prototype&quot; stage; many things work but the API is still in a state of... well, it might change.
+So what&#39;s the catch? Flux is at an early &quot;working prototype&quot; stage; many things work but the API is still in a state of... well, it might change. Also, this documentation is pretty incomplete.
       </p>
       <p>
 If you&#39;re interested to find out what 
@@ -129,7 +134,7 @@ does
 Next
           </span>
           <span class="title">
-Basics
+First Steps
           </span>
         </a>
       </footer>

latest/internals.html

@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+    <title>
+Internals · 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>
+          <a class="toctext" href="manual/basics.html">
+First Steps
+          </a>
+        </li>
+        <li>
+          <a class="toctext" href="manual/recurrent.html">
+Recurrence
+          </a>
+        </li>
+        <li>
+          <a class="toctext" href="manual/debugging.html">
+Debugging
+          </a>
+        </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          <a class="toctext" href="contributing.html">
+Contributing &amp; Help
+          </a>
+        </li>
+        <li class="current">
+          <a class="toctext" href="internals.html">
+Internals
+          </a>
+          <ul class="internal"></ul>
+        </li>
+      </ul>
+    </nav>
+    <article id="docs">
+      <header>
+        <nav>
+          <ul>
+            <li>
+              <a href="internals.html">
+Internals
+              </a>
+            </li>
+          </ul>
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/internals.md">
+            <span class="fa">
+
+            </span>
+ Edit on GitHub
+          </a>
+        </nav>
+        <hr/>
+      </header>
+      <h1>
+        <a class="nav-anchor" id="Internals-1" href="#Internals-1">
+Internals
+        </a>
+      </h1>
+      <p>
+[WIP]
+      </p>
+      <footer>
+        <hr/>
+        <a class="previous" href="contributing.html">
+          <span class="direction">
+Previous
+          </span>
+          <span class="title">
+Contributing &amp; Help
+          </span>
+        </a>
+      </footer>
+    </article>
+  </body>
+</html>

latest/manual/basics.html

@@ -4,7 +4,7 @@
     <meta charset="UTF-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
     <title>
-Basics · Flux
+First Steps · Flux
     </title>
     <script>
 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
@@ -47,14 +47,9 @@ Version
 Home
           </a>
         </li>
-        <li>
-          <span class="toctext">
-Getting Started
-          </span>
-          <ul>
         <li class="current">
           <a class="toctext" href="basics.html">
-Basics
+First Steps
           </a>
           <ul class="internal">
             <li>
@@ -74,11 +69,6 @@ An MNIST Example
             </li>
           </ul>
         </li>
-            <li>
-              <a class="toctext" href="custom.html">
-Custom Layers
-              </a>
-            </li>
         <li>
           <a class="toctext" href="recurrent.html">
 Recurrence
@@ -89,6 +79,16 @@ Recurrence
 Debugging
           </a>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="../examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
           </ul>
         </li>
         <li>
@@ -96,6 +96,11 @@ Debugging
 Contributing &amp; Help
           </a>
         </li>
+        <li>
+          <a class="toctext" href="../internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article id="docs">
@@ -103,15 +108,12 @@ Contributing &amp; Help
         <nav>
           <ul>
             <li>
-Getting Started
-            </li>
-            <li>
               <a href="basics.html">
-Basics
+First Steps
               </a>
             </li>
           </ul>
-          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/2e7971fb6d95f58de7b656acddb7ffade4b2ed16/docs/src/manual/basics.md">
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/manual/basics.md">
             <span class="fa">
 
             </span>
@@ -174,12 +176,12 @@ Previous
 Home
           </span>
         </a>
-        <a class="next" href="custom.html">
+        <a class="next" href="recurrent.html">
           <span class="direction">
 Next
           </span>
           <span class="title">
-Custom Layers
+Recurrence
           </span>
         </a>
       </footer>

latest/manual/debugging.html

@@ -47,19 +47,9 @@ Version
 Home
           </a>
         </li>
-        <li>
-          <span class="toctext">
-Getting Started
-          </span>
-          <ul>
         <li>
           <a class="toctext" href="basics.html">
-Basics
+First Steps
-              </a>
-            </li>
-            <li>
-              <a class="toctext" href="custom.html">
-Custom Layers
           </a>
         </li>
         <li>
@@ -73,6 +63,16 @@ Debugging
           </a>
           <ul class="internal"></ul>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="../examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
           </ul>
         </li>
         <li>
@@ -80,6 +80,11 @@ Debugging
 Contributing &amp; Help
           </a>
         </li>
+        <li>
+          <a class="toctext" href="../internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article id="docs">
@@ -87,15 +92,12 @@ Contributing &amp; Help
         <nav>
           <ul>
             <li>
-Getting Started
-            </li>
-            <li>
               <a href="debugging.html">
 Debugging
               </a>
             </li>
           </ul>
-          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/2e7971fb6d95f58de7b656acddb7ffade4b2ed16/docs/src/manual/debugging.md">
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/manual/debugging.md">
             <span class="fa">
 
             </span>
@@ -122,12 +124,12 @@ Previous
 Recurrence
           </span>
         </a>
-        <a class="next" href="../contributing.html">
+        <a class="next" href="../examples/logreg.html">
           <span class="direction">
 Next
           </span>
           <span class="title">
-Contributing &amp; Help
+Logistic Regression
           </span>
         </a>
       </footer>

latest/manual/recurrent.html

@@ -47,19 +47,9 @@ Version
 Home
           </a>
         </li>
-        <li>
-          <span class="toctext">
-Getting Started
-          </span>
-          <ul>
         <li>
           <a class="toctext" href="basics.html">
-Basics
+First Steps
-              </a>
-            </li>
-            <li>
-              <a class="toctext" href="custom.html">
-Custom Layers
           </a>
         </li>
         <li class="current">
@@ -73,6 +63,16 @@ Recurrence
 Debugging
           </a>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="../examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
           </ul>
         </li>
         <li>
@@ -80,6 +80,11 @@ Debugging
 Contributing &amp; Help
           </a>
         </li>
+        <li>
+          <a class="toctext" href="../internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article id="docs">
@@ -87,15 +92,12 @@ Contributing &amp; Help
         <nav>
           <ul>
             <li>
-Getting Started
-            </li>
-            <li>
               <a href="recurrent.html">
 Recurrence
               </a>
             </li>
           </ul>
-          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/2e7971fb6d95f58de7b656acddb7ffade4b2ed16/docs/src/manual/recurrent.md">
+          <a class="edit-page" href="https://github.com/MikeInnes/Flux.jl/tree/a146c478f3f39fd990ce94ce4a55ac0974a9f5b1/docs/src/manual/recurrent.md">
             <span class="fa">
 
             </span>
@@ -114,12 +116,12 @@ Recurrent Models
       </p>
       <footer>
         <hr/>
-        <a class="previous" href="custom.html">
+        <a class="previous" href="basics.html">
           <span class="direction">
 Previous
           </span>
           <span class="title">
-Custom Layers
+First Steps
           </span>
         </a>
         <a class="next" href="debugging.html">

latest/search.html

@@ -47,19 +47,9 @@ Version
 Home
           </a>
         </li>
-        <li>
-          <span class="toctext">
-Getting Started
-          </span>
-          <ul>
         <li>
           <a class="toctext" href="manual/basics.html">
-Basics
+First Steps
-              </a>
-            </li>
-            <li>
-              <a class="toctext" href="manual/custom.html">
-Custom Layers
           </a>
         </li>
         <li>
@@ -72,6 +62,16 @@ Recurrence
 Debugging
           </a>
         </li>
+        <li>
+          <span class="toctext">
+In Action
+          </span>
+          <ul>
+            <li>
+              <a class="toctext" href="examples/logreg.html">
+Logistic Regression
+              </a>
+            </li>
           </ul>
         </li>
         <li>
@@ -79,6 +79,11 @@ Debugging
 Contributing &amp; Help
           </a>
         </li>
+        <li>
+          <a class="toctext" href="internals.html">
+Internals
+          </a>
+        </li>
       </ul>
     </nav>
     <article>

latest/search_index.js

@@ -13,20 +13,20 @@ var documenterSearchIndex = {"docs": [
     "page": "Home",
     "title": "Flux",
     "category": "section",
-    "text": "Flux is a high-level interface for machine learning, implemented in Julia.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.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 does work, read on!"
+    "text": "Flux is a high-level interface for machine learning, implemented in Julia.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.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. Also, this documentation is pretty incomplete.If you're interested to find out what does work, read on!"
 },
 
 {
     "location": "manual/basics.html#",
-    "page": "Basics",
+    "page": "First Steps",
-    "title": "Basics",
+    "title": "First Steps",
     "category": "page",
     "text": ""
 },
 
 {
     "location": "manual/basics.html#Basic-Usage-1",
-    "page": "Basics",
+    "page": "First Steps",
     "title": "Basic Usage",
     "category": "section",
     "text": ""
@@ -34,7 +34,7 @@ var documenterSearchIndex = {"docs": [
 
 {
     "location": "manual/basics.html#Installation-1",
-    "page": "Basics",
+    "page": "First Steps",
     "title": "Installation",
     "category": "section",
     "text": "Pkg.clone(\"https://github.com/MikeInnes/DataFlow.jl\")\nPkg.clone(\"https://github.com/MikeInnes/Flux.jl\")"
@@ -42,7 +42,7 @@ var documenterSearchIndex = {"docs": [
 
 {
     "location": "manual/basics.html#The-Model-1",
-    "page": "Basics",
+    "page": "First Steps",
     "title": "The Model",
     "category": "section",
     "text": "Charging Ion Capacitors...The core concept in Flux is that of the model. A model is simply a function with parameters. In Julia, we might define the following function:W = randn(3,5)\nb = randn(3)\naffine(x) = W*x + b\n\nx1 = randn(5)\naffine(x1)\n> 3-element Array{Float64,1}:\n   -0.0215644\n   -4.07343  \n    0.312591"
@@ -50,28 +50,12 @@ var documenterSearchIndex = {"docs": [
 
 {
     "location": "manual/basics.html#An-MNIST-Example-1",
-    "page": "Basics",
+    "page": "First Steps",
     "title": "An MNIST Example",
     "category": "section",
     "text": ""
 },
 
-{
-    "location": "manual/custom.html#",
-    "page": "Custom Layers",
-    "title": "Custom Layers",
-    "category": "page",
-    "text": ""
-},
-
-{
-    "location": "manual/custom.html#Custom-Layers-1",
-    "page": "Custom Layers",
-    "title": "Custom Layers",
-    "category": "section",
-    "text": "[WIP]"
-},
-
 {
     "location": "manual/recurrent.html#",
     "page": "Recurrence",
@@ -104,6 +88,22 @@ var documenterSearchIndex = {"docs": [
     "text": "[WIP]"
 },
 
+{
+    "location": "examples/logreg.html#",
+    "page": "Logistic Regression",
+    "title": "Logistic Regression",
+    "category": "page",
+    "text": ""
+},
+
+{
+    "location": "examples/logreg.html#Logistic-Regression-with-MNIST-1",
+    "page": "Logistic Regression",
+    "title": "Logistic Regression with MNIST",
+    "category": "section",
+    "text": "[WIP]"
+},
+
 {
     "location": "contributing.html#",
     "page": "Contributing & Help",
@@ -120,4 +120,20 @@ var documenterSearchIndex = {"docs": [
     "text": "[WIP]"
 },
 
+{
+    "location": "internals.html#",
+    "page": "Internals",
+    "title": "Internals",
+    "category": "page",
+    "text": ""
+},
+
+{
+    "location": "internals.html#Internals-1",
+    "page": "Internals",
+    "title": "Internals",
+    "category": "section",
+    "text": "[WIP]"
+},
+
 ]}