Reference¶
The Reference section is for looking things up once you know roughly what you need: a function signature, a command-line flag, the default value of a setting, the meaning of a word, or whether an upgrade will break your code. Pages here are tables and definitions with little explanation. If you are trying to understand why the library behaves as it does, the Concepts section explains it; if you want to do something step by step, the How-to guides are the place.
Which page to open¶
| You want to… | Open |
|---|---|
| Find the function or class for a task, and its exact signature | API reference |
Know what grounded-decision commands and flags exist, and read their output |
Command line |
Look up a default (alpha, the margin, a size cap) and when to change it |
Defaults and limits |
| Know what you can import, what the record format promises, and what counts as a breaking change | Stability and versioning |
| Look up a word (abstain, neighbour agreement, support, Lean, …) | Glossary |
| Get a straight answer to a common question ("do I need Lean?", "how small can my graph be?") | FAQ |
| See what changed between versions | Changelog |
How these pages relate¶
- The API pages are generated from docstrings in
src/, so they always match the installed code. Each starts with a short paragraph saying what the module is for. - Defaults and limits explains every field of
Limitsin words; the API page for Performance shows the same fields as code. - Stability and versioning is the contract. If it and another page disagree, the contract and the tests win; please report the disagreement.
- The Glossary gives each term a plain definition, the field or function name it corresponds to, and a link to the page that explains it. Every other page in this site links words to it.
- The FAQ answers the questions evaluators ask first, briefly, and links to the full explanation.