Skip to content

Commit c9fc2aa

Browse files
authored
Add versions to Readme list (#371)
* Add versions to Readme list * also add the logo, why not * add two missing models * tweak
1 parent f3c21d7 commit c9fc2aa

File tree

1 file changed

+45
-26
lines changed

1 file changed

+45
-26
lines changed

README.md

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<img align="right" width="200px" src="https://github.com/FluxML/Optimisers.jl/raw/master/docs/src/assets/logo.png">
2+
13
# Flux Model Zoo
24

35
This repository contains various demonstrations of the [Flux](http://fluxml.github.io/) machine learning library. Any of these may freely be used as a starting point for your own models.
@@ -48,32 +50,49 @@ You can contribute in one of the following ways
4850
* Mention the technique that is being demonstrated. Briefly describe the learning technique being demonstrated (Computer vision, regression, NLP, time series, etc.).
4951
* Write in-depth tutorials for a model: You can further extend the documentation of a model and create a tutorial to explain in more detail the architecture, the training routine, use your own data, and so forth. After you write a tutorial, create a PR with it for the [Tutorials](https://fluxml.ai/tutorials.html) section on the [FluxML](https://fluxml.ai/) website.
5052

53+
### Update a model
54+
55+
Each example lists the version of Flux for which it was most recently updated.
56+
Bringing them up to the latest is a great way to learn!
57+
Flux has a [NEWS page](https://github.com/FluxML/Flux.jl/blob/master/NEWS.md) listing important changes.
58+
(For other packages, see their releses page: [MLUtils](https://github.com/JuliaML/MLUtils.jl/releases), [MLDatasets](https://github.com/JuliaML/MLDatasets.jl/releases), etc.)
59+
60+
To run the old examples, Flux v0.11 can be installed and run on [Julia 1.6, the LTS version](https://julialang.org/downloads/#long_term_support_release).
61+
Flux v0.12 works on Julia 1.8.
62+
Flux 0.13 is the latest right now, marked with ☀️.
5163

5264
## Examples Listing
5365

54-
* Vision
55-
* MNIST
56-
* [Simple multi-layer perceptron](vision/mlp_mnist)
57-
* [Simple ConvNet (LeNet)](vision/conv_mnist)
58-
* [Variational Auto-Encoder](vision/vae_mnist)
59-
* [Deep Convolutional Generative Adversarial Networks](vision/dcgan_mnist)
60-
* [Conditional Deep Convolutional Generative Adversarial Networks](vision/cdcgan_mnist)
61-
* [Score-Based Generative Modeling (Diffusion Model)](vision/diffusion_mnist)
62-
* [VGG 16/19 on CIFAR10](vision/vgg_cifar10)
63-
* Text
64-
* [CharRNN](text/char-rnn)
65-
* [Character-level language detection](text/lang-detection)
66-
* [Seq2Seq phoneme detection on CMUDict](text/phonemes)
67-
* [Recursive net on IMDB sentiment treebank](text/treebank)
68-
* Other & contributed models
69-
* [Differential Equations](https://diffeqflux.sciml.ai/dev)
70-
* [BitString Parity Challenge](other/bitstring-parity)
71-
* [MLP on housing data](other/housing/housing.jl) (low level API)
72-
* [FizzBuzz](other/fizzbuzz/fizzbuzz.jl)
73-
* [Meta-Learning](contrib/meta-learning/MetaLearning.jl)
74-
* [Logistic Regression Iris](other/iris/iris.jl)
75-
* [Speech recognition](contrib/audio/speech-blstm)
76-
* Tutorials
77-
* [A 60 Minute Blitz](tutorials/60-minute-blitz/60-minute-blitz.jl)
78-
* [DataLoader example with image data](tutorials/dataloader)
79-
* [Transfer Learning](tutorials/transfer_learning/transfer_learning.jl)
66+
**Vision**
67+
* MNIST
68+
* [Simple multi-layer perceptron](vision/mlp_mnist) ☀️ v0.13
69+
* [Simple ConvNet (LeNet)](vision/conv_mnist) ☀️ v0.13
70+
* [Variational Auto-Encoder](vision/vae_mnist) 🌤 v0.12
71+
* [Deep Convolutional Generative Adversarial Networks](vision/dcgan_mnist) ☀️ v0.13
72+
* [Conditional Deep Convolutional Generative Adversarial Networks](vision/cdcgan_mnist) ☀️ v0.13
73+
* [Score-Based Generative Modeling (Diffusion Model)](vision/diffusion_mnist) ☀️ v0.13
74+
* [Spatial Transformer](vision/spatial_transformer) ☀️ v0.13
75+
* CIFAR10
76+
* [VGG 16/19](vision/vgg_cifar10) ☀️ v0.13
77+
* [ConvMixer "Patches are all you need?"](vision/convmixer_cifar10/) ☀️ v0.13
78+
79+
**Text**
80+
* [CharRNN](text/char-rnn) ⛅️ v0.11
81+
* [Character-level language detection](text/lang-detection) ⛅️ v0.11
82+
* [Seq2Seq phoneme detection on CMUDict](text/phonemes) ⛅️ v0.11
83+
* [Recursive net on IMDB sentiment treebank](text/treebank) ⛅️ v0.11
84+
85+
**Other** & contributed models
86+
* [Logistic Regression Iris](other/iris/iris.jl) ☀️ v0.13
87+
* [Autoregressive Model](other/autoregressive-process/) ☀️ v0.13
88+
* [BitString Parity Challenge](other/bitstring-parity) ⛅️ v0.11
89+
* [MLP on housing data](other/housing/) (low level API) ⛅️ v0.11
90+
* [FizzBuzz](other/fizzbuzz/fizzbuzz.jl) ⛅️ v0.11
91+
* [Meta-Learning](contrib/meta-learning/MetaLearning.jl) ❄️ v0.7
92+
* [Speech recognition](contrib/audio/speech-blstm) ❄️ v0.6
93+
94+
**Tutorials**
95+
* [A 60 Minute Blitz](tutorials/60-minute-blitz/60-minute-blitz.jl) ⛅️ v0.11
96+
* [DataLoader example with image data](tutorials/dataloader) ⛅️ v0.11
97+
* [Transfer Learning](tutorials/transfer_learning/transfer_learning.jl) ⛅️ v0.11
98+

0 commit comments

Comments
 (0)