Skip to content

docs(vocab_bridge): cite default dim=512 alongside dim=2048 escape-hatch (#541) - #543

Merged
robotrocketscience merged 1 commit into
mainfrom
docs/issue-541-vocab-bridge-default-dim
May 10, 2026
Merged

docs(vocab_bridge): cite default dim=512 alongside dim=2048 escape-hatch (#541)#543
robotrocketscience merged 1 commit into
mainfrom
docs/issue-541-vocab-bridge-default-dim

Conversation

@robotrocketscience

@robotrocketscience robotrocketscience commented May 10, 2026

Copy link
Copy Markdown
Owner

Closes #541.

Updates the VocabBridge storage-cost docstring (src/aelfrice/vocab_bridge.py:113) to cite dim=512 (the post-#539 default via from aelfrice.hrr import DEFAULT_DIM) as the primary number, with dim=2048 shown as the escape-hatch path. Mirrors the format already used in hrr_index.py:107-110 from PR #539.

- N_surfaces * dim`` bytes; at ``N=10k, dim=2048`` that is ~160 MB.
+ N_surfaces * dim`` bytes; at ``N=10k`` and the default
+ ``dim=512`` that is ~40 MB (~160 MB at the ``dim=2048``
+ escape-hatch value).

8 * 10000 * 512 ≈ 40 MB; 8 * 10000 * 2048 ≈ 160 MB (unchanged).

Acceptance

  • vocab_bridge.py:113 docstring cites the new default with the escape-hatch number alongside, mirroring hrr_index.py:107-110 style.
  • Spot-check of file for other dim=2048 references that read as default-cited: only one (the cited line); other dim references either don't carry a numeric value or pull from DEFAULT_DIM directly.

Out of scope

References

Summary by Sourcery

Documentation:

  • Adjust VocabBridge docstring to cite dim=512 as the default dimension with dim=2048 documented as an escape-hatch option, including updated storage cost figures.

…tch (#541)

vocab_bridge.py:113 docstring still cited dim=2048 as the implied default
for the (N_surfaces, dim) storage estimate. After PR #539 flipped
DEFAULT_DIM 2048 -> 512, the same N=10k configuration is ~40 MB, not
~160 MB. Rewrite the line to mirror the hrr_index.py:107-110 pattern:
default first, escape-hatch in parentheses.
@coderabbitai

coderabbitai Bot commented May 10, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@robotrocketscience has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 43 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b0bd4ef6-9bdc-4384-92d3-2988d380c111

📥 Commits

Reviewing files that changed from the base of the PR and between 974f764 and 64f767a.

📒 Files selected for processing (1)
  • src/aelfrice/vocab_bridge.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/issue-541-vocab-bridge-default-dim

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai

sourcery-ai Bot commented May 10, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the VocabBridge storage-cost docstring to present dim=512 as the default dimension with dim=2048 as an escape-hatch value, aligning its wording with hrr_index.py’s documentation and leaving behavior unchanged.

File-Level Changes

Change Details Files
Reword the VocabBridge storage-cost docstring to reference dim=512 as the default dimension and dim=2048 as an escape-hatch, matching the style used in hrr_index.py.
  • Update the storage-cost sentence to compute the example size at N=10k using the default dim=512, yielding ~40 MB.
  • Retain and reposition the ~160 MB figure as the size at the dim=2048 escape-hatch value.
  • Clarify that dim=512 is the default dimension in the explanatory text.
src/aelfrice/vocab_bridge.py

Assessment against linked issues

Issue Objective Addressed Explanation
#541 Update vocab_bridge.py docstring at line ~113 so that it cites the new default dimensionality dim=512, with dim=2048 clearly described as the escape-hatch value, matching the style used in hrr_index.py after PR #539.
#541 Spot-check the rest of src/aelfrice/vocab_bridge.py for other references to dim=2048 that imply it is the default rather than an escape-hatch, and ensure no such stale references remain.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@robotrocketscience robotrocketscience added author-Planck PR coordination mutex attn:review Needs review (PR open, awaiting reviewer) labels May 10, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@robotrocketscience

Copy link
Copy Markdown
Owner Author

[claim:review:Faraday:2026-05-10T04:35:29Z]

@robotrocketscience
robotrocketscience merged commit 64f767a into main May 10, 2026
24 of 29 checks passed
@robotrocketscience
robotrocketscience deleted the docs/issue-541-vocab-bridge-default-dim branch May 10, 2026 04:36
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[release:review:Faraday:2026-05-10T04:36:37Z]

@robotrocketscience robotrocketscience mentioned this pull request May 10, 2026
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

attn:review Needs review (PR open, awaiting reviewer) author-Planck PR coordination mutex

Projects

None yet

Development

Successfully merging this pull request may close these issues.

vocab_bridge.py docstring stale after #538 default-dim flip — '~160 MB at N=10k, dim=2048' refers to escape-hatch path

1 participant