Skip to content

Commit fbe1d1d

Browse files
committed
WIP: README.md: Add documentation for model signing to the README.md
Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
1 parent c0187cb commit fbe1d1d

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This repository provides an automated CI/CD process to convert, test and deploy
1515
- [Embedding](#embedding-dense)
1616
- [GGUF Conversion & Quantization](#gguf-conversion--quantization)
1717
- [GGUF Verification Testing](#gguf-verification-testing)
18+
- [GGUF Model Signing](#gguf-model-signing)
1819
- [References](#references)
1920
- [Releasing GGUF model conversions & quantizations](#releasing-gguf-model-conversions--quantizations)
2021

@@ -157,6 +158,37 @@ As a baseline, each converted model MUST successfully be run in the following pr
157158
158159
---
159160
161+
### GGUF Model Signing
162+
163+
To enable model signing, simply set the `TARGET_HF_REPO_SIGN_MODELS` build
164+
switch to 'true'.
165+
166+
If the `TARGET_HF_REPO_DO_TOKEN_EXCHANGE` build switch is set to 'false',
167+
then the signatures will use a URL associated with the repository from
168+
which the build was inititated.
169+
170+
For signature verification a version of the model_signing library
171+
later than v1.0.1 is needed:
172+
173+
```
174+
pip install model_signing>v1.0.1
175+
176+
```
177+
178+
To for example verify one of the signatures of granite-embedding-30m-english,
179+
use the following command in the directory of the huggingface git checkout:
180+
181+
```
182+
model_signing verify sigstore \
183+
--signature granite-embedding-30m-english-Q8_0.gguf.sig \
184+
--identity Garnite.GGUF@ibm.com \
185+
--identity_provider https://sigstore.verify.ibm.com/oauth2 \
186+
--ignore_unsigned_files \
187+
.
188+
```
189+
190+
---
191+
160192
## References
161193
162194
- GGUF format

0 commit comments

Comments
 (0)