From ed3f8dbfd6b07da498b4254d294b70c42cbbf144 Mon Sep 17 00:00:00 2001 From: yichuan520030910320 Date: Tue, 15 Jul 2025 23:32:25 -0700 Subject: [PATCH] update readme --- README.md | 7 ++----- demo.ipynb | 3 ++- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 89f94fb..088df11 100755 --- a/README.md +++ b/README.md @@ -64,8 +64,8 @@ sudo apt-get install libomp-dev libboost-all-dev protobuf-compiler libabsl-dev l uv sync ``` -### 30-Second Example - +### 🚀 30-Second Example +Try it out in [**demo.ipynb**](demo.ipynb) ```python from leann.api import LeannBuilder, LeannSearcher # 1. Build index (no embeddings stored!) @@ -101,9 +101,6 @@ This demo showcases how to build a RAG system for PDF/md documents using Leann. 1. Place your PDF files (and other supported formats like .docx, .pptx, .xlsx) into the `examples/data/` directory. 2. Ensure you have an `OPENAI_API_KEY` set in your environment variables or in a `.env` file for the LLM to function. -```bash -uv run examples/main_cli_example.py -``` ## ✨ Features diff --git a/demo.ipynb b/demo.ipynb index 5544f1d..0d81c39 100644 --- a/demo.ipynb +++ b/demo.ipynb @@ -2,7 +2,7 @@ "cells": [ { "cell_type": "code", - "execution_count": null, + "execution_count": 6, "metadata": {}, "outputs": [ { @@ -237,6 +237,7 @@ "[leann_backend_hnsw.hnsw_embedding_server LOG]: ZMQ socket timeout, continuing to listen\n", "[leann_backend_hnsw.hnsw_embedding_server LOG]: ZMQ socket timeout, continuing to listen\n", "[leann_backend_hnsw.hnsw_embedding_server LOG]: ZMQ socket timeout, continuing to listen\n", + "[leann_backend_hnsw.hnsw_embedding_server LOG]: ZMQ socket timeout, continuing to listen\n", "[leann_backend_hnsw.hnsw_embedding_server LOG]: ZMQ socket timeout, continuing to listen\n" ] }