Skip to content

Commit 62f0599

Browse files
committed
docs: 更新项目描述和示例文档
- 修改package.json中的项目描述,更详细地说明CLI工具的功能 - 更新example.md文件,详细描述AI处理流程和评估方法
1 parent 1ead7a1 commit 62f0599

File tree

2 files changed

+30
-10
lines changed

2 files changed

+30
-10
lines changed

examples/example.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,44 @@ Each example folder contains:
3434

3535
## AI Processing Workflow
3636

37-
1. **Input**: Base PP3 (unedited RAW profile)
38-
2. **Generation**: `ai.sh` script uses Gemini 2.5 Pro via OpenRouter API to:
39-
- Analyze image characteristics
40-
- Generate optimized PP3 file
41-
3. **Output**: AI-processed JPG and PP3 sidecar file
37+
1. **Base PP3 Creation**:
38+
- Open RAW file in RawTherapee 5.9+
39+
- Immediately save as base.pp3 without adjustments
40+
41+
2. **AI Profile Generation**:
42+
```bash
43+
# Example from /examples/1/ai.sh
44+
#!/bin/bash
45+
export OPENAI_API_KEY=your-key-here
46+
47+
ai-pp3 IMG_0080.CR2 \
48+
--provider openrouter \
49+
--model google/gemini-pro-1.5 \
50+
--base IMG_0080.CR2.pp3 \
51+
--output ai.pp3
52+
```
4253

4354
**Requirements**:
4455
- RawTherapee 5.9+
4556
- OpenRouter API key (for Gemini access)
4657
- Basic command-line knowledge
4758

48-
## Evaluation Guide
59+
## Evaluation Methodology
4960

50-
Compare results using:
61+
1. **Technical Comparison**:
5162
```bash
52-
# PP3 diff check
53-
diff example_folder/base.pp3 example_folder/ai.pp3
63+
# Structural diff ignoring timestamps
64+
diff -I '\<Date\>' base.pp3 ai.pp3
65+
66+
# Parameter statistics
67+
awk -F= '/^[^#]/ {print $1}' ai.pp3 | sort | uniq -c
5468
```
5569

70+
2. **Visual Assessment**:
71+
- Side-by-side comparison in RawTherapee
72+
- Histogram analysis of tone distribution
73+
- Zoomed inspection of noise patterns
74+
5675
## Reference Materials
5776

5877
- [RawTherapee Processing Challenge](https://rawpedia.rawtherapee.com/Rawtherapee_Processing_Challenge_feedback)

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ai-pp3",
33
"version": "1.2.0",
4-
"description": "AI-driven RAW photo processor that generates optimized PP3 profiles for RawTherapee",
4+
"description": "CLI tool combining multimodal AI analysis with RawTherapee's engine to generate optimized PP3 profiles for RAW photography",
55
"engines": {
66
"node": ">=18"
77
},
@@ -52,6 +52,7 @@
5252
},
5353
"keywords": [
5454
"ai",
55+
"multimodal",
5556
"raw",
5657
"photography",
5758
"rawtherapee",

0 commit comments

Comments
 (0)