iota - a minimal local embedding database.
Motivation
WIP
Installation
Install the package via PyPI:
pip install iotadb
Usage
Here is a very simple example:
from iotadb import IotaDB, Document
# Define a list of documents
docs = [
Document(text="That is a happy dog"),
Document(text="That is a very happy person"),
Document(text="Today is a sunny day")
]
# Create a collection
db = IotaDB()
db.create_collection(name="my_collection", documents=docs)
# Query documents within your collection
results = db.search("That is a happy person", return_similarities=True)
for doc, score in results:
print(f"Text: {doc.text}")
print(f"similarity: {score:.3f}\n")
More examples can be found in the /examples directory.
Features
- Simple interface: Easy-to-use API for database operations.
- Lightweight implementation: Minimal resource utilization.
- Local storage: Stores embeddings locally for fast and retrieval.
- Fast Indexing: Efficient embedding indexing for storage and retrieval.
Use cases
- Query with Natural Language: Search for relevant documents using simple natural language queries.
- Contextual Summarization: Integrate documents into LLM contexts like GPT-3 for data-augmented tasks.
- Similarity Search: Find similar items/documents based on their embeddings.
Contributing
Interested in contributing? Head over to the Contribution Guide for more details.
Metadata
Release files for iotadb 0.0.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| iotadb-0.0.15.tar.gz | 6.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| iotadb-0.0.15-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.9 kB
Release files / iotadb-0.0.15.tar.gz
| Download URL | iotadb-0.0.15.tar.gz |
|---|---|
| Size | 6.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b49a06e8ca686a3c00a09bc7c024d82afe8aa540648305d110725ab1da361ff8
|
|
BLAKE2b-256 checksum How to use checksums |
121a2e58afb530da3733d0ee97680453f32fc8b5e25b91125a2886240f86e45b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.8
|
Release files / iotadb-0.0.15-py3-none-any.whl
| Download URL | iotadb-0.0.15-py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0f3524a3a1fcebb16a7ce5a5a885580c01aa0e9306aa605f9a9023ed79b99c21
|
|
BLAKE2b-256 checksum How to use checksums |
f54c4bc897d570de74aef1bf7a7ece42e282ddfceb30fb6431e01cce43e84faa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.8
|