vdaas / vald

Vald. A Highly Scalable Distributed Vector Search Engine
https://vald.vdaas.org
Apache License 2.0
1.51k stars 75 forks source link

Add efficient search logic for large top-k users #2491

Closed kpango closed 4 months ago

kpango commented 4 months ago

Description

In the current Vald search architecture, each agent receives and processes queries broadcasted by the load balancer (LB) exactly as they are received. For example, with a configuration of Top-K=10 and Agent Replica=5, the LB reduces the results from 50 (produced collectively by the agents) down to the top 10.

However, when the Top-K value is extremely high, such as 100,000, it is inefficient to search across all K multiplied by the number of replicas. To address this, we have developed a feature that adjusts the number of requests forwarded to the agents based on a configurable ratio.

This pull request introduces a 'Ratio' setting within the Search Config. This setting allows for the dynamic adjustment of the proportion of the Top-K results that are propagated to the agents. If the 'Ratio' is not configured or set to 1, the system will maintain the current behavior of forwarding 100% of the Top-K results. If set to 0.5, only 50% of the Top-K will be searched. Conversely, setting the Ratio to 1.2 will result in 120% of the Top-K being searched, effectively increasing the breadth of the search under certain conditions.

Related Issue

Versions

Checklist

Special notes for your reviewer

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!WARNING]

Rate Limit Exceeded

@kpango has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 1 seconds before requesting another review.

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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 91475b4aa745984039cd43211adc2f13ef5786b0 and 6dee89987d994a1e67fbe209194db9ac9233d8c0.

Walkthrough

The repository has undergone extensive updates, primarily focused on enhancing security and reliability in file downloads across various Makefiles, with the addition of -fsSL flags to curl commands. This update also includes Kubernetes version bumps in GitHub templates and the introduction of new Dockerfiles and Rust components. Changes in GRPC configurations and dependency updates in Go modules are also notable, alongside modifications to improve logging and error handling in script executions.

Changes

Files Change Summary
.github/ISSUE_TEMPLATE/*, .github/PULL_REQUEST_TEMPLATE.md Updated Kubernetes version from v1.29.3 to v1.30.0.
Makefile, Makefile.d/* Added -fsSL options to curl commands for enhanced security and reliability. Introduced changes in version file logging and handling in scripts.
docs/tutorial/*, docs/user-guides/deployment.md Updated curl commands in Helm installation instructions to use -fsSL.
example/client/go.mod.default, hack/go.mod.default Updated Go and Kubernetes related dependencies to newer versions.
internal/config/*, internal/net/grpc/* Adjustments in GRPC configuration methods and test cases, including error handling and ticker management for health checks.
dockers/*, rust/* Added new Dockerfiles and initiated Rust components with necessary configurations and source files.
Various .md and .mk files General enhancements in logging, error display, and download command options across documentation and Makefiles.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vdaas-ci commented 4 months ago

[CHATOPS:HELP] ChatOps commands.

vdaas-ci commented 4 months ago

[WARNING:INTCFG] Changes in interal/config may require you to change Helm charts. Please check.

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 14.81994% with 615 lines in your changes are missing coverage. Please review.

Project coverage is 18.91%. Comparing base (9e091b1) to head (6dee899). Report is 7 commits behind head on main.

Files Patch % Lines
apis/grpc/v1/payload/payload.pb.json.go 6.97% 320 Missing :warning:
pkg/gateway/lb/handler/grpc/aggregation.go 0.00% 71 Missing :warning:
pkg/gateway/lb/handler/grpc/handler.go 0.00% 57 Missing :warning:
...is/grpc/v1/rpc/errdetails/error_details.pb.json.go 0.00% 56 Missing :warning:
internal/net/grpc/option.go 0.00% 41 Missing :warning:
apis/grpc/v1/payload/payload_vtproto.pb.go 0.00% 40 Missing :warning:
internal/net/grpc/client.go 0.00% 26 Missing :warning:
apis/grpc/v1/payload/payload.pb.go 0.00% 4 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2491 +/- ## ========================================== - Coverage 18.94% 18.91% -0.03% ========================================== Files 563 565 +2 Lines 64707 65223 +516 ========================================== + Hits 12256 12338 +82 - Misses 51656 52087 +431 - Partials 795 798 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

cloudflare-pages[bot] commented 4 months ago

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6dee899
Status: ✅  Deploy successful!
Preview URL: https://e0d86aef.vald.pages.dev
Branch Preview URL: https://feature-gateway-lb-add-effic.vald.pages.dev

View logs

kpango commented 4 months ago

@coderabbitai review

coderabbitai[bot] commented 4 months ago
Actions Performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
github-actions[bot] commented 4 months ago

[FOSSA] The scan result will be available at https://app.fossa.com/projects/custom%2B21465%2Fvald/refs/branch/feature%2Fgateway-lb%2Fadd-efficient-search-for-large-topk-query/1eccb8cbfd8bc715396c2b0370b13df233d445fb

vdaas-ci commented 4 months ago

Profile Report

typevald-agent-ngtvald-lb-gatewayvald-discoverervald-manager-index
cpu
heap

other images

kpango commented 4 months ago

@coderabbitai review

coderabbitai[bot] commented 4 months ago
Actions Performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
kpango commented 4 months ago

@coderabbitai review

coderabbitai[bot] commented 4 months ago
Actions Performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
vdaas-ci commented 4 months ago

Profile Report

typevald-agent-ngtvald-lb-gatewayvald-discoverervald-manager-index
cpu
heap

other images