History

Xuan-Son Nguyen 6c2131773c cli: new CLI experience (#17824 ) * wip * wip * fix logging, add display info * handle commands * add args * wip * move old cli to llama-completion * rm deprecation notice * move server to a shared library * move ci to llama-completion * add loading animation * add --show-timings arg * add /read command, improve LOG_ERR * add args for speculative decoding, enable show timings by default * add arg --image and --audio * fix windows build * support reasoning_content * fix llama2c workflow * color default is auto * fix merge conflicts * properly fix color problem Co-authored-by: bandoti <bandoti@users.noreply.github.com> * better loading spinner * make sure to clean color on force-exit * also clear input files on "/clear" * simplify common_log_flush * add warning in mtmd-cli * implement console writter * fix data race * add attribute * fix llama-completion and mtmd-cli * add some notes about console::log * fix compilation --------- Co-authored-by: bandoti <bandoti@users.noreply.github.com>		2025-12-10 15:28:59 +01:00
..
README-MUSA.md	musa: upgrade musa sdk to 4.3.0 (#16240 )	2025-09-26 02:56:38 +02:00
README.md	ci : migrate ggml ci to self-hosted runners (#16116 )	2025-09-21 16:50:45 +03:00
run.sh	cli: new CLI experience (#17824 )	2025-12-10 15:28:59 +01:00

README.md

CI

This CI implements heavy-duty workflows that run on self-hosted runners. Typically the purpose of these workflows is to cover hardware configurations that are not available from Github-hosted runners and/or require more computational resource than normally available.

It is a good practice, before publishing changes to execute the full CI locally on your machine. For example:

mkdir tmp

# CPU-only build
bash ./ci/run.sh ./tmp/results ./tmp/mnt

# with CUDA support
GG_BUILD_CUDA=1 bash ./ci/run.sh ./tmp/results ./tmp/mnt

# with SYCL support
source /opt/intel/oneapi/setvars.sh
GG_BUILD_SYCL=1 bash ./ci/run.sh ./tmp/results ./tmp/mnt

# with MUSA support
GG_BUILD_MUSA=1 bash ./ci/run.sh ./tmp/results ./tmp/mnt

# etc.

Adding self-hosted runners

Add a self-hosted ggml-ci workflow to .github/workflows/build.yml with an appropriate label
Request a runner token from ggml-org (for example, via a comment in the PR or email)
Set-up a machine using the received token (docs)
Optionally update ci/run.sh to build and run on the target platform by gating the implementation with a GG_BUILD_... env