Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add new options #207

Merged
merged 3 commits into from
Mar 17, 2025
Merged

doc: add new options #207

merged 3 commits into from
Mar 17, 2025

Conversation

usamoi
Copy link
Contributor

@usamoi usamoi commented Mar 14, 2025

No description provided.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation and scripts to introduce new options for building and packaging VectorChord, as well as adds support for additional k-means configuration in the code. Key changes include:

  • Updated build and packaging instructions in README files (scripts/README.md, tools/dev.md, and README.md) to support new options.
  • Introduction of a new kmeans_iterations parameter in VchordrqInternalBuildOptions (src/index/types.rs) and its utilization in the build process (src/index/am/am_build.rs and crates/k_means/src/lib.rs).

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
scripts/README.md Updated instructions for docker builds and package creation.
tools/dev.md Revised development steps for cloning, building, packaging, and testing.
README.md Enhanced documentation with new options and examples for index builds.
src/index/types.rs Added kmeans_iterations field for internal K-means options.
crates/k_means/src/lib.rs Updated k_means calls to use pool.install wrappers for parallel execution.
src/index/am/am_build.rs Changed hardcoded iterations parameter to use the new kmeans_iterations value.

Co-authored-by: Copilot <[email protected]>
Copy link
Member

@VoVAllen VoVAllen left a comment

Choose a reason for hiding this comment

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

LGTM. We need to make a new minor release for the kmeans iteration option.

@usamoi usamoi merged commit f62d76e into tensorchord:main Mar 17, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants