Skip to content

[v1.38] HFresh GA docs#436

Open
g-despot wants to merge 2 commits into
v1-38/mainfrom
v1-38/hfresh
Open

[v1.38] HFresh GA docs#436
g-despot wants to merge 2 commits into
v1-38/mainfrom
v1-38/hfresh

Conversation

@g-despot
Copy link
Copy Markdown
Contributor

@g-despot g-despot commented Jun 1, 2026

Documents the HFresh vector index for its v1.38 GA and surfaces it as a low-memory alternative to HNSW.

  • Mark HFresh as generally available (status note updated to "Added in v1.36")
  • Expand the HFresh concept, config-ref, and starter-guide pages with how it works (in-memory compressed centroids, on-disk postings), when to use it, and a recall tuning tip
  • Correct the HFresh parameter table, including maxPostingSizeKB mutability
  • Cross-reference HFresh as a memory-efficient option wherever the docs discuss HNSW memory cost, quantization for memory savings, or index choice

🤖 Generated with Claude Code

Copy link
Copy Markdown

@orca-security-eu orca-security-eu Bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca

@g-despot g-despot changed the title Add HFresh GA docs [v1.38] HFresh GA docs Jun 1, 2026
@g-despot g-despot requested review from asdine and Copilot June 1, 2026 11:41
Copy link
Copy Markdown
Contributor

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

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.

Comment thread docs/weaviate/concepts/resources.md Outdated
Comment thread docs/weaviate/starter-guides/managing-resources/compression.mdx Outdated
Comment thread docs/weaviate/config-refs/indexing/vector-index.mdx
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.

2 participants