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 custom model example to docs. #1758

Merged
merged 3 commits into from
Jan 15, 2022
Merged

Conversation

Gregliest
Copy link
Contributor

This PR adds a simple custom model example to the docs. As discussed in Slack, this example would have helped me understand how all the pieces fit together. But, happy to edit/move/delete as desired.

cc @ToucheSir

PR Checklist

  • Tests are added
  • Entry in NEWS.md
  • Documentation, if applicable
  • API changes require approval from a committer (different from the author, if applicable)

@DhairyaLGandhi
Copy link
Member

We should link to other places in the docs that show similar patterns and help new user experiences. Like https://fluxml.ai/tutorials/2020/09/15/deep-learning-flux.html

@Gregliest
Copy link
Contributor Author

Alright, I addressed all your comments. Looks like doctests are failing in basics.md, do you want me to have a look at that as well?

ToucheSir
ToucheSir previously approved these changes Nov 22, 2021
Copy link
Member

@ToucheSir ToucheSir left a comment

Choose a reason for hiding this comment

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

Sorry about the delay. If you're still interested, I think fixing basics.md in a separate PR would be great (to my knowledge, it should be a simple matter of formatting). This is good to go though.

@logankilpatrick
Copy link
Member

Can we bors this @ToucheSir ?

@DhairyaLGandhi
Copy link
Member

I'm wondering if this makes sense as a tutorial in the model zoo. Showing not just the structure based model, but also one that doesn't involve any structure and is very functional. We already have a similar example in the vae model and the cppn etc, but I wonder if an even more basic one is warranted.

@logankilpatrick
Copy link
Member

I am personally in favor of a heavier docs page vs model zoo. Currently, it's too much effort to have to go through the model zoo and figure out that you want. Having these in the docs makes it just a bit easier to find

@ToucheSir
Copy link
Member

@logankilpatrick Bors is failing to integrate because of failures on the staging branch and possibly master, see discussion in #1797.

@ToucheSir
Copy link
Member

bors r+

@bors
Copy link
Contributor

bors bot commented Jan 15, 2022

Build succeeded:

@bors bors bot merged commit 91abecc into FluxML:master Jan 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants