From 70286c0bf3cb15943fcb1914b85bec9c30cf38bd Mon Sep 17 00:00:00 2001 From: Mike J Innes Date: Thu, 4 May 2017 13:17:21 +0100 Subject: [PATCH] src docs --- src/readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 src/readme.md diff --git a/src/readme.md b/src/readme.md new file mode 100644 index 00000000..6fd87a33 --- /dev/null +++ b/src/readme.md @@ -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.