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

documentation update #2422

Merged
merged 6 commits into from
Apr 17, 2024
Merged

documentation update #2422

merged 6 commits into from
Apr 17, 2024

Conversation

CarloLucibello
Copy link
Member

@CarloLucibello CarloLucibello commented Apr 7, 2024

I factored out here the part of #2412 involving only the documentation. Most of it is removing any reference to Flux.params and to the implicit differentiation style.

I also reorganized a bit files and folders, updated and reintroduced the old mlp tutorial, and update to the last Documenter version.

Needs FluxML/Optimisers.jl#174 to be merged and tagged.

Copy link

codecov bot commented Apr 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.13%. Comparing base (caa1cee) to head (15727cb).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2422   +/-   ##
=======================================
  Coverage   46.13%   46.13%           
=======================================
  Files          32       32           
  Lines        1877     1877           
=======================================
  Hits          866      866           
  Misses       1011     1011           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Apr 9, 2024

Once the build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Flux.jl/previews/PR2422/ in ~20 minutes

@mcabbott
Copy link
Member

mcabbott commented Apr 9, 2024

I'm against restoring the tutorial in this form. All this text is not very helpful. You can't easily play with pieces of this to see how they work.

The model zoo has a re-write, and it could plausibly be tidied up to live here too:

https://github.com/FluxML/model-zoo/blob/master/vision/mlp_mnist/mlp_mnist.jl

I agree it would be nice if something like this were easier to find. The problem we never solved with moving model zoo models in here was that they aren't tested and tend to rot, so this means two things to check manually.

@CarloLucibello
Copy link
Member Author

I put away the MLP tutorial (along with an updated 60min-blitz) and created a "Model Zoo" page instead in the tutorial hopefully helping a bit the discoverability of the model zoo examples.

@CarloLucibello
Copy link
Member Author

merge?

@mcabbott
Copy link
Member

Would like to look over the rest but not today, sorry

@CarloLucibello CarloLucibello merged commit d7a3bb5 into master Apr 17, 2024
9 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants