Skip to content

Commit af6bb04

Browse files
committed
docs: document CI workflow and SIMD runner setup
Clarify that PR CI falls back to scalar while AVX-512 benchmarks run on the self-hosted runner only.
1 parent 4e78c35 commit af6bb04

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ reader := csv.NewReaderWithOptions(r, csv.ReaderOptions{
9595

9696
## Performance
9797

98-
Benchmarks on AMD EPYC 9R14 with AVX-512 (Go 1.26, `GOEXPERIMENT=simd`).
98+
Benchmarks on AMD EPYC 9R14 with AVX-512 (Go 1.26, `GOEXPERIMENT=simd`), measured via the self-hosted AVX-512 CI runner.
9999

100100
### ReadAll Throughput
101101

@@ -138,6 +138,19 @@ The library **still works** but falls back to scalar implementation (no speedup)
138138
- AMD CPUs before Zen 4
139139
- Apple Silicon (ARM64)
140140

141+
### CI
142+
143+
This repository runs two GitHub Actions workflows:
144+
145+
| Workflow | Trigger | Runner | SIMD acceleration |
146+
|----------|---------|--------|-------------------|
147+
| [`ci.yml`](.github/workflows/ci.yml) | Every pull request | GitHub-hosted `ubuntu-latest` | No (scalar fallback) |
148+
| [`ci-avx512.yml`](.github/workflows/ci-avx512.yml) | Manual only | Self-hosted (`avx512`) | Yes |
149+
150+
Pull request checks use `ubuntu-latest`, which typically lacks AVX-512. Tests still pass because the library falls back to the scalar path when SIMD instructions are unavailable.
151+
152+
AVX-512 benchmarks and SIMD validation run only on the self-hosted runner via **AVX-512 CI**. Trigger it manually from the Actions tab when you need real SIMD test and benchmark results.
153+
141154
## Building & Testing
142155

143156
```bash

0 commit comments

Comments
 (0)