add faiss in values.yaml & valdrelease.yaml

[datelier]

Description

SSIA

Related Issue

Versions

• Go Version: 1.22.3
• Rust Version: 1.77.2
• Docker Version: 20.10.8
• Kubernetes Version: v1.30.0
• NGT Version: 2.2.1

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

• New Features

  • Added extensive Faiss configuration options in the Helm charts (valdrelease.yaml and values.yaml), allowing for detailed control over indexing, dimensions, metric types, and performance settings.

• Documentation

  • Updated tutorial documentation to reflect the new Faiss configuration settings and adjusted terminology (metric_type from "inner_product" to "innerproduct").

• Bug Fixes

  • Corrected metric_type value in Faiss configuration to ensure compatibility and consistency ("inner_product" to "innerproduct").

[coderabbitai]

Walkthrough

Walkthrough

The recent changes primarily introduce new configuration settings for Faiss in the Vald project. Configurations for Faiss have been added to various YAML files, allowing for more customization of Faiss-related operations such as auto-indexing, metric types, and timeout settings. Adjustments to a specific property related to the metric type improvement aim to ensure consistency across different configuration files.

Changes

Files	Change Summary
charts/vald-helm-operator/crds/valdrelease.yaml k8s/operator/helm/crds/valdrelease.yaml	Added a new faiss section under spec with properties like auto_index_check_duration, dimension, index_path, metric_type, etc.
cmd/agent/core/faiss/sample.yaml docs/tutorial/get-started-with-faiss-agent.md	Updated metric_type value from "inner_product" to "innerproduct" in Faiss configuration.
charts/vald/values.yaml	Introduced new configuration settings for faiss under agent, including various timeouts, pod name, namespace, buffer pool sizes, and concurrency for vqueue and kvsdb.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

docs/tutorial/get-started-with-faiss-agent.md (2)

Line range hint 89-89: Add an apostrophe to indicate possession.

- you can check the Vald's pods status following command.
+ you can check Vald's pods' status following command.

---

Line range hint 261-261: Consider a shorter alternative to "completed with success."

- Loading from Fashion-MNIST dataset and set id for each vector that is loaded. This step will return the training dataset, test dataset, and ids list of ids when loading is completed with success.
+ Loading from Fashion-MNIST dataset and set id for each vector that is loaded. This step will return the training dataset, test dataset, and ids list of ids when loading is successfully completed.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e6f7db4 and f33a228.

Files selected for processing (4)

• charts/vald-helm-operator/crds/valdrelease.yaml (1 hunks)
• cmd/agent/core/faiss/sample.yaml (1 hunks)
• docs/tutorial/get-started-with-faiss-agent.md (1 hunks)
• k8s/operator/helm/crds/valdrelease.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• cmd/agent/core/faiss/sample.yaml

Additional context used

LanguageTool

docs/tutorial/get-started-with-faiss-agent.md

[uncategorized] ~89-~89: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...eploying Vald, you can check the Vald's pods status following command. ```bash ...

---

[style] ~261-~261: ‘with success’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_SUCCESS)
Context: ...s list of ids when loading is completed with success.

example ...

Additional comments not posted (4)

docs/tutorial/get-started-with-faiss-agent.md (1)

63-63: Update the metric type to maintain consistency with other configuration files.

This change aligns the metric_type value across different configuration and documentation files, ensuring consistency and preventing potential configuration errors.

charts/vald-helm-operator/crds/valdrelease.yaml (2)

352-356: The metric_type property now includes an enumeration with values innerproduct and l2. This standardization is beneficial for consistency and validation.

Ensure that all application code and documentation that references this property are updated to reflect these new enum values.

Verification successful

---

The verification process has revealed that there are references to metric_type using the new enum value innerproduct in both the application code and documentation.

• ./cmd/agent/core/faiss/sample.yaml: metric_type: "innerproduct"
• ./docs/tutorial/get-started-with-faiss-agent.md: metric_type: "innerproduct"

These references align with the new enum values specified in valdrelease.yaml.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that all references to `metric_type` in the application code and documentation use the new enum values.

# Test: Search for outdated `metric_type` values in the code and documentation.
rg --type yaml --type md 'metric_type: "inner_product"' .

Length of output: 59

---

---

Script:

#!/bin/bash
# Description: Verify that all references to `metric_type` in the application code and documentation use the new enum values `innerproduct` and `l2`.

# Search for all references to `metric_type` in YAML files and ensure they use the correct enum values.
rg --type yaml 'metric_type:' .

# Search for all references to `metric_type` in Markdown files and ensure they use the correct enum values.
rg --type md 'metric_type:' .

Length of output: 375

---

317-369: The addition of the faiss configuration section is well-structured and aligns with Kubernetes CRD standards.

However, ensure that all new properties are well-documented and defaults are set if necessary, especially for critical configurations like auto_index_check_duration, dimension, and metric_type.

k8s/operator/helm/crds/valdrelease.yaml (1)

352-357: The metric_type property correctly uses an enum to restrict values. Ensure these values are consistent across all configuration and code references in the project.

Verification successful

---

The metric_type values are consistent across the codebase, with innerproduct being explicitly mentioned and no conflicting values found.

• k8s/operator/helm/crds/valdrelease.yaml: Defines metric_type with an enum.
• internal/config/faiss.go: Contains a MetricType field but does not specify values.
• charts/vald-helm-operator/crds/valdrelease.yaml: Similar to the first file.
• cmd/agent/core/faiss/sample.yaml: Uses innerproduct.

No inconsistencies detected.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify consistency of `metric_type` values across the codebase.

# Test: Search for `metric_type` usage. Expect: Only `innerproduct` and `l2`.
rg --type yml --type yaml --type py --type go "metric_type"

Length of output: 87

---

---

Script:

#!/bin/bash
# Description: Verify consistency of `metric_type` values across the codebase.

# Test: Search for `metric_type` usage. Expect: Only `innerproduct` and `l2`.
rg --type yaml --type py --type go "metric_type"

Length of output: 386

---

---

Script:

#!/bin/bash
# Description: Extract lines containing `metric_type` to verify values.

# Extract lines from the identified files.
rg --type yaml --type py --type go "metric_type" -A 2

Length of output: 944

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 18.90%. Comparing base (e6f7db4) to head (f4d702a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2514      +/-   ##
==========================================
- Coverage   18.92%   18.90%   -0.02%     
==========================================
  Files         565      565              
  Lines       65221    65221              
==========================================
- Hits        12342    12332      -10     
- Misses      52080    52091      +11     
+ Partials      799      798       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	f4d702a
Status:	✅  Deploy successful!
Preview URL:	https://1ebee382.vald.pages.dev
Branch Preview URL:	https://feature-crd-faiss.vald.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (2)

charts/vald/values.yaml (2)

2181-2181: Consider using a more descriptive default value for pod_name if applicable.

---

2184-2184: Consider using a more descriptive default value for namespace if applicable.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f33a228 and a50ceb6.

Files selected for processing (3)

• charts/vald-helm-operator/crds/valdrelease.yaml (1 hunks)
• charts/vald/values.yaml (1 hunks)
• k8s/operator/helm/crds/valdrelease.yaml (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• charts/vald-helm-operator/crds/valdrelease.yaml
• k8s/operator/helm/crds/valdrelease.yaml

Additional comments not posted (6)

charts/vald/values.yaml (6)

2177-2177: Ensure the schema annotations are correctly formatted and placed.

---

2181-2181: Configuration values and descriptions are well-documented with appropriate schema annotations.

Also applies to: 2184-2184, 2187-2187, 2190-2190, 2193-2193, 2196-2196, 2199-2199, 2202-2202, 2205-2205, 2209-2209, 2212-2212, 2215-2215, 2218-2218, 2221-2221, 2224-2224, 2227-2227, 2230-2230, 2234-2234, 2237-2237, 2242-2242, 2245-2245, 2250-2250

---

2209-2209: Ensure that the metric type l2 is compatible with all intended use cases of FAISS in Vald.

Verification successful

---

The search results indicate that the metric_type is indeed a configurable parameter in the FAISS configuration (internal/config/faiss.go). Additionally, the FAISS implementation supports various metric types, including L2, as seen in internal/core/algorithm/faiss/faiss.go.

Given this information, it is reasonable to conclude that l2 is a valid and supported metric type for FAISS in Vald.

• internal/config/faiss.go: MetricType string "info:\"metric_type\" json:\"metric_type,omitempty\" yaml:\"metric_type\""
• internal/core/algorithm/faiss/faiss.go: f.st = C.faiss_create_index(f.dimension, f.nlist, f.m, f.nbitsPerIdx, C.int(L2))

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify compatibility of `l2` metric type with FAISS configurations.

# Test: Search for metric type usage in FAISS-related code. Expect: Compatibility confirmations or issues.
rg --type go 'metric_type' cmd/agent/core/faiss/

Length of output: 48

---

---

Script:

#!/bin/bash
# Description: Verify compatibility of `l2` metric type with FAISS configurations.

# Search for FAISS configurations in the codebase
rg --type go 'faiss' 

# Search for metric_type usage in the entire codebase to gather more context
rg --type go 'metric_type'

Length of output: 24702

---

2247-2250: The kvsdb configuration specifies a concurrency of 6. Confirm that this setting is optimized based on the expected load and hardware capabilities.

---

2187-2187: The index_path is empty. Ensure this is intentional or provide a sensible default.

---

2231-2231: The load_index_timeout_factor is set to 1ms. Confirm that this unit is intended and practical for the system's performance requirements.

[hlts2]

LGTM!!

[kpango]

LGTM

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

docs/tutorial/get-started-with-faiss-agent.md (2)

Line range hint 261-261: Consider rephrasing "completed with success" to a less wordy alternative like "successfully completed" to enhance readability.

- completed with success
+ successfully completed

---

Line range hint 149-149: Correct the grammatical error in the phrase "requesting to Vald cluster" to "requesting the Vald cluster".

- for requesting to Vald cluster
+ for requesting the Vald cluster

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a50ceb6 and 80e9c30.

Files selected for processing (5)

• charts/vald-helm-operator/crds/valdrelease.yaml (1 hunks)
• charts/vald/values.yaml (1 hunks)
• cmd/agent/core/faiss/sample.yaml (1 hunks)
• docs/tutorial/get-started-with-faiss-agent.md (1 hunks)
• k8s/operator/helm/crds/valdrelease.yaml (1 hunks)

Files skipped from review as they are similar to previous changes (4)

• charts/vald-helm-operator/crds/valdrelease.yaml
• charts/vald/values.yaml
• cmd/agent/core/faiss/sample.yaml
• k8s/operator/helm/crds/valdrelease.yaml

Additional context used

LanguageTool

docs/tutorial/get-started-with-faiss-agent.md

[uncategorized] ~149-~149: “to” seems less likely than “the”. (AI_HYDRA_LEO_CP_TO_THE)
Context: ...l Vald client libraries, for requesting to Vald cluster. Vald provides multiple la...

---

[style] ~261-~261: ‘with success’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_SUCCESS)
Context: ...s list of ids when loading is completed with success.

example ...

Additional comments not posted (1)

docs/tutorial/get-started-with-faiss-agent.md (1)

63-63: Ensure the metric type "innerproduct" is consistently used across all documentation and configuration files.

Verification successful

---

The verification confirms that the metric type "innerproduct" is consistently used across the project documentation and configuration files.

• docs/tutorial/get-started-with-faiss-agent.md
• cmd/agent/core/faiss/sample.yaml

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all occurrences of the metric type "innerproduct" across the project.

# Test: Search for inconsistent metric type usage. Expect: Only occurrences of "innerproduct".
rg --type yaml --type md $'metric_type: "inner_product"'

Length of output: 57

---

---

Script:

#!/bin/bash
# Description: Verify all occurrences of the metric type "innerproduct" across the project.

# Test: Search for consistent metric type usage. Expect: Occurrences of "innerproduct".
rg --type yaml --type md $'metric_type: "innerproduct"'

Length of output: 200

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

docs/tutorial/get-started-with-faiss-agent.md (1)

Line range hint 89-89: Consider rephrasing for conciseness.

The phrase "when loading is completed with success" might be wordy. Consider rephrasing to "when loading succeeds" to enhance clarity and conciseness.

- when loading is completed with success.
+ when loading succeeds.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 80e9c30 and f4d702a.

Files selected for processing (5)

• charts/vald-helm-operator/crds/valdrelease.yaml (1 hunks)
• charts/vald/values.yaml (1 hunks)
• cmd/agent/core/faiss/sample.yaml (1 hunks)
• docs/tutorial/get-started-with-faiss-agent.md (1 hunks)
• k8s/operator/helm/crds/valdrelease.yaml (1 hunks)

Files skipped from review as they are similar to previous changes (4)

• charts/vald-helm-operator/crds/valdrelease.yaml
• charts/vald/values.yaml
• cmd/agent/core/faiss/sample.yaml
• k8s/operator/helm/crds/valdrelease.yaml

Additional context used

LanguageTool

docs/tutorial/get-started-with-faiss-agent.md

[uncategorized] ~89-~89: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...eploying Vald, you can check the Vald's pods status following command. ```bash ...

---

[style] ~261-~261: ‘with success’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_SUCCESS)
Context: ...s list of ids when loading is completed with success.

example ...

Additional comments not posted (1)

docs/tutorial/get-started-with-faiss-agent.md (1)

63-63: Consider adding "innerproduct" to a custom dictionary to avoid spelling errors.

The term "innerproduct" might be flagged as a spelling error by some tools. To prevent this, consider adding it to a custom dictionary if it's a domain-specific term. This approach will help maintain the consistency and accuracy of documentation.

[hlts2]

LGTM!