Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Docs: consolidate build-from-source and GPU backend guide

Aberta Para iniciantes
#2,314 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
75/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Pouca atividade
Stack de tecnologia
cmake, python
Domínio
build-system, documentation

Direção de pesquisa

A issue aponta para a consolidação da documentação de build, provavelmente em docs/build.md ou em um novo arquivo docs/gpu.md. Comece revisando o README existente, CONTRIBUTING.md e as issues do GitHub vinculadas (#2013, #695, #721, #756) para entender as informações atualmente dispersas. Em seguida, crie uma tabela clara de CMAKE_ARGS para cada backend de GPU e adicione etapas de solução de problemas para erros comuns. Verifique as alterações compilando o projeto com um backend de GPU para garantir que as instruções funcionem.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Problem

The build-from-source documentation is spread across README, CONTRIBUTING.md, and many GitHub issues (e.g. #2013, #695, #721, #756). Users with newer GPUs (RTX 50-series, sm_120) or uncommon CUDA versions repeatedly hit the same build failures because the docs lack:

  1. A CMAKE_ARGS mapping table showing which flag to set for each GPU backend
  2. CUDA version compatibility notes (e.g., CUDA 12.9+ requires specific cmake workarounds)
  3. The minimum/maximum supported CUDA toolkit versions
  4. How to verify the build actually used the GPU (simple Python snippet to check backend)

Suggested improvements

In docs/build.md (or a new docs/gpu.md):

| Backend | CMAKE_ARGS                                    | GPU Requirements              |
|---------|-----------------------------------------------|-------------------------------|
| CUDA    | -DGGML_CUDA=ON                                | NVIDIA GPU, CUDA >= 11.3      |
| Metal   | -DGGML_METAL=ON (default on macOS)            | Apple Silicon or AMD GPU      |
| Vulkan  | -DGGML_VULKAN=ON                              | Vulkan 1.2+ capable GPU       |
| SYCL    | -DGGML_SYCL=ON -DGGML_SYCL_TARGET=INTEL       | Intel Arc / Iris Xe           |
| HIP     | -DGGML_HIPBLAS=ON                             | AMD ROCm-compatible GPU       |

And a troubleshooting section for the most common build errors (CMake not finding CUDA, nvcc version mismatch, sm_120 not recognized).

Value

Consolidating this reduces the "can't install with GPU" issues that currently fill the tracker.

Linguagem predominante
Python
Estrelas
10.6k
Forks
1.5k
Merge médio
6h 43min
PRs com merge (30d)
2

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de abetlen/llama-cpp-python

Todas as issues de abetlen/llama-cpp-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.