Skip to content

Document getMemoryFootprint in README #90

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.

Sign up for GitHub

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

Merged
drametwally merged 1 commit into from
Oct 1, 2026
Merged

Document getMemoryFootprint in README #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ boolean update(long rowNum, TermsAndValues record, Map<String, String> metadata)
SearchResults getNearestNeighborRowNums(int k, TermsAndValues record, MetaFilter metadataFilter)
SearchResults getSimilarRowNums(float minSimilarity, TermsAndValues record, MetaFilter metadataFilter)
int size()
MemoryFootprint getMemoryFootprint()
void close()
```

Expand All @@ -173,6 +174,13 @@ lower `rowNum` breaking ties.
they are always in `[0.0, 1.0]`.
- An empty metadata filter matches every non-deleted row.

`getMemoryFootprint()` returns a `MemoryFootprint` with on-heap and native byte
estimates for the graduated indexes in this namespace. It excludes the active
cache and graduating caches, which are bounded by `maxCacheSize`. The call is
linear in index size, so sample it periodically rather than on every request.
See [INTEGRATION.md](INTEGRATION.md#memory-footprint) for what the estimate
includes and what it omits.

Call `close()` when you are done with a namespace. It releases any native memory
held by the dense matrix index.

Expand Down
Loading