docs: ICNN/KeyNet docstring fixes (architecture, math, citation)#703
Merged
Conversation
Follow-up to #702. The ICNN docstring "Architecture" block still showed the activation applied at every layer and omitted bias terms entirely: - show the final layer is linear (no activation, per #702) and note that convexity is still preserved; - include the optional per-layer bias (gated by `use_bias`), and clarify that the W_x input-injection terms are always bias-free. Docstring-only change; no behavior change. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
- Give KeyNet an `Architecture::` block in the same style as ICNN, showing the linear final layer and optional bias. - Unify formula rendering across both docstrings: inline expressions (the function signature, the inner-product potential, the residual output) now use `:math:` LaTeX consistently instead of a mix of plain text and inline code. Docstrings are now raw strings so LaTeX backslashes are literal. - Add the KeyNet reference (Olausson et al., 2026, "Amortizing Maximum Inner Product Search with Learned Support Functions") to references.bib and cite it from the KeyNet docstring. Docstring/bib-only change; no behavior change. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
marcocuturi
changed the title
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
1 participant
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.
What
Follow-up to #702 (merged). Documentation-only cleanup of
ICNN/KeyNetinsrc/ott/neural/networks/icnn.py.Changes (no behavior change)
ICNN
Architectureblock now shows the final layer as linear (no activation, per Remove activation on final layer of KeyNet and ICNN #702) and notes convexity is still preserved.b_i(gated byuse_bias); clarifies theW_xinput-injection terms are always bias-free (built withuse_bias=False), so there is no redundant double bias.KeyNet
Architectureblock in the same style as ICNN (linear final layer, optional bias, residual output).docs/references.bibasolausson:26.Formatting unification
:math:LaTeX instead of a mix of plain text and inline code. The affected docstrings are raw strings so LaTeX backslashes are literal.🤖 Generated with Claude Code