Commit Graph

320 Commits

Author SHA1 Message Date
Lyndon White c76b9c7e2c fix docs 2019-03-18 12:20:46 +00:00
Lyndon White 838047f708 fix docs 2019-03-18 12:19:44 +00:00
Lyndon White c1a33c556f do things to docs 2019-03-18 12:19:44 +00:00
David Ellison 263a3248f6 add Flux.stop to training docs 2019-03-11 19:52:05 -07:00
Mike J Innes b348e31f07
Merge pull request #667 from FluxML/donottrack
rm Tracker
2019-03-08 11:38:37 +00:00
Mike J Innes 194e2ecd50 update docs manifest 2019-03-08 11:20:39 +00:00
Manjunath Bhat 922e9c9bc2
Updated docs with AlphaDropout 2019-03-04 01:10:12 +05:30
Lyndon White ebf50f4e1c Create performance tips docs section (#615)
* Create performance_tips.jl

* Rename performance_tips.jl to performance_tips.md

* add perf tips

* Update docs/src/performance_tips.md

Co-Authored-By: oxinabox <oxinabox@ucc.asn.au>

* Update docs/src/performance_tips.md

Co-Authored-By: oxinabox <oxinabox@ucc.asn.au>

* Update make.jl

* Update and rename performance_tips.md to performance.md

* spelling

* Update docs/src/performance.md

Co-Authored-By: oxinabox <oxinabox@ucc.asn.au>

* Update docs/src/performance.md

Co-Authored-By: oxinabox <oxinabox@ucc.asn.au>

* Update performance.md

* Update performance.md

* Update docs/src/performance.md

Co-Authored-By: oxinabox <oxinabox@ucc.asn.au>

* Update docs/src/performance.md

Co-Authored-By: oxinabox <oxinabox@ucc.asn.au>
2019-02-19 15:03:41 +00:00
Ayan Banerjee 08b87e0bce Transition to doctests (#616)
* basics.md: Initial doctest to an example

Related to https://github.com/FluxML/Flux.jl/issues/561

* make.jl: Allow doctest to run

* Fix comments in order to pass doctests

* basic.md: Add doctests to examples
2019-02-14 18:29:27 +00:00
Avik Pal c093d089a6
Add conv_transpose to docs 2019-02-06 21:11:41 +05:30
Mike J Innes 8386a49bf9
Merge pull request #575 from FluxML/mji/update
Clean up parameter update API
2019-01-28 15:26:57 +00:00
Mike J Innes e1cac76a34 params update 2019-01-28 14:14:41 +00:00
Mike J Innes 0f8a4a48c6 extend update! with an optimiser 2019-01-28 14:10:09 +00:00
Mike J Innes bb2210f552
Merge pull request #553 from xiaodaigh/patch-2
Updated with more detailed instructions for installing CuArrays
2019-01-28 10:36:27 +00:00
susabi 5930ac1730
simplified instructions 2019-01-26 12:26:48 +11:00
Arnaud Amzallag 3cc3c463a3
Adding `nest = true` option in `Tracker.gradient`
otherwise fails and returns an error. Note that option has to be added in both `df` and `d2f`.
2019-01-24 19:29:29 -05:00
Ayan Banerjee bc68dfbd75
docs/basics.md: Add `using Flux`
In order to import sigmoid function.
2019-01-23 19:20:10 +05:30
Ayan Banerjee 236b103b73
docs/basics.md: Add `tracked` after 1.0 2019-01-22 23:37:34 +05:30
susabi 3f62bc30b9
Update gpu.md 2019-01-11 15:57:54 +11:00
susabi e13c6c1125
updated gpu.md with installation instructions 2019-01-11 15:55:39 +11:00
Kristoffer Carlsson 2298e4fea1 modernize documentation 2019-01-10 15:06:11 +01:00
Mike J Innes f0d5624ed2
Merge pull request #493 from dhairyagandhi96/master
[WIP] New Optimiser Docs
2019-01-10 11:10:38 +00:00
Mike J Innes 81e5551256 tweaks 2019-01-10 11:01:57 +00:00
Kristoffer Carlsson 202424d1b1
Docs: fix link to CuArrays 2019-01-03 01:25:25 +01:00
Robert Hönig 0f243dba29
Correct CuArrays requirements.
According to the CuArrays README, "CuArrays should work out-of-the-box on Julia 1.0."
Correct the outdated Julia 0.6 requirement. Also, update the instructions link to point to the
CuArrays.jl README, which has setup instructions (CUDAnative.jl's README doesn't).
2018-12-19 09:23:26 +01:00
Dhairya Gandhi eb287ae9a0 fixed optimisers syntax 2018-12-04 16:08:03 +05:30
Dhairya Gandhi d412845192 added training api changes 2018-12-01 16:59:27 +05:30
Dhairya Gandhi 1ea8c5a293 [WIP] add docstrings and doc improvements 2018-11-12 19:17:10 +05:30
Dhairya Gandhi 07397bc950 [WIP] add links to sgd 2018-11-12 17:53:53 +05:30
Dhairya Gandhi 4562682528 [WIP] add optimiser docs 2018-11-12 17:42:52 +05:30
Mike J Innes bbccdb3eec
Merge pull request #279 from avik-pal/depthwiseconv
Adds support for Depthwise Convolutions
2018-10-23 17:22:15 +01:00
harryscholes 61c14afee4 Add usage example of custom gradients 2018-10-09 13:05:38 +01:00
Harry 179a1e8407
Correct Custom Gradients docs
* Fixed a type signature that was incorrect.
* Also, replaced `data(a)` with `a.data`. Don't know if the syntax has changed (recently). This may also need to be corrected in line 121.

MWE:

```julia
using Flux
using Flux.Tracker
using Flux.Tracker: forward, TrackedReal, track, @grad

minus(a, b) = a - b
minus(a::TrackedReal, b::TrackedReal) = Tracker.track(minus, a, b)
@grad function minus(a, b)
    return minus(a.data, b.data), Δ -> (Δ, -Δ)
end

a, b = param(2), param(4)
c = minus(a, b)  # -2.0 (tracked)
Tracker.back!(c)

Tracker.grad(a)  # 1.00
Tracker.grad(b)  # -1.00
```
2018-09-21 16:57:54 +01:00
Harry 079614adb2
Fix typo 2018-09-19 16:45:11 +01:00
Avik Pal eb9b408c0f
Merge branch 'master' into depthwiseconv 2018-09-15 10:21:31 +05:30
Sambit Kumar Dash 8b9a98ed01
The sample gradient should not use the softdash
While softdash is a very natural and mathematical way of representation, it can be very easily confused with the apostrophe used for LinAlg adjoint. Not worth and unnecessary confusion in a first example of the code.
2018-09-11 18:58:07 +05:30
Mike J Innes 395a35d137 better headings 2018-09-05 17:03:41 +01:00
Mike J Innes 193c4ded19 make docs on 1.0 2018-09-05 16:52:50 +01:00
Mike J Innes b7eaf393fc docs updates 2018-09-05 16:01:57 +01:00
Mike J Innes 41cf1f2a84
Merge pull request #381 from piever/pv/docs
fix julia 1 changes in tutorial
2018-09-04 16:00:58 +01:00
Mike J Innes e6be639436 Merge branch 'master' into HEAD 2018-09-04 14:03:46 +01:00
Pietro Vertechi a012d0bd51 fix vecnorm in docs 2018-08-29 23:39:43 +01:00
Pietro Vertechi abcefb8ae3 fix foldl in tutorial 2018-08-29 18:36:24 +01:00
Yueh-Hua Tu 634d34686e Add new constructors and test 2018-08-24 10:31:13 +08:00
Mike Innes dcde6d2217 tweaks 2018-08-23 15:44:28 +01:00
Avik Pal a0ec472a4b
Merge branch 'master' into depthwiseconv 2018-08-08 01:20:37 +05:30
Avik Pal 4d17a1a809
Merge branch 'master' into depthwiseconv 2018-08-03 19:41:50 +05:30
Mike J Innes 70718e7a64 update treelike 2018-08-03 13:02:47 +01:00
Mike J Innes a49e2eae41 deprecated Void 2018-08-03 12:53:52 +01:00
Yueh-Hua Tu 5b37319289 Add Maxpool and Meanpool 2018-08-01 00:10:53 +08:00
Julien Jerphanion ee630a8566
Very Little typo. 2018-07-18 23:20:43 +02:00
Avik Pal f57db22abe Remove unnecessary file 2018-07-13 14:27:04 +05:30
Avik Pal 2664a16556 Update as per new AD 2018-07-13 14:12:46 +05:30
Avik Pal 0aabf9d86b
Merge branch 'master' into depthwiseconv 2018-07-13 14:04:19 +05:30
Mike J Innes dda51a0140 update docs 2018-07-11 15:31:22 +01:00
Mike Innes 5d8b63dc65 avoid implementation details in docs 2018-06-29 13:53:50 +01:00
Mike J Innes bed6d2311e clearer docs 2018-06-26 16:07:58 +01:00
Mike J Innes d6a75e1289 add `activations` docs 2018-06-26 14:35:03 +01:00
Mike J Innes 4d7548b7a3 Merge commit '1490d87d8387a078a29a336cb37fd7269240179e' 2018-06-26 14:25:36 +01:00
Mike J Innes 1490d87d83 tweaks 2018-06-26 14:25:24 +01:00
Kade aa8f79f10c Mention CUDAnative.jl's install instructions 2018-06-26 14:22:50 +01:00
Avik Pal 4a639687de Typo 2018-06-09 18:59:54 +05:30
Avik Pal 6b294736f9 Add Depthwise Convolution is Docs 2018-06-09 14:19:47 +05:30
kleskjr dd3af0c9f7
add 'using Flux: crossentropy'
Following the suggestion from MikeInnes to use 'using Flux: crossentropy' instead 'Flux.crossentropy'
2018-06-05 14:30:14 +02:00
kleskjr 3a73902379
Solves Issue #262
Makes  the running of the basic examples smoother (Issue #262).
crossentropy is not exported by Flus so, either explicit reference or explicit export should be add to run the examples.
2018-05-25 13:54:17 +02:00
Mike Innes 5685df1691 tracker docs 2018-05-07 16:12:55 +01:00
Mike Innes b35b27be6e doc fix 2018-05-04 15:05:02 +01:00
Iblis Lin 5faf5da171
doc: add GRU to layer reference 2018-04-18 17:36:10 +08:00
Iblis Lin 07ed439005
minor update for gpu.md code block 2018-03-19 20:03:31 +08:00
Mike Innes eab26be0af optimiser state 2018-03-06 09:41:06 +00:00
Mike J Innes 7fe8308831 bson api 2018-03-06 03:12:42 +00:00
Mike Innes 646e90aae2 checkpointing 2018-03-06 03:01:40 +00:00
Mike Innes 6f0d5a44ec model saving docs 2018-03-05 23:52:04 +00:00
Mike J Innes 5c7f856115 cpu docs 2018-03-05 19:25:43 +00:00
Mike J Innes 6b69edfe6c gpu docs 2018-03-05 19:23:13 +00:00
Mike J Innes 662439c164 closes #177 2018-03-05 17:24:46 +00:00
Mike J Innes bdd8162bf8 typo 2018-03-01 16:52:58 +00:00
Mike J Innes dda545a24a unnecessary 2018-02-17 11:22:37 +00:00
Mike J Innes 81ab91418d move train docs 2018-02-16 12:22:53 +00:00
Mike J Innes 1908b4f451 document epochs 2018-02-16 11:23:23 +00:00
Mike J Innes c1ed3e477e more consistent terminology 2018-02-13 17:17:08 +00:00
Mike J Innes 0b3c02fe8d document regularisation, fixes #160 2018-02-09 19:00:26 +00:00
Mike J Innes 62c3376feb link fix 2018-02-02 15:56:04 +00:00
Mike J Innes 140d50208f recommend update 2018-01-17 13:56:19 +00:00
Mike J Innes e3577d759c conv docs 2017-12-18 18:05:48 +00:00
Mike J Innes 6f997e798a Merge branch 'master' into batchnorm 2017-12-08 19:31:50 +00:00
Mike J Innes b06884b912 LayerNorm tweaks 2017-11-21 16:32:36 +01:00
Mike J Innes e51268caf5 mention treelike 2017-11-21 12:59:39 +01:00
Mike J Innes 187fddc11c doc fixes 2017-11-21 12:29:02 +01:00
Iblis Lin 5253841acc batchnorm: update docs 2017-11-02 13:32:12 +08:00
Mike J Innes 4c1b1eb18c Merge pull request #92 from CarloLucibello/drop
add Dropout layer
2017-10-26 12:07:28 +01:00
Mike J Innes cf6b930f63 reorganise 2017-10-26 11:46:12 +01:00
Mike J Innes 6768afda29 minor wording 2017-10-23 13:07:07 +01:00
Mike J Innes 2a66545ef8 rnn state reset 2017-10-19 17:21:08 +01:00
Mike J Innes 5b6a5667ed tracked array restructure 2017-10-18 22:54:58 +01:00
Mike J Innes b817ce632c syntax highlighting 2017-10-18 15:44:06 +01:00
Mike J Innes fd249b773e rnn docs 2017-10-18 15:30:05 +01:00
Mike J Innes 897f812055 remove this until nnlib release 2017-10-18 14:52:48 +01:00
Mike J Innes 190f48a709 nnlib docs 2017-10-18 14:40:58 +01:00
Mike J Innes 92f65f91c5 update community page 2017-10-18 12:39:58 +01:00
Mike J Innes 55ba236da6 model layers note 2017-10-18 12:31:06 +01:00
Mike J Innes c4166fd725 optimiser clarity 2017-10-18 12:22:45 +01:00
Mike J Innes 7426faf37d optimiser docs 2017-10-18 12:09:48 +01:00
Mike J Innes 6dff8ca8d3 rename crossentropy loss 2017-10-17 17:36:18 +01:00
Mike J Innes c764b74eba rename and fix mapleaves 2017-10-17 01:08:15 +01:00
Mike J Innes e02e320008 more general fmap 2017-10-17 00:07:15 +01:00
Mike J Innes 32c8698869 clarity 2017-10-16 09:00:14 +01:00
Mike J Innes 83cc77c860 consistency 2017-10-16 08:53:57 +01:00
Mike J Innes 739cef7fb8 ty[p 2017-10-10 13:40:01 +01:00
Mike J Innes 58f4f1540f dataset docs 2017-10-10 12:31:58 +01:00
Mike J Innes a05981732f clarity 2017-10-10 12:31:52 +01:00
Mike J Innes c202e2bc1a clarify 2017-10-03 19:00:42 +01:00
Mike J Innes d3419c943b example link 2017-09-28 11:11:11 +01:00
Mike J Innes 8e63ac766e gpu support docs 2017-09-28 11:08:37 +01:00
Mike J Innes c51f5afb3d clarity 2017-09-27 18:37:07 +01:00
Mike J Innes 96d1c55263 wording tweak 2017-09-22 15:27:06 +01:00
Joel Mason 568869b9bf Minor RNNCell docs fix (#62)
* Minor RNNCell docs fix

Matches the preceding example

* rnn -> rnn2
2017-09-12 13:12:49 +01:00
Mike J Innes 9348a47479 typo 2017-09-12 13:04:47 +01:00
Mike J Innes 972ecab9f9 rm Over Seq 2017-09-12 13:03:16 +01:00
Mike J Innes 519f4c3c32 link fixes 2017-09-12 11:34:04 +01:00
Mike J Innes 7bfa912f7b link fix 2017-09-11 19:45:02 +01:00
Michael K. Borregaard b4b4a4a468 Fix link to basics in docs 2017-09-11 18:38:28 +02:00
Mike J Innes 7041ab9960 rm chainseq 2017-09-11 14:02:43 +01:00
Mike J Innes c80fb999ff one hot docs 2017-09-11 13:40:11 +01:00
Mike J Innes c2db42d38e training docs 2017-09-11 13:06:53 +01:00
Mike J Innes 726a8acefe link fix 2017-09-09 21:12:39 -04:00
Mike J Innes 17e40b1f76 basic training docs 2017-09-09 21:02:09 -04:00
Mike J Innes fedee95b14 docs updates 2017-09-09 19:58:32 -04:00
Mike J Innes 366efa92ab test 2017-09-08 18:07:47 -04:00
Mike J Innes 69740959f0 sigmoid link 2017-09-08 17:54:10 -04:00
Mike J Innes a36d6d2af3 layer docs 2017-09-08 17:52:41 -04:00
Mike J Innes ef61922dde basics 2017-09-08 17:34:58 -04:00
Mike J Innes cbaf661145 better intro 2017-09-07 03:16:45 -04:00
Mike J Innes 61d5e5f98a model section 2017-09-07 01:49:46 -04:00
Mike J Innes 706baabe93 model zoo link 2017-09-07 01:39:16 -04:00
Mike J Innes 0a9aaf9ec3 start of new docs 2017-09-07 01:38:41 -04:00
Mike J Innes 0b095579a1 strip old docs 2017-09-07 01:11:43 -04:00
Mike J Innes a5d811afc2 also in contributing 2017-08-24 10:27:15 +01:00
chengchingwen 9f95c84765 update gitter link 2017-08-24 00:10:43 +08:00
Mike J Innes 70615ff7f2 docs updates 2017-05-04 17:16:22 +01:00
Mike J Innes c66195f47b tighten index 2017-05-04 17:01:22 +01:00
Mike J Innes 7e5669d2f6 update readme 2017-05-03 20:13:31 +01:00
Mike J Innes 4aedab4a9c tweak 2017-05-03 20:01:07 +01:00
Mike J Innes 1bba9631a2 wip functional exposition 2017-05-03 19:57:23 +01:00
Mike J Innes 9b76b307b6 index tweaks 2017-05-03 19:15:41 +01:00
Mike J Innes 06ea4a7dea add more intro 2017-05-03 19:13:47 +01:00
Mike J Innes 50245a16b0 writing gooder 2017-05-03 18:32:58 +01:00
Mike J Innes 124bcf5e47 get docs to deploy 2017-05-02 13:48:34 +01:00
Mike J Innes 6fbacadd11 docs notes 2017-05-02 13:38:37 +01:00
Mike J Innes 3d4c8fa73b update examples 2017-05-02 13:35:53 +01:00