CONTRIBUTING.md

Thank you for your interest in contributing to TorchPipe!

This document (CONTRIBUTING.md) covers some technical aspects of contributing to TorchPipe.

Please feel free to raise an issue, a merge request, or a commit.

Table of Contents

• Developing TorchPipe
• Codebase structure
• Unit testing
  • Python Unit Testing
• Writing documentation

Developing TorchPipe

Follow the instructions for installing TorchPipe from source.

The way to modify the code:

• Submit a merge request to the develop/main branch.

Special requirements for C++：

• All code needs to be exception-safe.
• Avoid manual program termination, but instead replace it with throwing exceptions.

Codebase structure

• examples - examples
• torchpipe - main source
  • csrc - C++ core library for TorchPipe
    • python
    • opencv
    • schedule
    • pipeline
  • utils
• test - Python unit tests for TorchPipe Python frontend.
• .clang-format

Unit testing

Python Unit Testing

cd test
pip install -r requirements.txt 
pytest 

Writing documentation

It is welcome to write documentation.