Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines.

Development Setup

  1. Fork the repository: Create your own fork of the repository on GitHub.

  2. Clone your fork: 

    git clone https://github.com/YOUR_USERNAME/denoising-diffusion-pytorch.git
cd denoising-diffusion-pytorch

  3. Install in editable mode: Install the package and its dependencies in editable mode. It's recommended to do this in a virtual environment. 

    python -m venv venv
source venv/bin/activate
pip install -e .

Making Changes

  1. Create a new branch: 

    git checkout -b your-feature-branch

  2. Make your changes: Add your new feature, fix a bug, or improve the documentation.

  3. Code Style: Please format your code using a standard formatter like black to maintain consistent code style. 

    pip install black
black .

  4. Testing: If you add a new feature, please also add corresponding tests. (Note: A testing suite is not yet formally established, but contributions in this area are highly encouraged).

Submitting a Pull Request

  1. Commit your changes: 

    git commit -m "feat: Add awesome new feature"

  2. Push to your fork: 

    git push origin your-feature-branch

  3. Open a Pull Request: Go to the original repository on GitHub and open a pull request from your fork. Provide a clear description of the changes you've made.