https://github.com/thiswillbeyourgithub/iterator_cacher
decorator to transparently cache each element of an iterable
https://github.com/thiswillbeyourgithub/iterator_cacher
Last synced: 7 months ago
JSON representation
decorator to transparently cache each element of an iterable
- Host: GitHub
- URL: https://github.com/thiswillbeyourgithub/iterator_cacher
- Owner: thiswillbeyourgithub
- License: gpl-3.0
- Created: 2024-06-14T13:00:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-26T10:06:54.000Z (over 1 year ago)
- Last Synced: 2024-12-12T07:21:17.756Z (about 1 year ago)
- Language: Python
- Size: 55.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# iterator_cacher
* Decorate a python function to cache all subsets of iterable inputs.
# When should I use this?
* Imagine you want to create LLM embeddings for 10 sentences in a single call. With most caching mechanism, if you now ask those 10 sentences with another sentence on top (so an iterable of length 11), the caching will think it know already 10 values. Same if you ask only 9 of the 10.
# Getting started
* ` python -m pip install iterator_cacher`
* Import with `from iterator_cacher import IteratorCacher`
* To use: don't use as decorator but instead manually decorate the function.
* Example to cache embeddings
``` python
from iterator_cacher import IteratorCacher
from pathlib import Path
import litellm
from string import ascii_letters
from joblib import Memory
from functools import partial
lt = ascii_letters[:list(ascii_letters).index("A")]
cache_location = Path("test_iterator")
cache_location.mkdir(parents=True, exist_ok=True)
cache_location = Memory(cache_location, verbose=False)
cached = IteratorCacher(
memory_object=cache_location,
iter_list=["input"],
verbose=True,
res_to_list = lambda out: out.to_dict()["data"],
)(litellm.embedding)
embedder = partial(cached, model="openai/text-embedding-3-small")
def p():
input("Press any key to continue.")
third = lt[:len(lt) // 3]
half = lt[:len(lt) // 2]
kwargs = {"y": 10, "z": 20}
# cache half of letters
print("Expect 1 print of 1/3 of the alphabet")
out1 = embedder(input=list(third))
p()
print("Expect no print")
out2 = embedder(input=list(third))
p()
print("Expect 1 print for the letters not in 1/3 but in 1/2 of the alphabet")
out3 = embedder(input=list(half))
p()
print("Expect 1 print for the letters of the 2nd 1/2 of the alphabet")
out4 = embedder(input=list(lt))
p()
print("Expect no print")
out2 = embedder(input=list(lt + lt))
p()
```
# Note
* This code is probably not final and will get updated as I encounter bugs.