TastyPancakes/Flux.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

src docs

Browse Source
This commit is contained in:
Mike J Innes 2017-05-04 13:17:21 +01:00
parent e04dcbd460
commit 70286c0bf3
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/readme.md Normal file
View File

@ -0,0 +1,9 @@
`model.jl` implements the core Flux API for forward and backward passes.
The `compiler` folder implements the `@net` macro and some dataflow manipulation (like loop unrolling). The `mxnet` and `tensorflow` folders in `backend` each describe how to run `@net` code on those backends. These are the most involved parts of Flux where the magic-y stuff happens, but everything else is pretty straightforward Julia code.
`layers` is Flux's "standard library" of model parts; layers, activations, cost functions. Most are implemented using `@net`. `control.jl` implements `Chain` and others in pure Julia. `shims.jl` includes some things like convolutions which don't have "real" implementations yet, but can compile to a backend regardless.
`dims` implements the mechanisms for typing batch (and other) dimensions. This is basically standalone.
`data.jl` and `utils.jl` implement misc utilities.