Documentation: goals, examples, and working with skills

Aperta
#14 3 commenti 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
32/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
jupyter-notebook, plotly, python

Direzione di ricerca

Inizia esaminando la documentazione esistente del progetto e i file di skills della issue #12. Suddividi il lavoro in una landing page, esempi orientati ai professionisti con grafici interattivi e una guida all’uso dei file di skills con un LLM. Il lavoro è completato quando queste aree sono documentate e le questioni aperte relative agli esempi e agli strumenti di plotting sono state risolte.

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

Descrizione

roadmap

ptgp needs documentation. The docs are aimed at human readers, not LLMs. The skills files (#12) are for LLMs.

What ptgp is and what it's for

A landing page that describes the goal of the library, who it's for, and how it's different from other GP libraries.

Examples

Canonical textbook problems and/or real-world examples with interesting datasets. These should be:

  • Short and not exhaustive, given the fact that our attention spans have been completely ruined
  • Focused on real-world problems where GPs are underused, not just toy regression on a sine wave
  • Have attractive, interactive plots
  • Don't go into the weeds of every utility and helper

The examples can be pedagogical, but should go beyond "What is a GP?". There are already many good places to learn that and experiment with basic GPs. The examples should be aligned with the goals of ptgp: for practitioners trying to apply GPs to tricky problems.

Ideas

  • Decision theory with GP predictive distributions — Rasmussen & Williams Ch. 2.4. GPs give you a full predictive distribution, not just a point estimate. With an asymmetric loss function (e.g. overestimating is much more costly than underestimating), the optimal prediction shifts away from the mean and you need the full distribution to compute it. This comes up constantly in practice (finance, safety, inventory) and is an example I really like. It'd be cool to show how to do this with ptgp on a believable problem and should show off pytensors usefulness too.

Working with skills files

A guide for using ptgp with an LLM via the skills files (see #12). How to install them, what they cover, how to use them to plan and debug a modeling problem interactively.

Open questions

  • What would be some cool ideas for docs? What are your favorite existing GP examples?
  • What plotting libraries / tools for interactive plots? (Plotly, Bokeh, etc.)
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.