Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (38 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.22 KB

Contributing Guide

Thanks for contributing to PyTorch Training Inspector.

Development Setup

  1. Clone the repository.
  2. Create a virtual environment.
  3. Install dependencies:
pip install -r requirements.txt
pip install -e .[dev]

Code Quality

Run these checks before opening a pull request:

python -m pytest -v
python -m black --check .
python -m isort --check-only .
python -m mypy inspector

Pull Request Expectations

  • Keep PRs focused and well-scoped.
  • Add or update tests for behavioral changes.
  • Update documentation when APIs or behavior change.
  • Include a clear summary of motivation, approach, and validation.

Commit Message Convention

Use imperative, concise messages, for example:

  • Add OOM detector lookahead calibration
  • Fix gradient hook cleanup in edge case
  • Document dashboard export workflow

Reporting Bugs

Open a GitHub issue with:

  • Exact reproduction steps
  • Expected vs observed behavior
  • Environment details (python, torch, OS, GPU)
  • Minimal reproducible snippet if possible

Security Issues

Do not open public issues for sensitive vulnerabilities. See SECURITY.md.

Code of Conduct

All contributors are expected to follow CODE_OF_CONDUCT.md.