[Improvements] Manage segment cache and memory #1670
There are no files selected for viewing
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
Empty file.
Empty file.
Empty file.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import uuid | ||
| from typing import Any, Callable | ||
| from chromadb.types import Segment | ||
| from overrides import override | ||
| from typing import Dict, Optional | ||
| from abc import ABC, abstractmethod | ||
|
|
||
| class SegmentCache(ABC): | ||
| @abstractmethod | ||
| def get(self, key: uuid.UUID) -> Optional[Segment]: | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def pop(self, key: uuid.UUID) -> Optional[Segment]: | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def set(self, key: uuid.UUID, value: Segment) -> None: | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def reset(self) -> None: | ||
| pass | ||
|
|
||
|
|
||
| class BasicCache(SegmentCache): | ||
| def __init__(self): | ||
| self.cache:Dict[uuid.UUID, Segment] = {} | ||
|
|
||
| @override | ||
| def get(self, key: uuid.UUID) -> Optional[Segment]: | ||
| return self.cache.get(key) | ||
|
|
||
| @override | ||
| def pop(self, key: uuid.UUID) -> Optional[Segment]: | ||
| return self.cache.pop(key, None) | ||
|
|
||
| @override | ||
| def set(self, key: uuid.UUID, value: Segment) -> None: | ||
| self.cache[key] = value | ||
|
|
||
| @override | ||
| def reset(self) -> None: | ||
| self.cache = {} | ||
|
|
||
|
|
||
| class SegmentLRUCache(BasicCache): | ||
| """A simple LRU cache implementation that handles objects with dynamic sizes. | ||
| The size of each object is determined by a user-provided size function.""" | ||
|
|
||
| def __init__(self, capacity: int, size_func: Callable[[uuid.UUID], int], | ||
| callback: Optional[Callable[[uuid.UUID, Segment], Any]] = None): | ||
| self.capacity = capacity | ||
| self.size_func = size_func | ||
| self.cache: Dict[uuid.UUID, Segment] = {} | ||
| self.history = [] | ||
| self.callback = callback | ||
|
|
||
| def _upsert_key(self, key: uuid.UUID): | ||
| if key in self.history: | ||
| self.history.remove(key) | ||
| self.history.append(key) | ||
| else: | ||
| self.history.append(key) | ||
|
|
||
| @override | ||
| def get(self, key: uuid.UUID) -> Optional[Segment]: | ||
| self._upsert_key(key) | ||
| if key in self.cache: | ||
| return self.cache[key] | ||
| else: | ||
| return None | ||
|
|
||
| @override | ||
| def pop(self, key: uuid.UUID) -> Optional[Segment]: | ||
| if key in self.history: | ||
| self.history.remove(key) | ||
| return self.cache.pop(key, None) | ||
|
|
||
|
|
||
| @override | ||
| def set(self, key: uuid.UUID, value: Segment) -> None: | ||
| if key in self.cache: | ||
| return | ||
| item_size = self.size_func(key) | ||
| key_sizes = {key: self.size_func(key) for key in self.cache} | ||
| total_size = sum(key_sizes.values()) | ||
| index = 0 | ||
| # Evict items if capacity is exceeded | ||
| while total_size + item_size > self.capacity and len(self.history) > index: | ||
| key_delete = self.history[index] | ||
| if key_delete in self.cache: | ||
| self.callback(key_delete, self.cache[key_delete]) | ||
| del self.cache[key_delete] | ||
| total_size -= key_sizes[key_delete] | ||
| index += 1 | ||
|
|
||
| self.cache[key] = value | ||
| self._upsert_key(key) | ||
|
|
||
| @override | ||
| def reset(self): | ||
| self.cache = {} | ||
| self.history = [] |
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would update the documentation.