ci : add README.md

This commit is contained in:
Georgi Gerganov 2023-07-18 13:30:26 +03:00
parent 9e8392a0c0
commit da4a773cbc
No known key found for this signature in database
GPG key ID: 449E073F9DC10735

19
ci/README.md Normal file
View file

@ -0,0 +1,19 @@
# CI
In addition to [Github Actions](https://github.com/ggerganov/llama.cpp/actions) `llama.cpp` uses a custom CI framework:
https://github.com/ggml-org/ci
It monitors the `master` branch for new commits and runs the [[ci/run.sh]] script on dedicated cloud instances. This
allows us to execute heavier workloads compared to just using Github Actions. Also with time, the cloud instances will
be scaled to cover various hardware architectures, including GPU and Apple Silicon instances.
Collaborators can optionally trigger the CI run by adding the `ggml-ci` keyword to their commit message.
Only the branches of this repo are monitored for this keyword.
It is a good practice, before publishing changes to execute the full CI locally on your machine:
```bash
mkdir tmp
bash ./ci/run.sh ./tmp/results ./tmp/mnt
```