EugeneXiang commited on
Commit
1728020
·
verified ·
1 Parent(s): e78606d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -0
README.md CHANGED
@@ -10,6 +10,32 @@ widget:
10
  - text: "Check it out!"
11
  src: "https://huggingface.co/spaces/your-space" # 如果有在线 Demo
12
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
  # PRIVAL 项目文档
15
 
 
10
  - text: "Check it out!"
11
  src: "https://huggingface.co/spaces/your-space" # 如果有在线 Demo
12
  ---
13
+ ## 🚀 PriVAL Quickstart
14
+
15
+ # 1. 安装 PriVAL
16
+ pip install prival
17
+ # (可选依赖完整安装:pip install prival[full])
18
+
19
+ # 2. 创建或激活虚拟环境
20
+ # 建议隔离依赖,防止冲突
21
+
22
+ # 3. 导入函数
23
+ from prival import evaluate_prompt
24
+
25
+ # 4. 调用评估
26
+ result = evaluate_prompt("你的 prompt 文本")
27
+
28
+ # 5. 查看结果
29
+ print(result)
30
+
31
+ {
32
+ "total_score": 4.5,
33
+ "dimensions": {
34
+ "clarity": {"score": 4.0, "suggestion": "Improve specificity."},
35
+ "relevance": {"score": 5.0, "suggestion": "Good match to task."},
36
+ ...
37
+ }
38
+ }
39
 
40
  # PRIVAL 项目文档
41