Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

WIP: add documentation memory #211

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nicolasgere
Copy link

@nicolasgere nicolasgere commented Jan 30, 2024

Add documentation about memory management, as well as an advanced section.

Copy link

vercel bot commented Jan 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jan 30, 2024 10:59pm

@nicolasgere nicolasgere changed the title add documentation memory WIP: add documentation memory Jan 30, 2024
{
type: 'link',
href: '/advanced',
label: '🛰 Advanced',
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it make sense to make the title a little more descriptive? Something like "Advanced Usage"?

---

## Memory management
There are situations where you might need to limit the memory usage of Chroma. By default, Chroma loads the entire queried collection into its in-memory cache. To address this, we have implemented a mechanism to set a memory limit, which Chroma endeavors to adhere to as closely as possible through various cache eviction strategies. Here are some important points to note:
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we also add a note in the list below that unloading happens reactively as the user queries new collections, old ones are unloaded.

Copy link
Contributor

@tazarov tazarov left a comment

Choose a reason for hiding this comment

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

A few minor nits, but looks good to me.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants