Skip to content

Commit 4aaa4d8

Browse files
authored
docs: document CI workflow and SIMD runner setup (#85)
* 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. * docs: move CI details under Contributing Keep Requirements focused on runtime needs and link to Contributing from Performance.
1 parent 4e78c35 commit 4aaa4d8

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`). See [Contributing](#contributing) for the CI setup.
9999

100100
### ReadAll Throughput
101101

@@ -160,6 +160,19 @@ GOEXPERIMENT=simd go test -bench=. -benchmem
160160

161161
Contributions are welcome! Please open issues or pull requests on GitHub.
162162

163+
### CI
164+
165+
This repository runs two GitHub Actions workflows:
166+
167+
| Workflow | Trigger | Runner | SIMD acceleration |
168+
|----------|---------|--------|-------------------|
169+
| [`ci.yml`](.github/workflows/ci.yml) | Every pull request | GitHub-hosted `ubuntu-latest` | No (scalar fallback) |
170+
| [`ci-avx512.yml`](.github/workflows/ci-avx512.yml) | Manual only | Self-hosted (`avx512`) | Yes |
171+
172+
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.
173+
174+
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.
175+
163176
## License
164177

165178
MIT License - see [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)