docs index update

This commit is contained in:
Mike J Innes 2017-02-24 15:48:45 +00:00
parent bad6b2d1ae
commit 5ac09338ba
1 changed files with 8 additions and 2 deletions

View File

@ -4,9 +4,15 @@ 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.
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!
If you're interested to find out what *does* work, read on!
## Where do I start?
The [examples](@ref Logistic Regression) 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.
If you have more experience with ML, or you just don't want to see *those digits* again, check out the [model building guide](@ref Model Building Basics) instead. The Guide attempts to motivate Flux's programming model and approach with examples. However, it also gets into advanced usage very quickly, so it's not necessary to memorise all the details to use Flux effectively.
The sections on [Recurrence](@ref), [Debugging](@ref) and [Batching](@ref) best illustrate what makes Flux unique.
## Installation