Contributing¶
probly is in early development and contributions are welcome — a bug
report, a missing backend for a method that already exists, or a method that is
not in the library yet.
This part of the documentation has four entry points. Contributing Guidelines covers the process: what we are looking for, how to set up a development environment, and the style rules a pull request has to satisfy. Adding a New Method is the concrete recipe for the most common contribution, walking a fictional method from an empty package to a gallery example. Why the Stages Compose explains the dispatch design that a new method plugs into, and why a method only has to implement the first of the four core pillars. Finally, JAX Representations documents the operator and validation machinery behind the JAX representation types.
- Contributing Guidelines
- Adding a New Method
- What is a method?
- Anatomy of a method
- Step 1: Write the backend-agnostic core (
_common.py) - Step 2: Implement the backends (
torch.py,flax.py, …) - Step 3: Wire up lazy registration (
__init__.py) - Step 4: Export the method
- Step 5: Add the reference
- Step 6: Write tests
- Step 7: Add a gallery example
- Step 8: List the method in the README
- Step 9: Quality checks
- Checklist
- Why the Stages Compose
- JAX Representations