[v1.38] HFresh GA docs#436
Open
g-despot wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Secrets | View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Weaviate documentation to reflect the HFresh vector index being generally available in v1.38 and positions it as a low-memory, disk-backed alternative to HNSW for very large datasets.
Changes:
- Expands HFresh explanations and adds recall-tuning guidance (
searchProbe,rescoreLimit) in starter guides and index reference docs. - Cross-links HFresh from memory/quantization/index-choice sections to help readers discover it when optimizing RAM usage.
- Updates the HFresh feature note/status include to remove “Preview” language and present it as “Added in v1.36”.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/weaviate/starter-guides/managing-resources/indexing.mdx | Expands HFresh overview and adds a tuning tip for recall. |
| docs/weaviate/starter-guides/managing-resources/compression.mdx | Adds HFresh as an index-level alternative when RAM is the main constraint. |
| docs/weaviate/config-refs/indexing/vector-index.mdx | Updates HFresh parameter table (mutability/details) and adds HFresh tuning guidance. |
| docs/weaviate/concepts/vector-quantization.md | Cross-references HFresh as a disk-backed alternative to compression for memory limits. |
| docs/weaviate/concepts/resources.md | Adds HFresh as an option for very large, memory-constrained datasets. |
| docs/weaviate/concepts/indexing/vector-index.md | Expands HFresh “how it works” + tradeoffs and updates the index comparison table. |
| docs/weaviate/concepts/filtering.md | Notes that HFresh benefits from ACORN via its centroid HNSW routing. |
| docs/weaviate/concepts/cluster.md | Mentions HFresh can reduce the need to shard purely for RAM reasons. |
| docs/weaviate/best-practices/index.md | Adds HFresh as an alternative to quantization for lowering memory footprint. |
| _includes/feature-notes/hfresh_status.mdx | Updates the feature status note to indicate availability since v1.36. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the HFresh vector index for its v1.38 GA and surfaces it as a low-memory alternative to HNSW.
v1.36")maxPostingSizeKBmutability🤖 Generated with Claude Code