pymc-devs / pymc-devs/ptgp

How to cite and reference prior work

Open
#10 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
8
Forks
4
Avg merge
2d 2h
Merged PRs (30d)
4

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the docstrings and documentation for objectives and models such as collapsed_elbo and FourierFeatures1D, then compare how the issue's proposed citation patterns would surface research to users. Done means agreeing on a citation approach and documenting the resulting references or documentation structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.