10 lines
8.5 KiB
HTML
10 lines
8.5 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', {'page': location.pathname + location.search + location.hash});
|
||
</script><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/flux.css" rel="stylesheet" type="text/css"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">Flux</span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Installation-1"><span>Installation</span></a></li><li><a class="tocitem" href="#Learning-Flux-1"><span>Learning Flux</span></a></li></ul></li><li><span class="tocitem">Building Models</span><ul><li><a class="tocitem" href="models/basics/">Basics</a></li><li><a class="tocitem" href="models/recurrence/">Recurrence</a></li><li><a class="tocitem" href="models/regularisation/">Regularisation</a></li><li><a class="tocitem" href="models/layers/">Model Reference</a></li><li><a class="tocitem" href="models/advanced/">Advanced Model Building</a></li><li><a class="tocitem" href="models/nnlib/">NNlib</a></li></ul></li><li><span class="tocitem">Handling Data</span><ul><li><a class="tocitem" href="data/onehot/">One-Hot Encoding</a></li><li><a class="tocitem" href="data/dataloader/">DataLoader</a></li></ul></li><li><span class="tocitem">Training Models</span><ul><li><a class="tocitem" href="training/optimisers/">Optimisers</a></li><li><a class="tocitem" href="training/training/">Training</a></li></ul></li><li><a class="tocitem" href="gpu/">GPU Support</a></li><li><a class="tocitem" href="saving/">Saving & Loading</a></li><li><a class="tocitem" href="ecosystem/">The Julia Ecosystem</a></li><li><a class="tocitem" href="utilities/">Utility Functions</a></li><li><a class="tocitem" href="performance/">Performance Tips</a></li><li><a class="tocitem" href="datasets/">Datasets</a></li><li><a class="tocitem" href="community/">Community</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/FluxML/Flux.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Flux:-The-Julia-Machine-Learning-Library-1"><a class="docs-heading-anchor" href="#Flux:-The-Julia-Machine-Learning-Library-1">Flux: The Julia Machine Learning Library</a><a class="docs-heading-anchor-permalink" href="#Flux:-The-Julia-Machine-Learning-Library-1" title="Permalink"></a></h1><p>Flux is a library for machine learning. It comes "batteries-included" with many useful tools built in, but also lets you use the full power of the Julia language where you need it. We follow a few key principles:</p><ul><li><strong>Doing the obvious thing</strong>. Flux has relatively few explicit APIs for features like regularisation or embeddings. Instead, writing down the mathematical form will work – and be fast.</li><li><strong>You could have written Flux</strong>. All of it, from <a href="https://github.com/FluxML/Flux.jl/blob/ec16a2c77dbf6ab8b92b0eecd11661be7a62feef/src/layers/recurrent.jl#L131">LSTMs</a> to <a href="https://github.com/JuliaGPU/CuArrays.jl">GPU kernels</a>, is straightforward Julia code. When in doubt, it’s well worth looking at <a href="https://github.com/FluxML/Flux.jl/">the source</a>. If you need something different, you can easily roll your own.</li><li><strong>Play nicely with others</strong>. Flux works well with Julia libraries from <a href="https://github.com/JuliaComputing/JuliaDB.jl">data frames</a> and <a href="https://github.com/JuliaImages/Images.jl">images</a> to <a href="https://github.com/JuliaDiffEq/DifferentialEquations.jl">differential equation solvers</a>, so you can easily build complex data processing pipelines that integrate Flux models.</li></ul><h2 id="Installation-1"><a class="docs-heading-anchor" href="#Installation-1">Installation</a><a class="docs-heading-anchor-permalink" href="#Installation-1" title="Permalink"></a></h2><p>Download <a href="https://julialang.org/">Julia 1.0</a> or later, if you haven't already. You can add Flux from using Julia's package manager, by typing <code>] add Flux</code> in the Julia prompt.</p><p>If you have CUDA you can also run <code>] add CuArrays</code> to get GPU support; see <a href="gpu/">here</a> for more details.</p><h2 id="Learning-Flux-1"><a class="docs-heading-anchor" href="#Learning-Flux-1">Learning Flux</a><a class="docs-heading-anchor-permalink" href="#Learning-Flux-1" title="Permalink"></a></h2><p>There are several different ways to learn Flux. If you just want to get started writing models, the <a href="https://github.com/FluxML/model-zoo/">model zoo</a> gives good starting points for many common ones. This documentation provides a reference to all of Flux's APIs, as well as a from-scratch introduction to Flux's take on models and how they work. Once you understand these docs, congratulations, you also understand <a href="https://github.com/FluxML/Flux.jl">Flux's source code</a>, which is intended to be concise, legible and a good reference for more advanced concepts.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="models/basics/">Basics »</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Wednesday 27 May 2020 11:52">Wednesday 27 May 2020</span>. Using Julia version 1.3.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|