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

Fix a few crossrefs + update Zygote's page #2064

Merged
merged 3 commits into from
Oct 18, 2022
Merged

Conversation

Saransh-cpp
Copy link
Member

  • Anything beyond an h2 (##) does not appear in the sidebar
  • Fixed a few API references for Zygote
  • Fixed a few internal cross-references

PR Checklist

  • Tests are added
  • Entry in NEWS.md
  • Documentation, if applicable

@Saransh-cpp Saransh-cpp marked this pull request as draft September 22, 2022 17:31
@Saransh-cpp Saransh-cpp marked this pull request as ready for review September 22, 2022 17:56
@@ -21,7 +21,7 @@ loss(ŷ, y, agg=x->mean(w .* x)) # weighted mean
loss(ŷ, y, agg=identity) # no aggregation.
```

### Function listing
## Function listing
Copy link
Member

Choose a reason for hiding this comment

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

My thinking with H3 was that it's nice to separate the listing from the introductory blurb, but it doesn't really need an entry on the side-bar if there's just one heading.

Screenshot 2022-09-22 at 18 32 02

Zygote.diaghessian
Zygote.withjacobian
Zygote.withgradient
Copy link
Member

Choose a reason for hiding this comment

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

I think my vote would be to include withgradient alongside gradient. Then this section would just be about second derivatives, so it can have a heading more useful than "utilities".

However, these are very limited, Zygote over Zygote never works that well. So perhaps it needs disclaimers here.

And perhaps it wants explanation of how to use hessian with destructure, since oherwise it can't act on a Flux model parameters?

Copy link
Member

Choose a reason for hiding this comment

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

(Such a Hessian example is now in destructure's own page)

Zygote.diaghessian
Zygote.withjacobian
Zygote.withgradient
Copy link
Member

Choose a reason for hiding this comment

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

(Such a Hessian example is now in destructure's own page)

@Saransh-cpp
Copy link
Member Author

Yes, went through the page and decided to remove this section!

@mcabbott mcabbott merged commit 15c8590 into FluxML:master Oct 18, 2022
@Saransh-cpp Saransh-cpp deleted the refs branch October 18, 2022 17:13
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