⚡ Bolt: [performance improvement] Use np.einsum for squared norms - #168
⚡ Bolt: [performance improvement] Use np.einsum for squared norms#168stffns wants to merge 2 commits into
Conversation
Co-authored-by: stffns <70039235+stffns@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
|
Warning Review limit reached
Next review available in: 48 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughSquared row-norm and distance calculations in clustering, PQ, and IVFPQ paths now use ChangesSquared-norm calculations
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.jules/bolt.md:
- Line 4: Add a blank line immediately before and after the dated Markdown
heading “2024-05-19 - Einsum is faster than explicitly computing row-wise sums
of squared elements” in the documentation, preserving the heading text and
surrounding content.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: dbc4a3e3-2656-4472-9a76-d968b11c2872
📒 Files selected for processing (4)
.jules/bolt.mdsnapvec/_ivfpq.pysnapvec/_kmeans.pysnapvec/_pq.py
| ## 2024-05-18 - Fast row-wise Euclidean norm in pure NumPy | ||
| **Learning:** In performance-critical paths, computing the batch norm of a 2D array via `np.linalg.norm(arr, axis=1)` is relatively slow. Using `np.sqrt(np.einsum('ij,ij->i', arr, arr))` is significantly faster (~4x speedup on a laptop CPU for typical batch sizes). If `keepdims=True` behavior is needed, appending `[:, np.newaxis]` matches the original shape seamlessly. | ||
| **Action:** Always prefer `np.sqrt(np.einsum('ij,ij->i', arr, arr))` over `np.linalg.norm(arr, axis=1)` when computing row-wise vector norms in NumPy to eliminate dispatch overhead and improve execution speed. | ||
| ## 2024-05-19 - Einsum is faster than explicitly computing row-wise sums of squared elements |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Surround the heading with blank lines.
Markdownlint reports missing blank lines before and after this heading. Add both to keep the documentation lint-clean.
Proposed fix
**Action:** Use `np.einsum` for squared Euclidean norms as well, and if computing 3D row norms, use `np.einsum('ijk,ijk->ij', X, X)`.
+
## 2024-05-19 - Einsum is faster than explicitly computing row-wise sums of squared elements
+
**Learning:** Similarly, when calculating just the squared row-wise norms, computing `(X ** 2).sum(1)` is slower than `np.einsum('ij,ij->i', X, X)` because the former creates intermediate arrays (like `X ** 2`), leading to memory allocations and copy overheads.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 2024-05-19 - Einsum is faster than explicitly computing row-wise sums of squared elements | |
| **Action:** Use `np.einsum` for squared Euclidean norms as well, and if computing 3D row norms, use `np.einsum('ijk,ijk->ij', X, X)`. | |
| ## 2024-05-19 - Einsum is faster than explicitly computing row-wise sums of squared elements | |
| **Learning:** Similarly, when calculating just the squared row-wise norms, computing `(X ** 2).sum(1)` is slower than `np.einsum('ij,ij->i', X, X)` because the former creates intermediate arrays (like `X ** 2`), leading to memory allocations and copy overheads. |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 4-4: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 4-4: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.jules/bolt.md at line 4, Add a blank line immediately before and after the
dated Markdown heading “2024-05-19 - Einsum is faster than explicitly computing
row-wise sums of squared elements” in the documentation, preserving the heading
text and surrounding content.
Source: Linters/SAST tools
Co-authored-by: stffns <70039235+stffns@users.noreply.github.com>
1 participant
💡 What: Replaced explicit element-wise squaring and summation (e.g.,
(X ** 2).sum(axis)) withnp.einsum(e.g.,np.einsum('ij,ij->i', X, X)) for computing row-wise squared Euclidean norms insnapvec/_kmeans.py,snapvec/_ivfpq.py, andsnapvec/_pq.py.🎯 Why: Computing
(X ** 2)creates a large, full-sized intermediate array before summing it.np.einsumfuses the multiplication and addition, avoiding this allocation and the associated memory copy overhead, which significantly improves speed during encoding, searching, and k-means clustering.📊 Impact: Expected to reduce memory footprint and improve execution speed (measured between 1.5x to 3x faster on benchmarked data depending on dimensions) during vector quantization and distance calculations.
🔬 Measurement: Verified by running
tests/which pass completely, and microbenchmarks show the exact operations run significantly faster.PR created automatically by Jules for task 14059413185390577921 started by @stffns
Summary by CodeRabbit