diff --git a/CHANGELOG.md b/CHANGELOG.md index d320974..69c66f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ ## [Unreleased] +### Documentation + +- **Release highlights in Chinese, English and Spanish** (`docs/release-highlights.*.md` / `README*.md`) + The highlights document now follows the same `..md` convention as the READMEs, with a language switcher in each file. Each README gained a Performance section carrying the latest release's headline figures and linking to the highlights and to the `### Validation` entries behind them. + ## [0.4.0] — 2026-08-07 ### New Features diff --git a/README.es.md b/README.es.md index 39ff4c3..4bf7d6f 100644 --- a/README.es.md +++ b/README.es.md @@ -76,6 +76,20 @@ Indeed 741 + LinkedIn 255 = 996 extraídos → Tasa de filtrado total: 94.6% (solo 54 de 996 requieren revisión humana) ``` +## Rendimiento + +Última versión, 0.4.0: + +| Métrica | Antes | Después | +| --- | --- | --- | +| Búsqueda de extremo a extremo | 118,5 s | 45,6 s (-61,5 %) | +| Primer resultado | 47,5 s | 12,8 s (-73,1 %) | +| Llamadas al LLM por ejecución | 41 | 20 (-51,2 %) | + +Consulta las [novedades de cada versión](docs/release-highlights.es.md) y las +entradas `### Validation` de [CHANGELOG.md](CHANGELOG.md) para saber cómo se +midió cada cifra. + ## Variables de Entorno ```env diff --git a/README.md b/README.md index 20c5b5a..b107d5e 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,20 @@ Indeed 741 + LinkedIn 255 = 996 scraped → Overall filter rate: 94.6% (only 54 of 996 require human review) ``` +## Performance + +Latest release, 0.4.0: + +| Metric | Before | After | +| --- | --- | --- | +| Search end-to-end | 118.5 s | 45.6 s (-61.5%) | +| First result | 47.5 s | 12.8 s (-73.1%) | +| LLM calls per run | 41 | 20 (-51.2%) | + +See [release highlights](docs/release-highlights.md) for every release, and the +`### Validation` entries in [CHANGELOG.md](CHANGELOG.md) for how each figure was +measured. + ## Environment Variables ```env diff --git a/README.zh.md b/README.zh.md index 1b56655..f93333f 100644 --- a/README.zh.md +++ b/README.zh.md @@ -76,6 +76,19 @@ Indeed 741 + LinkedIn 255 = 996 抓取 → 最终过滤率 94.6%(996 条中仅 54 条需人工审阅) ``` +## 性能 + +最新版本 0.4.0: + +| 指标 | 优化前 | 优化后 | +| --- | --- | --- | +| 搜索端到端 | 118.5 秒 | 45.6 秒(-61.5%) | +| 首条结果 | 47.5 秒 | 12.8 秒(-73.1%) | +| 每轮 LLM 调用 | 41 次 | 20 次(-51.2%) | + +各版本详见[版本亮点](docs/release-highlights.zh.md),每个数字的测量方式见 +[CHANGELOG.md](CHANGELOG.md) 的 `### Validation` 条目。 + ## 环境变量 ```env diff --git a/docs/release-highlights.es.md b/docs/release-highlights.es.md new file mode 100644 index 0000000..243315c --- /dev/null +++ b/docs/release-highlights.es.md @@ -0,0 +1,30 @@ +# Novedades de cada versión + +> [中文](release-highlights.zh.md) · [English](release-highlights.md) · **Español** + +Resumen orientado al usuario de lo que mejoró cada versión. Cada cifra debe poder +rastrearse hasta una entrada `### Validation` en [CHANGELOG.md](../CHANGELOG.md); +este archivo nunca introduce una cifra propia. + +A partir de 0.5.0, cada versión se compara con la versión anterior. + +## 0.4.0 + +Líneas base: `bench/serial-baseline` para las cifras de rendimiento y +`bench/pre-merged-eval` → `bench/merged-eval` para las cifras de coste. Esta +versión abarca diez pull requests, por lo que no se compara con `v0.3.0`. + +**La búsqueda es 2,6 veces más rápida** +118,5 s → 45,6 s (-61,5 %) + +**El primer resultado llega 3,7 veces antes** +47,5 s → 12,8 s (-73,1 %) + +**Rendimiento un 145 % mayor** +14,7 → 36,0 ofertas por minuto + +**Llamadas al LLM reducidas a la mitad** +41 → 20 por ejecución (-51,2 %) + +**Tokens de entrada por oferta un 47,5 % menos** +5.251 → 2.759 diff --git a/docs/release-highlights.md b/docs/release-highlights.md index 8f99785..3a55fd5 100644 --- a/docs/release-highlights.md +++ b/docs/release-highlights.md @@ -1,5 +1,7 @@ # Release highlights +> [中文](release-highlights.zh.md) · **English** · [Español](release-highlights.es.md) + User-facing summary of what each release improved. Every figure here must trace back to a `### Validation` entry in [CHANGELOG.md](../CHANGELOG.md); this file never introduces a number of its own. @@ -8,8 +10,8 @@ From 0.5.0 onward each release is compared against the previous release. ## 0.4.0 -Baselines: `09b20c0` serial architecture for the performance figures, -`fb5b211` → `d4cfd11` single-variable runs for the cost figures. This release +Baselines: `bench/serial-baseline` for the performance figures, +`bench/pre-merged-eval` → `bench/merged-eval` for the cost figures. This release spans ten pull requests, so it is not compared against `v0.3.0`. **Search is 2.6x faster** diff --git a/docs/release-highlights.zh.md b/docs/release-highlights.zh.md new file mode 100644 index 0000000..f6fc2d7 --- /dev/null +++ b/docs/release-highlights.zh.md @@ -0,0 +1,29 @@ +# 版本亮点 + +> **中文** · [English](release-highlights.md) · [Español](release-highlights.es.md) + +面向使用者的版本优化摘要。这里的每个数字都必须能在 [CHANGELOG.md](../CHANGELOG.md) +的 `### Validation` 中找到出处;本文档不产生任何自己的数字。 + +从 0.5.0 起,每个版本对比上一个发布版本。 + +## 0.4.0 + +基线:性能数字来自 `bench/serial-baseline`,成本数字来自 +`bench/pre-merged-eval` → `bench/merged-eval`。本版本跨越十个 PR, +因此不与 `v0.3.0` 对比。 + +**搜索快 2.6 倍** +118.5 秒 → 45.6 秒(-61.5%) + +**首条结果快 3.7 倍** +47.5 秒 → 12.8 秒(-73.1%) + +**吞吐提升 145%** +每分钟 14.7 → 36.0 个职位 + +**LLM 调用减半** +每轮 41 → 20 次(-51.2%) + +**每职位输入 token 减少 47.5%** +5,251 → 2,759