You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-21Lines changed: 18 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,19 +41,17 @@ If using uv as your Python package manager:
41
41
uv pip install --torch-backend cpu imgsearch
42
42
```
43
43
44
-
**Note**: ImgSearch's TinyCLIP models work on both CPU and GPU. GPU users can skip the CPU-specific steps and use the standard PyTorch installation for faster performance.
45
-
46
44
## Quick Start
47
45
48
46
### 1. Service Management
49
47
50
48
ImgSearch follows a client-server architecture: the server handles indexing and search tasks, while the client manages user requests. Before using ImgSearch, start the server process.
51
49
52
-
The server supports Unix domain sockets (default for local, efficient connections) or TCP binding. The default Unix socket is at `~/.isearch/isearch.sock`.
50
+
The server supports unix domain sockets (default for local, efficient connections) or TCP binding. The default unix socket is at `~/.isearch/isearch.sock`.
53
51
54
52
#### Basic Usage
55
53
56
-
The default model is ViT-45LY (TinyCLIP-auto-ViT-45M-32-Text-18M-LAIONYFCC400M). See [Model Selection Guide](#model-selection-guide) for available options.
54
+
The default model is ViT-45LY (`TinyCLIP-auto-ViT-45M-32-Text-18M-LAIONYFCC400M`). See [Model Selection Guide](#model-selection-guide) for available options.
57
55
58
56
##### i. Start Service
59
57
@@ -90,7 +88,7 @@ ImgSearch service is running
90
88
91
89
#### Running as a System Service
92
90
93
-
ImgSearch can run as a background system service that starts and stops with your system. On Linux, it uses `systemd`; on macOS, `launchd`. The tool auto-detects your environment—no manual configuration needed.
91
+
ImgSearch can run as a background system service that starts and stops with your system. On Linux, it uses `systemd`; on macOS, `launchd`. The tool auto-detects your environment — no manual configuration needed.
94
92
95
93
##### i. Set Up Service
96
94
@@ -131,39 +129,37 @@ The `add` command extracts 512-dimensional feature vectors from images using Tin
131
129
132
130
The `search` subcommand handles image searches, but for ease of use, it's the default—omit it if your arguments don't match other commands.
0 commit comments