Skip to content

Commit 09b3dd3

Browse files
Added info on python package
1 parent 8a0d3cb commit 09b3dd3

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,27 @@ embr rm --cached file.txt
161161
embr rm -m openai-3 file.txt
162162
```
163163

164+
## Python Bindings
165+
166+
Leverage EmbeddingBridge within your Python projects using our dedicated package. It's ideal for scripting, automation, and deeper integration with your existing ML workflows.
167+
168+
**Python Package Highlights:**
169+
170+
- Direct access to core storage and management functionalities via Python `ctypes` bindings to the C library.
171+
- `EmbeddingStore` class: For fine-grained control over embedding storage, retrieval, and similarity searches.
172+
- `EmbeddingBridge` class: Programmatically execute `embr` CLI commands from your Python scripts.
173+
- Seamlessly integrate EmbeddingBridge's versioning and management capabilities into your Python applications.
174+
175+
### Installation
176+
177+
Install the Python package in editable mode directly from the project root:
178+
```bash
179+
pip install -e ./python
180+
```
181+
This command assumes your `setup.py` for the Python package is located in the `python` subdirectory.
182+
183+
For comprehensive API documentation, usage examples, and advanced configurations, please consult the [Python Package README](python/README.md).
184+
164185
## Contributing
165186

166187
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)