start of new docs

This commit is contained in:
Mike J Innes 2017-09-07 01:38:41 -04:00
parent 16c34d6987
commit 0a9aaf9ec3
5 changed files with 17 additions and 2 deletions

View File

@ -7,7 +7,9 @@ makedocs(modules=[Flux],
sitename = "Flux",
assets = ["../flux.css"],
pages = ["Home" => "index.md",
"Contributing & Help" => "contributing.md"])
"Basics" => "basics.md",
"Recurrence" => "recurrence.md",
"Contributing & Help" => "contributing.md"])
deploydocs(
repo = "github.com/FluxML/Flux.jl.git",

0
docs/src/basics.md Normal file
View File

View File

@ -4,6 +4,6 @@ If you need help, please ask on the [Julia forum](https://discourse.julialang.or
Right now, the best way to help out is to try out the examples and report any issues or missing features as you find them. The second best way is to help us spread the word, perhaps by [starring the repo](https://github.com/MikeInnes/Flux.jl).
If you're interested in hacking on Flux, most of the [code](https://github.com/MikeInnes/Flux.jl/tree/master/src) is pretty straightforward. Adding new [layer definitions](https://github.com/MikeInnes/Flux.jl/tree/master/src/layers) or cost functions is simple using the Flux DSL itself, and things like data utilities and training processes are all plain Julia code. The `compiler` directory is a bit more involved and is documented in [internals](interals.html), but most changes won't need to touch that.
If you're interested in hacking on Flux, most of the [code](https://github.com/MikeInnes/Flux.jl/tree/master/src) is pretty straightforward. Adding new [layer definitions](https://github.com/MikeInnes/Flux.jl/tree/master/src/layers) or cost functions is simple using the Flux DSL itself, and things like data utilities and training processes are all plain Julia code.
If you get stuck or need anything, let us know!

View File

@ -1 +1,14 @@
# Flux
Flux is a library for machine learning, implemented in Julia. Flux lets you use the full power of the Julia language while providing a set of useful helper functionality, like common mathematical functions and optimisers.
# Installation
Install [Julia 0.6.0 or later](https://julialang.org/downloads/), if you haven't already.
```julia
Pkg.add("Flux")
Pkg.test("Flux") # Check things installed correctly
```
Start with the [basics](basics.html). The [model zoo] is also a good starting point for many common kinds of models.

0
docs/src/recurrence.md Normal file
View File