Skip to content

Commit 28afc7d

Browse files
📖 docs new line fix
1 parent ca9d2f7 commit 28afc7d

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

docs/guide/basic-evaluation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@ result = await judge.evaluate(
3535
```
3636

3737
**What happens behind the scenes:**
38+
3839
- Judge creates a prompt asking to evaluate the response based on your criteria
40+
3941
- The LLM provides a score (typically 1-10) and reasoning
42+
4043
- You get a structured result with `decision`, `reasoning`, and `score`
4144

4245
## Level 2: Adding Structure with Scales and Rubrics

docs/guide/metrics.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,15 @@ vLLM Judge provides 20+ pre-built metrics for common evaluation tasks. This guid
55
## What are Metrics?
66

77
Metrics are pre-configured evaluation templates that encapsulate:
8+
89
- **Criteria**: What to evaluate
10+
911
- **Scale**: Numeric range (if applicable)
12+
1013
- **Rubric**: Judgement/Scoring guidelines
14+
1115
- **System Prompt**: Evaluator expertise
16+
1217
- **Examples**: Few-shot guidance
1318

1419
## Using Pre-built Metrics

docs/guide/templates.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ Template variables make your evaluations dynamic and reusable. This guide shows
55
## Why Use Templates?
66

77
Templates allow you to:
8+
89
- **Reuse** evaluation logic with different contexts
10+
911
- **Parameterize** criteria for different scenarios
12+
1013
- **Scale** evaluations across varied use cases
14+
1115
- **Maintain** consistency while allowing flexibility
1216

1317
## Basic Template Usage
@@ -640,11 +644,14 @@ Template variables provide powerful flexibility for:
640644
- **Complex logic** with Jinja2 templates
641645

642646
Key takeaways:
647+
643648
1. Start with simple `{variable}` substitution
649+
644650
2. Use template metrics for reusability
651+
645652
3. Leverage Jinja2 for complex logic
646-
4. Always validate required variables
647-
5. Document your templates clearly
653+
654+
4. Validate required variables
648655

649656
<!-- ## Next Steps
650657

0 commit comments

Comments
 (0)