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.

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 literature background to the models #340

Open
8 of 15 tasks
lilianabs opened this issue Mar 15, 2022 · 8 comments
Open
8 of 15 tasks

Add literature background to the models #340

lilianabs opened this issue Mar 15, 2022 · 8 comments
Labels
documentation words & links, not code

Comments

@lilianabs
Copy link
Contributor

lilianabs commented Mar 15, 2022

I'll start working on adding literature background to all of the existing models (ref #312). Then, we can move on to working on creating a standalone site to host all of the models as notebooks.

I plan to cover the following models:

  • Simple multi-layer perceptron
  • dataloader tutorial
  • Housing
  • Logistic Regression Iris
  • Simple ConvNet (LeNet)
  • Variational Auto-Encoder
  • Deep Convolutional Generative Adversarial Networks
  • Conditional Deep Convolutional Generative Adversarial Networks
  • VGG 16/19 on CIFAR10
  • CharRNN
  • Character-level language detection
  • Seq2Seq phoneme detection on CMUDict
  • Recursive net on IMDB sentiment treebank
  • BitString Parity Challenge
  • Speech recognition

@DhairyaLGandhi @logankilpatrick just tagging you to keep you in the loop :)

@darsnack
Copy link
Member

This is great!

Looking ahead to the website step, I think it would be better and simpler to just host a "model zoo" or "tutorials" section in the Flux docs themselves:

  • almost every manual on writing good documentation mentions these types of sections which Flux is severely lacking right now
  • added benefit of being verified with every PR to Flux allowing us to keep it up to date and free of the bit rot the model zoo historically suffers
  • having information accessible in a central location is easier for users

@lilianabs
Copy link
Contributor Author

Thank you @darsnack! Totally agree with your comments.

@CarloLucibello
Copy link
Member

I think it is good to add some comments to some of the basics examples, but I wouldn't want them to be too loaded either. Model-zoo examples are supposedly used for bootstrapping user projects, they aren't meant as tutorials (which we lack and should live in Flux.jl).

@lilianabs
Copy link
Contributor Author

We can use Literate to create a "clean" version of the examples.

@cossio
Copy link

cossio commented May 3, 2022

Regarding the Simple ConvNet (LeNet5) example, I noticed it is using relu activations and max-pooling. I think the original LeCun paper doesn't do this. It is also different from https://d2l.ai/chapter_convolutional-neural-networks/lenet.html, which is cited in the readme of this example.

Any reason for these discrepancies?

@lilianabs
Copy link
Contributor Author

@cossio I just wrote the text and took the code as it was on the repo. Perhaps somebody else can comment on these discrepancies?

@CarloLucibello
Copy link
Member

I think that's a modernized version of Lenet5 (relu had not been "invented" at the time) which I've found somewhere (don't remember where though). Maybe we can add a comment on that saying that the original model uses sigmoids?

@lilianabs
Copy link
Contributor Author

lilianabs commented May 6, 2022

Added a note to the model to specify this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation words & links, not code
Projects
None yet
Development

No branches or pull requests

5 participants