C++ API Documentation Missing / Insufficient for New Users

Aperta
#1,945 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
cpp
Ambito
documentation

Direzione di ricerca

Inizia dalla descrizione della libreria C++ nel README e dalla pagina della documentazione di CTranslate2 collegata, quindi esamina gli esempi C++ esistenti e gli header citati nell’issue. Definisci l’ambito della documentazione includendo l’uso dell’API, la progettazione della libreria, il batching, lo streaming, la concorrenza, la gestione della memoria e la configurazione del dispositivo o del calcolo; il lavoro è completato quando i nuovi utenti C++ dispongono di una guida dedicata oltre alla documentazione Python.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Where is the C++ library documentation for the advertised library here at the top of the README for this repo?

"CTranslate2 is a C++ and Python library for efficient inference with Transformer models."

You link documentation here for the API(s), then when you visit the link there is only the Python library documentation linked as shown in the included screenshot. Where is the comprehensive C++ library documentation? How are developers supposed to know how to use this library?

For someone new to CTranslate2, “use the examples and read the headers” really isn’t enough to build a real application, especially for more advanced use cases like high-performance speech recognition with Whisper. The examples only cover a few happy-path scenarios and don’t explain the overall design of the library, how different components relate to each other, or recommended patterns for things like batching, streaming, concurrency, memory management, or device/compute configuration. The headers expose a lot of types and options, but without narrative documentation or usage guidance it’s difficult to know which knobs are safe to touch, what defaults are, what is stable vs. internal, or how to compose the pieces correctly for production workloads. As a result, a developer who wants to take advantage of CTranslate2’s performance optimizations in C++ is left guessing about critical behavior, which is risky for correctness and performance. Some dedicated C++ API documentation, even if initially minimal, would go a long way toward making the library approachable and usable beyond the simplest examples.

image

Lingua principale
C++
Stelle
4.8k
Fork
557
Merge medio
1g 6h
PR unite (30g)
24

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenNMT/CTranslate2

Tutte le issue di OpenNMT/CTranslate2

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.