rustocr 0.6.0

High-performance Rust CLI for EasyOCR with 80+ language support, featuring server mode and batch processing
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# Server Mode Testing & README

## Server Mode v0.3.0 - Quick Start Guide

### Installation

1. Install server dependencies:
```bash
cd rust  
pip install -r requirements-server.txt
```

2. Build the Rust client:
```bash
cargo build --release
```

### Usage

#### Method 1: Manual Server Management

**Terminal 1 - Start Server:**
```bash
python3 easyocr_server.py --port 8000
```

**Terminal 2 - Use Client:**
```bash
# Server mode (fast for multiple requests)
./target/release/rustocr -i image.jpg --use-server

# Subprocess mode (default, no server needed)
./target/release/rustocr -i image.jpg
```

#### Method 2: Custom Server URL
```bash
# Start server on different port
python3 easyocr_server.py --port 9000

# Point client to custom URL
./target/release/rustocr -i image.jpg --use-server --server-url http://localhost:9000
```

### Server API Endpoints

- `GET /` - Server info
- `GET /api/v1/health` - Health check
- `GET /api/v1/models` - List loaded models
- `POST /api/v1/ocr` - Perform OCR
- `POST /api/v1/models/warmup` - Preload models

### Performance Comparison

| Mode | First Request | Subsequent Requests | Best For |
|------|---------------|---------------------|----------|
| Subprocess | 3-5s | 3-5s | Single images |
| Server | 3-5s | <500ms | Multiple images |

### Example: Batch Processing with Server

```bash
# Start server once
python3 easyocr_server.py &

# Process multiple images (each request is fast)
for img in images/*.jpg; do
    ./target/release/rustocr -i "$img" --use-server -o text
done

# Stop server
kill %1
```

### Troubleshooting

**Server won't start:**
- Check if port 8000 is already in use: `lsof -i :8000`
- Try a different port: `python3 easyocr_server.py --port 8001`

**Client can't connect:**
- Verify server is running: `curl http://localhost:8000/api/v1/health`
- Check firewall settings
- Ensure correct URL: `--server-url http://localhost:8000`

**Slow performance:**
- First request loads models (expected)
- Subsequent requests should be <500ms
- Check GPU is available: `nvidia-smi` (if using CUDA)

### Development

**Server Logs:**
```bash
# View detailed logs
python3 easyocr_server.py --reload  # Auto-reload on changes
```

**Client Debug:**
```bash
# Check connection
curl -X POST http://localhost:8000/api/v1/ocr \
  -H "Content-Type: application/json" \
  -d '{"image": "...", "languages": ["en"], "detail": 1, "gpu": true}'
```

## Testing Results

### Phase 1 & 2 Tests ✅

1. **Server Startup:** ✓ 
   - Server starts on port 8000
   - Health endpoint responds correctly
   
2. **CLI Flags:** ✓
   - `--use-server` flag available
   - `--server-url` flag with default value
   
3. **Server Health Check:** ✓
   - Client checks server before sending requests
   - Graceful error message if server unavailable

### Next Steps (Phase 3)

- [ ] Add `--server` flag to start server from Rust
- [ ] Implement background server process management  
- [ ] Add `--server-stop` command
- [ ] Full end-to-end OCR test with latency measurement