How to cite and reference prior work

Aperta
#10 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

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
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia esaminando i docstring e la documentazione relativi a obiettivi e modelli come collapsed_elbo e FourierFeatures1D, quindi confronta come i modelli di citazione proposti nell’issue renderebbero la ricerca visibile agli utenti. Il lavoro è considerato concluso quando è stato concordato un approccio alle citazioni e sono stati documentati i riferimenti risultanti o la struttura della documentazione.

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

Descrizione

roadmap

ptgp borrows heavily from existing GP libraries (GPflow, GPJax, GPyTorch) and from the papers behind the methods. One of the goals of the library is to make GPs more accessible to practitioners, and part of that is making it easy for users to learn more about the modeling choices they're making.

This is especially important now that AI coding tools are generating code that uses these methods. Users should be able to trace back from the code to the underlying research.

What's the best way to surface references and citations?

Some options:

  • Docstrings on objectives/models — e.g. collapsed_elbo could cite Titsias (2009), FourierFeatures1D could cite Hensman, Durrande, Solin (2017). Short and close to where the user is working.
  • A references page in documentation — a central bibliography that docstrings can point to. Keeps docstrings clean but adds a layer of indirection.
  • Inline comments in the code — e.g. "# See Eq. 3.12 in Rasmussen & Williams (2006)". Useful for implementers but not visible to users who only read docs.
  • A "learn more" pattern — each model/objective/kernel class has a references attribute or a section in its docstring with a short reading list.

These aren't mutually exclusive. What combination would be most useful?

Lingua principale
Jupyter Notebook
Stelle
15
Fork
5
Merge medio
2g 10h
PR unite (30g)
5

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 pymc-devs/ptgp

Tutte le issue di pymc-devs/ptgp

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.