Contributors Guide

This is a reference for contributors to gflownet.

To learn how to use the package itself, see the /tutorial or API Reference.

Tip

Docstrings TL-DR:

Use Numpy-style docstrings as illustrated in this Full Example.

How to write documentation contains a guide on how to write documentation in general AND how to use reStructuredText (which is the text format used in the docstrings).

How to write docstrings contains a guide on how to write docstrings in particular (which requires basic understanding of reStructuredText).

• Coding conventions
  • Python
    • Black
    • Flake8
    • Isort
• How to write documentation
  • Quick Start for Documentation Contributors
  • Building Documentation Locally
  • Overview
    • Learn by example
  • FAQ
  • About Sphinx
• How to write docstrings
  • Basics
  • Full Example
  • So many rules, how can I check?
• Github etiquette
  • Where to learn
  • Typical workflow
• Dev Sanity Check Runs
  • Grid
    • Trajectory Balance loss
    • Flow Matching loss
  • Tetris
    • Trajectory Balance loss
    • Flow Matching loss
  • Continuous Torus as in Lahlou et al (ICML 2023)