mirror of
https://github.com/ggml-org/ggml.git
synced 2026-10-28 16:37:16 +08:00
38 lines
1.7 KiB
Plaintext
38 lines
1.7 KiB
Plaintext
Take a look at the changelog between the current version and the previous version - use the `./scripts/make-release-desc.sh [current-version]` to obtain it.
|
|
|
|
Write a summary of the change log in a few sections:
|
|
|
|
```
|
|
## Overview
|
|
|
|
[a single paragraph overview of all changes]
|
|
|
|
### API changes (if applicable)
|
|
|
|
[summarize the changes to `/include/*`]
|
|
|
|
### Core changes (if applicable)
|
|
|
|
[summarize the changes to `/src/ggml*`
|
|
|
|
### Backend changes (if applicable)
|
|
|
|
[summarize the changes to `/src/ggml-*`, organize in sub-sections per backend]
|
|
|
|
```
|
|
|
|
For all changes, you can refer to the `llama.cpp` and `whisper.cpp` repositories for more information. For example, a change comming from `(llama/XXXX)` has more information in the respective PR in the `llama.cpp` repository.
|
|
|
|
Guidelines:
|
|
|
|
- All bullet point in the summary should be concise and rarely exceed a single line of 120 characters (excluding PR links)
|
|
- Do not wrap or break lines within a bullet point or paragraph - each bullet point must fit on a single line (PR links allowed to exceed the line limit)
|
|
- Avoid mentioning that the changes are synchronized - this is not relevant
|
|
- Avoid mentioning specific models - focus on generality of the ggml framework
|
|
- Replace `(llama/XXXX)` and `(whisper/XXXX)` with a link to the respective PR
|
|
- Group similar/related items into a single bullet with multiple trailing PR links, one bullet per topic
|
|
- A full list of commits will be appended independently at end of the summary, so it is not a problem to skip some less important changes
|
|
- Skip minor-impact notes (e.g. "fix compile warnings", "refactored code", ...)
|
|
|
|
Output just the summary in a markdown block, without any extra text. Save it to a local text file called `release-notes-vX.Y.Z.txt`.
|