embed-anything 0.1.5

Embed anything at lightning speed

Infra for building multimodal embeddings from unstructured sources, built in Rust for speed and robustness

EmbedAnything is a powerful library designed to streamline the creation and management of embedding pipelines. Whether you're working with text, images, audio, or any other type of data., EmbedAnything makes it easy to generate embeddings from multiple sources and store them efficiently in a vector database.

Please bear with us, as we are releasing local and multimodal embedding soon.

Watch the demo

🚀 Key Features

• Local Embedding Works with local and OpenAI embedding
• MultiModality Works with text and image and will soon expand to audio
• Python Interface: Packaged as a Python library for seamless integration into your existing projects.
• Efficient: Optimized for speed and performance, with core functionality written in Rust.
• Scalable: Store embeddings in a vector database for easy retrieval and scalability.

💡ToDo

• Vector Database Add functionalities to integrate with any Vector Database

💚 Installation

pip install embed-anything

Requirements:

1. Please check if you already have the OpenAI key in the Environment variable. We have only released the OpenAI embedder library so far. Please stay tuned for updates for the local embeddings as well.
2. Please add libtorch address like it has been stated below.

:astronaut: Get Started

If you are using embed-anything==0.1.4 version

import embed_anything
from embed_anything import EmbedData
data = embed_anything.embed_file("filename.pdf")

For using local embedding like Allmini, Bert Jina and multimodal embedding like Clip, you need to give the address of libtorch.

```python
data:list[EmbedData] = embed_anything.embed_directory("test_files", embeder= "Clip")
embeddings = np.array([data.embedding for data in data])

How to get started for libtorch?

System-wide Libtorch

On linux platforms, the build script will look for a system-wide libtorch library in /usr/lib/libtorch.so.

Python PyTorch Install

If the LIBTORCH_USE_PYTORCH environment variable is set, the active python interpreter is called to retrieve information about the torch python package. This version is then linked against.

Libtorch Manual Install

• Get libtorch from the PyTorch website download section and extract the content of the zip file.
• For Linux and macOS users, add the following to your .bashrc or equivalent, where /path/to/libtorch is the path to the directory that was created when unzipping the file.

export LIBTORCH=/path/to/libtorch

The header files location can also be specified separately from the shared library via the following:

# LIBTORCH_INCLUDE must contain `include` directory.
export LIBTORCH_INCLUDE=/path/to/libtorch/
# LIBTORCH_LIB must contain `lib` directory.
export LIBTORCH_LIB=/path/to/libtorch/

• For Windows users, assuming that X:\path\to\libtorch is the unzipped libtorch directory.

  • Navigate to Control Panel -> View advanced system settings -> Environment variables.
  • Create the LIBTORCH variable and set it to X:\path\to\libtorch.
  • Append X:\path\to\libtorch\lib to the Path variable.

  If you prefer to temporarily set environment variables, in PowerShell you can run

$Env:LIBTORCH = "X:\path\to\libtorch"
$Env:Path += ";X:\path\to\libtorch\lib"

⚡ Contributing to EmbedAnything

First of all, thank you for taking the time to contribute to this project. We truly appreciate your contributions, whether it's bug reports, feature suggestions, or pull requests. Your time and effort are highly valued in this project. 🚀

This document provides guidelines and best practices to help you to contribute effectively. These are meant to serve as guidelines, not strict rules. We encourage you to use your best judgment and feel comfortable proposing changes to this document through a pull request.

Table of Content:

1. [Code of conduct]
2. [Quick Start]

✔️ Code of Conduct:

Please read our [Code of Conduct] to understand the expectations we have for all contributors participating in this project. By participating, you agree to abide by our Code of Conduct.

🚀 Quick Start

You can quickly get started with contributing by searching for issues with the labels "Good First Issue" or "Help Needed" in the [Issues Section]. If you think you can contribute, comment on the issue and we will assign it to you.

To set up your development environment, please follow the steps mentioned below :

1. Fork the repository and create a clone of the fork
2. Create a branch for a feature or a bug you are working on in your fork
3. If you are working with OpenAI make sure you have the keys

Contributing Guidelines

🔍 Reporting Bugs

1. Title describing the issue clearly and concisely with relevant labels
2. Provide a detailed description of the problem and the necessary steps to reproduce the issue.
3. Include any relevant logs, screenshots, or other helpful information supporting the issue.

:bulb: New Feature or Suggesting Enhancements

Testing your Changes

Pull Request