Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

75 lines (53 loc) · 2.48 KB
Raw

Development

Please follow our established coding style including variable names, module imports, and function definitions. The NumPyro codebase follows the PEP8 style guide (which you can check with make lint) and follows isort import order (which you can enforce with make format).

Setup

To set up local development environment, install NumPyro from source:

git clone https://github.com/pyro-ppl/numpyro.git
# install jax/jaxlib first for CUDA support
pip install -e .[dev,test,doc,examples]  # contains additional dependencies for NumPyro development

For running make doctest, install pandoc.

Testing

Before submitting a pull request, please autoformat code and ensure that unit tests pass locally

make lint              # linting
make format            # runs black and isort
make test              # linting and unit tests
make doctest           # test module's docstrings

To run all tests locally in parallel, use the pytest-xdist package

pip install pytest-xdist
pytest -vs -n auto

To run a single test from the command line

pytest -vs {path_to_test}::{test_name}
# or in cuda mode and double precision
JAX_PLATFORM_NAME=gpu JAX_ENABLE_X64=1 pytest -vs {path_to_test}::{test_name}

Pre-Commit Hooks

For local development we recommend using pre-commit hooks to automatically format your code before committing.

To install pre-commit hooks, run

pip install pre-commit
pre-commit install

After each commit, pre-commit will run and verify that your code is formatted correctly. The pre-commit hooks can be skipped by adding the --no-verify flag to your git commit command.

Profiling

TensorBoard can be used to profile NumPyro following the instructions following JAX documentation.

Submitting

For relevant design questions to consider, see past design documents.

For larger changes, please open an issue for discussion before submitting a pull request.

In your PR, please include:

  • Changes made
  • Links to related issues/PRs
  • Tests
  • Dependencies

If you add new files, please run make license to automatically add copyright headers.

For speculative changes meant for early-stage review, include [WIP] in the PR's title. (One of the maintainers will add the WIP tag.)