Docs rehaul for v0.8 #242
Merged
Docs rehaul for v0.8 #242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
|
Once the documentation build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Metalhead.jl/previews/PR242/ |
Signed-off-by: Abhirath Anand <74202102+theabhirath@users.noreply.github.com>
theabhirath
force-pushed
the
a2/docs-rehaul-1
branch
from
45952bd
to
d8cbdd1
Compare
Signed-off-by: Abhirath Anand <74202102+theabhirath@users.noreply.github.com>
theabhirath
force-pushed
the
a2/docs-rehaul-1
branch
from
436c958
to
ae8a8eb
Compare
Signed-off-by: Abhirath Anand <74202102+theabhirath@users.noreply.github.com>
|
We should disallow loading densenet pretrained weights and mark the weight as not available in the docs. |
Signed-off-by: Abhirath Anand <74202102+theabhirath@users.noreply.github.com>
darsnack
requested changes
Jun 5, 2023
There was a problem hiding this comment.
Looks pretty good to me!
Other details that I cannot directly comment on:
- The
DenseNetdocstring has the "Arguments" bullet list indented which is being interpreted as a markdown code block - The
UNetdocstring has the same issue asDenseNet - The
MLPMixer+ResMLPdocstring should list the config types as symbols (i.e.:small,:base, etc.)
|
Also need to remove |
Also commented out DenseNet pretrained tests for now Co-Authored-By: Kyle Daruwalla <daruwal@cshl.edu>
|
Done, done, done and done! Hopefully tests pass, and then we can finally release this 😁. I have a ready blog post for the Flux website detailing the major improvements as well, so I can land that PR after we tag 😊. |
|
Can I go ahead and tag v0.8 now? |
|
Yeah go for it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the last PR for v0.8, and introduces just about enough documentation to ensure that users can find their way around the major parts of the repo. A large swathe of the builders remain undocumented, but that will take time and effort and I would rather get v0.8 out first and then worry about that.
cc @darsnack for suggestions in case something important has been missed.