Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an example to the readme? #2067

Merged
merged 7 commits into from
Oct 8, 2022
Merged

Add an example to the readme? #2067

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1b7cf9d
add example to readme
mcabbott Sep 26, 2022
b490002
add installation note, tweak
mcabbott Sep 26, 2022
a22a904
tweak wording, remove tutorials link
mcabbott Sep 27, 2022
37cdcca
try adding comments
mcabbott Sep 27, 2022
6689513
mv slack to text, add downloads badge
mcabbott Oct 2, 2022
1a42167
change to use logitcrossentropy
mcabbott Oct 6, 2022
e1ca78b
mention that loss(x,y) closes over model
mcabbott Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
<img width="400px" src="https://raw.githubusercontent.com/FluxML/fluxml.github.io/master/logo.png"/>
</p>

[![][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]
<div align="center">

[![](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/) [![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) [![DOI](https://joss.theoj.org/papers/10.21105/joss.00602/status.svg)](https://doi.org/10.21105/joss.00602)

[![][action-img]][action-url] [![][codecov-img]][codecov-url]
Copy link
Member Author

@mcabbott mcabbott Sep 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved because these badges wrapped to 2 lines, and seemed to be in random order. This puts the CI ones on 2nd line, and centres them below the logo.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think FluxML projects should also include the "number of downloads" badge in their READMEs -

Flux Downloads
Zygote Downloads
NNlib Downloads
Functors Downloads
Metalhead Downloads
FastAI Downloads
... and so on

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could do, 88k sounds like a lot...


</div>

[action-img]: https://github.com/FluxML/Flux.jl/workflows/CI/badge.svg
[action-url]: https://github.com/FluxML/Flux.jl/actions
Expand All @@ -12,7 +18,19 @@
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.

```julia
] add Flux
using Flux

x = hcat(digits.(0:3, base=2, pad=2)...) |> gpu
y = Flux.onehotbatch(xor.(eachrow(x)...), 0:1) |> gpu
data = ((Float32.(x), y) for _ in 1:100)

model = Chain(Dense(2 => 3, sigmoid), BatchNorm(3), Dense(3 => 2), softmax) |> gpu
optim = Adam(0.1, (0.7, 0.95))
loss(x, y) = Flux.crossentropy(model(x), y)
mcabbott marked this conversation as resolved.
Show resolved Hide resolved

Flux.train!(loss, Flux.params(model), data, optim)

all((model(x) .> 0.5) .== y)
```

See the [documentation](https://fluxml.github.io/Flux.jl/) or the [model zoo](https://github.com/FluxML/model-zoo/) for examples.
Expand Down