Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 2.66 KB

contributing to dask-pytorch-ddp

This document contains details on contributing to dask-pytorch-ddp.

Documentation

This repository is the main source of documentation for dask-pytorch-ddp. If you would like to request a feature, report a bug, or ask a question of the maintainers, please create an issue.

For general documentation on Saturn Cloud and its components, please visit https://docs.saturncloud.io/en/.

Installation

To develop dask-pytorch-ddp, install it locally with the following command

python setup.py develop

NOTE: If you have previously pip install'd dask-pytorch-ddp, some steps in this project might not work for you. Run pip uninstall -y dask-pytorch-ddp to remove any pip install'd versions.

Testing

Every commit to this repository is tested automatically using continuous integration (CI). All CI checks must pass for a pull request to be accepted.

To try running the tests locally, run the following:

make test

Linting

dask-pytorch-ddp uses the following static analysis tools:

  • black
  • flake8
  • mypy
make format
make lint

Unit tests

Unit tests for the project use pytest and pytest-cov. All tests are stored in the tests/ directory.

make unit-tests

The unit-tests recipe in Makefile includes a minimum code coverage threshold. All pull requests must pass all tests with more than this level of code coverage. The current coverage is reported in the results of make unit-tests.

Integration tests

dask-pytorch-ddp's unit tests mock out its interactions with the rest of Saturn Cloud. Integration tests that test those interactions contain some sensitive information, and are stored in a private repository.

If you experience issues using dask-pytorch-ddp and Saturn Cloud, please see the Saturn documentation or contact us at by following the Contact Us navigation at https://www.saturncloud.io/s.

Releasing

This section describes how to release a new version of dask-pytorch-ddp to PyPi. It is intended only for maintainers.

  1. Open a new pull request which bumps the version in VERSION. Merge that PR.
  2. Create a new release
    • the tag should be a version number, like v0.0.1
    • choose the target from "recent commits", and select the most recent commit on main
  3. Once this release is created, a GitHub Actions build will automatically start. That build publishes a release to PyPi.