Skip to content

Commit 827002d

Browse files
authored
Update image search project description (#543)
1 parent 506f4ac commit 827002d

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

examples/image_search/README.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,41 @@
11
# Image Search with CocoIndex
2+
[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex)
23

3-
![image](https://github.com/user-attachments/assets/3a696344-c9b4-46e8-9413-6229dbb8672a)
4+
We will build live image search and query it with natural language, using multimodal embedding model. We are going use CocoIndex to build real-time indexing flow. During running, you can add new files to the folder and it only process changed files and will be indexed within a minute.
45

6+
We appreciate a star ⭐ at [CocoIndex Github](https://github.com/cocoindex-io/cocoindex) if this is helpful.
7+
8+
<img width="1105" alt="cover" src="https://github.com/user-attachments/assets/7f1a59e0-77cf-45ed-b45b-4e3eb6e826b9" />
9+
10+
## Technologies
11+
- CocoIndex for ETL and live update
12+
- CLIP ViT-L/14 - Embeddings Model for images and query
513
- Qdrant for Vector Storage
6-
- CLIP ViT-L/14 - Embeddings Model for both images and text
7-
- Live Update
8-
9-
## Make sure Postgres and Qdrant are running
10-
```
11-
docker run -d -p 6334:6334 -p 6333:6333 qdrant/qdrant
12-
export COCOINDEX_DATABASE_URL="postgres://cocoindex:cocoindex@localhost/cocoindex"
13-
```
14-
15-
## Create Qdrant Collection
16-
```
17-
curl -X PUT 'http://localhost:6333/collections/image_search' \
18-
-H 'Content-Type: application/json' \
19-
-d '{
20-
"vectors": {
21-
"embedding": {
22-
"size": 768,
23-
"distance": "Cosine"
14+
- FastApi for backend
15+
16+
17+
## Setup
18+
- Make sure Postgres and Qdrant are running
19+
```
20+
docker run -d -p 6334:6334 -p 6333:6333 qdrant/qdrant
21+
export COCOINDEX_DATABASE_URL="postgres://cocoindex:cocoindex@localhost/cocoindex"
22+
```
23+
24+
- Create Qdrant Collection
25+
```
26+
curl -X PUT 'http://localhost:6333/collections/image_search' \
27+
-H 'Content-Type: application/json' \
28+
-d '{
29+
"vectors": {
30+
"embedding": {
31+
"size": 768,
32+
"distance": "Cosine"
33+
}
2434
}
25-
}
26-
}'
27-
```
35+
}'
36+
```
2837

29-
## Run Backend
38+
## Run
3039
- Install dependencies:
3140
```
3241
pip install -e .

0 commit comments

Comments
 (0)