Skip to content

refactor: align numerical naming and documentation - #180

Merged
gouyt13 merged 1 commit into
mainfrom
refactor/numerical-naming-docs
Oct 29, 2026
Merged

gouyt13 merged 1 commit into
mainfrom
refactor/numerical-naming-docs

Conversation

@gouyt13

@gouyt13 gouyt13 commented Oct 29, 2026

Copy link
Copy Markdown
Member

Summary

Align internal names across Core, FastScan, clustering and SIMD, and document the shared conventions. Clarify query wrappers, scalar/batch scoring outputs, clustering counts/workers and FHT arguments; preserve public APIs, mathematical operations, persisted layouts, G_* fields and niter_.

Update numerical examples and correct three documentation inconsistencies: HNSW code sizes use padded_dim, the IVF layout uses a neutral cluster-metadata label, and IVF add help explains potentially approximate initializer routing. Stub and runtime help use the same wording.

Testing

  • Reviewed identifier-token comparison passed for all 27 renamed C++ files.
  • Portable Clang 23 CTest: 406 passed, 1 skipped; the placement test passed separately with OpenMP binding enabled.
  • Current-source wheel built and installed into an isolated target; all 15 editor/documentation tests passed, with imported extension paths and updated runtime help verified.
  • MkDocs strict build, generated-page checks, and all five quantizer example builds/runs passed.
  • Repository C++ formatting, Python lint/format, full configured clang-tidy and git diff --check passed.

ARM code was source/token checked; native ARM, Windows and macOS execution was not rerun. No performance change is claimed.

@github-actions github-actions Bot added the release:maintenance Release category managed from the PR title label Oct 29, 2026
@gouyt13
gouyt13 merged commit f47d4ac into main Oct 29, 2026
49 checks passed
@gouyt13
gouyt13 deleted the refactor/numerical-naming-docs branch October 29, 2026 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release:maintenance Release category managed from the PR title

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant