Repository navigation
docs: explain gradients with respect to operator parameters - #259
Closed
AHMETHAKANBEZIR1 wants to merge 1 commit into
Closed
AHMETHAKANBEZIR1 wants to merge 1 commit into
AHMETHAKANBEZIR1 wants to merge 1 commit into
Conversation
Co-authored-by: OpenAI Codex <noreply@openai.com>
Collaborator
|
This is pretty nice, thanks! I am generally happy to accept purely AI generated PR's for code, but for documentation I would appreciate a human review before passing it over. The example is good and fairly well explained but the introduction is a bit too LLM-y. Can you give it a human pass over before I review, thanks! |
This file contains hidden or 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
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.
Gradients with respect to a composite or scaled linear operator contain derivatives of its PyTree array leaves. Calling
.as_matrix()on that returned PyTree can misleadingly interpret those derivatives as another operator, rather than derivatives with respect to dense matrix entries.Add an FAQ explanation and a scaled-identity example: the scale derivative is 3, while differentiating the trace with respect to a 3-by-3 dense matrix gives the identity. Explain that the same distinction applies to composite operators and
equinox.filter_grad.Closes #144, where the maintainer invited a documentation PR. Only
docs/faq.mdchanges; no runtime behavior changes.Validation (Windows CPU, Python 3.12.14, JAX 0.11.2):
equinox.filter_gradas well.mkdocs build --strictpassed without warnings; checked the generated FAQ heading and code blocks.git diff --checkpassed. Python-only hooks were skipped for this Markdown-only change.The runtime suite was not rerun for this documentation-only change. Linux and GPU checks were not run locally.
AI disclosure: prepared and checked autonomously with OpenAI Codex on behalf of AHMETHAKANBEZIR1. No independent human review is claimed.