From dfc5a7e17c61bce332c2657452695f5d528d0f53 Mon Sep 17 00:00:00 2001 From: Michael Abbott <32575566+mcabbott@users.noreply.github.com> Date: Sat, 8 Oct 2022 07:36:17 -0400 Subject: [PATCH] Add an example to the readme? (#2067) * add example to readme * add installation note, tweak * tweak wording, remove tutorials link * try adding comments * mv slack to text, add downloads badge * change to use logitcrossentropy * mention that loss(x,y) closes over model this is a slightly weird feature of our API... and since we also call logitcrossentropy a loss function, perhaps we should emphasize that loss(x,y) is a new thing just for this model, not a function for all time. --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8bd4c87713..1dec5940e7 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,13 @@

-[![][action-img]][action-url] [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://fluxml.github.io/Flux.jl/stable/) [![](https://img.shields.io/badge/chat-on%20slack-yellow.svg)](https://julialang.org/slack/) [![DOI](https://joss.theoj.org/papers/10.21105/joss.00602/status.svg)](https://doi.org/10.21105/joss.00602) [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac) [![][codecov-img]][codecov-url] +
+ +[![](https://img.shields.io/badge/Documentation-stable-blue.svg)](https://fluxml.github.io/Flux.jl/stable/) [![DOI](https://joss.theoj.org/papers/10.21105/joss.00602/status.svg)](https://doi.org/10.21105/joss.00602) [![Flux Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/Flux)](https://pkgs.genieframework.com?packages=Flux) +
+[![][action-img]][action-url] [![][codecov-img]][codecov-url] [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac) + +
[action-img]: https://github.com/FluxML/Flux.jl/workflows/CI/badge.svg [action-url]: https://github.com/FluxML/Flux.jl/actions @@ -12,10 +18,23 @@ Flux is an elegant approach to machine learning. It's a 100% pure-Julia stack, and provides lightweight abstractions on top of Julia's native GPU and AD support. Flux makes the easy things easy while remaining fully hackable. +Works best with [Julia 1.8](https://julialang.org/downloads/) or later. Here's a simple example to try it out: ```julia -] add Flux +using Flux # should install everything for you, including CUDA + +x = hcat(digits.(0:3, base=2, pad=2)...) |> gpu # let's solve the XOR problem! +y = Flux.onehotbatch(xor.(eachrow(x)...), 0:1) |> gpu +data = ((Float32.(x), y) for _ in 1:100) # an iterator making Tuples + +model = Chain(Dense(2 => 3, sigmoid), BatchNorm(3), Dense(3 => 2)) |> gpu +optim = Adam(0.1, (0.7, 0.95)) +mloss(x, y) = Flux.logitcrossentropy(model(x), y) # closes over model + +Flux.train!(mloss, Flux.params(model), data, optim) # updates model & optim + +all((softmax(model(x)) .> 0.5) .== y) # usually 100% accuracy. ``` -See the [documentation](https://fluxml.github.io/Flux.jl/) or the [model zoo](https://github.com/FluxML/model-zoo/) for examples. +See the [documentation](https://fluxml.github.io/Flux.jl/) for details, or the [model zoo](https://github.com/FluxML/model-zoo/) for examples. Ask questions on the [Julia discourse](https://discourse.julialang.org/) or [slack](https://discourse.julialang.org/t/announcing-a-julia-slack/4866). If you use Flux in your research, please [cite](CITATION.bib) our work.