Contributing to TensorPlay

We want to make contributing to TensorPlay as easy and transparent as possible.

Development Process

1. Fork the repository: Click the 'Fork' button on the repository page.
2. Clone your fork:

   git clone https://github.com/your-username/tensorplay.git
   cd tensorplay

3. Create a branch:

   git checkout -b my-new-feature

4. Make your changes: Implement your feature or fix.
5. Run tests: Ensure all tests pass.

   pytest test/

6. Commit your changes:

   git commit -am 'Add some feature'

7. Push to the branch:

   git push origin my-new-feature

8. Submit a Pull Request: Go to the original repository and create a Pull Request.

Coding Style

• We follow PEP 8 for Python code.
• We use Google C++ Style Guide for C++ code.
• Python code should be typed using type hints where possible.
• Use black for Python formatting and clang-format for C++.

Building from Source

Prerequisites

• Python 3.9+
• CMake 3.18+
• C++17 compatible compiler (MSVC on Windows, GCC/Clang on Linux/macOS)
• CUDA Toolkit (optional, for GPU support)

Installation

pip install -r requirements.txt
python setup.py install

Or for development (editable install):

pip install -e .

Running Tests

We use pytest for testing.

# Run all tests
pytest

# Run specific test file
pytest test/test_tensor_basic.py

Documentation

Documentation is built using Sphinx.

cd docs
pip install -r requirements.txt
make html

The generated HTML files will be in docs/_build/html.

License

By contributing, you agree that your contributions will be licensed under its Apache 2.0 License.