Skip to content

Commit c7968c5

Browse files
committed
Polish README and remove planning references
1 parent aa3d238 commit c7968c5

2 files changed

Lines changed: 4 additions & 22 deletions

File tree

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1304,22 +1304,9 @@ dotnet test --solution MarkdownLd.Kb.slnx --configuration Release -- --coverage
13041304

13051305
Coverage is collected through `Microsoft.Testing.Extensions.CodeCoverage`. Cobertura is the XML output format used for line and branch reporting; the test project does not reference Coverlet.
13061306

1307-
BenchmarkDotNet performance runs are separate from TUnit correctness tests:
1307+
BenchmarkDotNet performance runs are separate from TUnit correctness tests. Commands, workload profiles, profiler options, and full result tables live in [Performance Benchmarks](docs/Features/PerformanceBenchmarks.md). PR validation and the dedicated benchmark workflow both run the complete BenchmarkDotNet suite and upload the `benchmarkdotnet-results` artifact.
13081308

1309-
```bash
1310-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --list flat
1311-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*FuzzyEditDistanceBenchmarks*"
1312-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*GraphBuildBenchmarks*"
1313-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*GraphSearchBenchmarks*"
1314-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*TiktokenSearchBenchmarks*"
1315-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*GraphPersistenceBenchmarks*"
1316-
dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*GraphLifecycleBenchmarks*"
1317-
MARKDOWN_LD_KB_BENCHMARK_PROFILE=cpu dotnet run --project benchmarks/MarkdownLd.Kb.Benchmarks -c Release -- --filter "*FuzzyEditDistanceBenchmarks*"
1318-
```
1319-
1320-
Benchmark reports are written to `artifacts/benchmarks/results` as Markdown, CSV, and full JSON. The reports are intentionally ignored by git because they depend on the local machine and current system load. PR validation and the dedicated workflow in `.github/workflows/benchmarks.yml` both run the complete BenchmarkDotNet suite and upload the `benchmarkdotnet-results` artifact. The benchmark config adds one `Default` job only when the command does not already pass `--job`, `--job=...`, or `-j`.
1321-
1322-
The full metric definitions, workload profiles, and current result tables are maintained in [Performance Benchmarks](docs/Features/PerformanceBenchmarks.md). The README keeps only the current headline numbers from the May 3, 2026 local BenchmarkDotNet 0.15.8 run on Apple M2 Pro with .NET 10.0.5:
1309+
Current local headline numbers from the May 3, 2026 BenchmarkDotNet 0.15.8 run on Apple M2 Pro with .NET 10.0.5:
13231310

13241311
| Area | Current local result |
13251312
| --- | --- |
@@ -1333,4 +1320,4 @@ The full metric definitions, workload profiles, and current result tables are ma
13331320
| Lifecycle | Build/search/save/load/export is 55.35 ms / 54.44 MB |
13341321
| Fuzzy edit distance | Long insertion is 376.58x faster than naive Levenshtein; long no-match is 172.88x faster, both with 0 B allocated |
13351322

1336-
These numbers are local diagnostics, not a cross-machine performance contract. The full Markdown, CSV, and JSON BenchmarkDotNet reports remain the source for raw measurements.
1323+
These numbers are local diagnostics, not a cross-machine performance contract.

docs/ADR/ADR-0003-tiktoken-extraction-mode.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,4 @@ Commands:
143143
- Unsupervised Keyphrase Extraction with Multipartite Graphs: `https://arxiv.org/abs/1803.08721`
144144
- Improving Graph-Based Text Representations with Character and Word Level N-grams: `https://arxiv.org/abs/2210.05999`
145145
- `docs/Architecture.md`
146-
- `tiktoken-graph-extraction.brainstorm.md`
147-
- `tiktoken-graph-extraction.plan.md`
148-
- `token-distance-ir-experiments.brainstorm.md`
149-
- `token-distance-ir-experiments.plan.md`
150-
- `local-corpus-graph-fallback.brainstorm.md`
151-
- `local-corpus-graph-fallback.plan.md`
146+
- `docs/Features/PerformanceBenchmarks.md`

0 commit comments

Comments
 (0)