# DeepLake DeepMemory Pack
This LlamaPack inserts your data into deeplake and instantiates a [deepmemory](https://docs.activeloop.ai/performance-features/deep-memory) retriever, which will use deepmemory during runtime to increase RAG's retrieval accuracy (recall).
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack DeepMemoryRetrieverPack --download-dir ./deepmemory_pack
```
You can then inspect the files at `./deepmemory_pack` and use them as a template for your own project!
## Code Usage
You can download the pack to a `./deepmemory_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
DeepMemoryRetriever = download_llama_pack(
"DeepMemoryRetrieverPack", "./deepmemory_pack"
)
```
From here, you can use the pack, or inspect and modify the pack in `./deepmemory_pack`.
Then, you can set up the pack like so:
```python
# setup pack arguments
from llama_index.core.vector_stores import MetadataInfo, VectorStoreInfo
nodes = [...]
# create the pack
deepmemory_pack = DeepMemoryRetriever(
dataset_path="llama_index",
overwrite=False,
nodes=nodes,
)
```
The `run()` function is a light wrapper around `query_engine.query()`.
```python
response = deepmemory_pack.run("Tell me a bout a Music celebritiy.")
```
You can also use modules individually.
```python
# use the retriever
retriever = deepmemory_pack.retriever
nodes = retriever.retrieve("query_str")
# use the query engine
query_engine = deepmemory_pack.query_engine
response = query_engine.query("query_str")
```
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-packs-deeplake-deepmemory-retriever",
"maintainer": "AdkSarsen",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "deeplake, deepmemory, retriever",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/bf/7a/b66d419683feab380d292ab4f9338c09498c44f10383e36a721ab2d7e2eb/llama_index_packs_deeplake_deepmemory_retriever-0.1.4.tar.gz",
"platform": null,
"description": "# DeepLake DeepMemory Pack\n\nThis LlamaPack inserts your data into deeplake and instantiates a [deepmemory](https://docs.activeloop.ai/performance-features/deep-memory) retriever, which will use deepmemory during runtime to increase RAG's retrieval accuracy (recall).\n\n## CLI Usage\n\nYou can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:\n\n```bash\nllamaindex-cli download-llamapack DeepMemoryRetrieverPack --download-dir ./deepmemory_pack\n```\n\nYou can then inspect the files at `./deepmemory_pack` and use them as a template for your own project!\n\n## Code Usage\n\nYou can download the pack to a `./deepmemory_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nDeepMemoryRetriever = download_llama_pack(\n \"DeepMemoryRetrieverPack\", \"./deepmemory_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./deepmemory_pack`.\n\nThen, you can set up the pack like so:\n\n```python\n# setup pack arguments\nfrom llama_index.core.vector_stores import MetadataInfo, VectorStoreInfo\n\nnodes = [...]\n\n# create the pack\ndeepmemory_pack = DeepMemoryRetriever(\n dataset_path=\"llama_index\",\n overwrite=False,\n nodes=nodes,\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = deepmemory_pack.run(\"Tell me a bout a Music celebritiy.\")\n```\n\nYou can also use modules individually.\n\n```python\n# use the retriever\nretriever = deepmemory_pack.retriever\nnodes = retriever.retrieve(\"query_str\")\n\n# use the query engine\nquery_engine = deepmemory_pack.query_engine\nresponse = query_engine.query(\"query_str\")\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs deeplake_deepmemory_retriever integration",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"deeplake",
" deepmemory",
" retriever"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e11a607447827de1659125f9b5227ddd0996cb6e32818c650a114a57a06594e",
"md5": "389789587c9430b7d9b4516e260c41c9",
"sha256": "82d85124f602a0cda9f68609794d97207dbfa5ba3815b61fb651c6407220854b"
},
"downloads": -1,
"filename": "llama_index_packs_deeplake_deepmemory_retriever-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "389789587c9430b7d9b4516e260c41c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 3308,
"upload_time": "2024-08-06T00:43:41",
"upload_time_iso_8601": "2024-08-06T00:43:41.441826Z",
"url": "https://files.pythonhosted.org/packages/4e/11/a607447827de1659125f9b5227ddd0996cb6e32818c650a114a57a06594e/llama_index_packs_deeplake_deepmemory_retriever-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf7ab66d419683feab380d292ab4f9338c09498c44f10383e36a721ab2d7e2eb",
"md5": "7660872f49b4ff0f6d1efbc3149ac409",
"sha256": "70ece43638c32bd67aeee04662916e8cc8a885af06d720d4a318bfca61dc70c3"
},
"downloads": -1,
"filename": "llama_index_packs_deeplake_deepmemory_retriever-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "7660872f49b4ff0f6d1efbc3149ac409",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 2851,
"upload_time": "2024-08-06T00:43:42",
"upload_time_iso_8601": "2024-08-06T00:43:42.981502Z",
"url": "https://files.pythonhosted.org/packages/bf/7a/b66d419683feab380d292ab4f9338c09498c44f10383e36a721ab2d7e2eb/llama_index_packs_deeplake_deepmemory_retriever-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 00:43:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-deeplake-deepmemory-retriever"
}
JSON