Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.5 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.5 KB
Raw

LeapfrogAI Text Embeddings Backend

A LeapfrogAI API-compatible text embeddings wrapper for producing embeddings from text content.

Usage

Pre-Requisites

See the LeapfrogAI documentation website for system requirements and dependencies.

Dependent Components

  • LeapfrogAI API for a fully RESTful application
  • Supabase for a vector database to store resulting embeddings in

Model Selection

The default model that comes with this backend in this repository's officially released images is instructor-xl.

Deployment

To build and deploy the text-embeddings backend Zarf package into an existing UDS Kubernetes cluster:

Important

Execute the following commands from the root of the LeapfrogAI repository

pip install 'huggingface_hub[cli,hf_transfer]'  # Used to download the model weights from huggingface
make build-text-embeddings LOCAL_VERSION=dev
uds zarf package deploy packages/text-embeddings/zarf-package-text-embeddings-*-dev.tar.zst --confirm

Local Development

To run the text-embeddings backend locally:

Important

Execute the following commands from this sub-directory

# Install dev and runtime dependencies
make install

# Clone Model
python scripts/model_download.py

# Start the model backend
make dev