Skip to content

Commit 77408b3

Browse files
committed
contrib: add new ggml backends section
Signed-off-by: Aaron Teo <aaron.teo1@ibm.com>
1 parent 635cdd5 commit 77408b3

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,19 @@ Maintainers reserve the right to decline review or close pull requests for any r
185185
186186
- For changes in server, please make sure to refer to the [server development documentation](./tools/server/README-dev.md)
187187
188+
# New GGML Backends
189+
190+
- Add yourself to [CODEOWNERS](CODEOWNERS) to claim ownership of the backend.
191+
- Follow the [coding guidelines](#coding-guidelines).
192+
- In your PR description, include a section showcasing the performance improvements. Use `llama-bench` for this.
193+
- If possible, provide the necessary CI workflow (and hardware) to test your changes (see [ci/README.md](https://github.com/ggml-org/llama.cpp/tree/master/ci)).
194+
- If you need to add third-party dependencies, extra files, or extra headers:
195+
- Download/link the required files via CMake as a build step.
196+
- Otherwise, ensure that the files are licensed under MIT; same as llama.cpp. And keep these extras as minimal as possible.
197+
- Keep your initial implementation minimal to the `GGML_OP_MUL_MAT` operator with support only for `GGML_TYPE_F32`.
198+
- Once your backend is approved and upstream, you can create more PRs to further support the backend.
199+
- This is to reduce the amount of time and effort required for review, and ensure you understand the basics of the GGML backend system.
200+
188201
# Documentation
189202
190203
- Documentation is a community effort

0 commit comments

Comments
 (0)