TorchEBM Developer Guide¶
Welcome to the developer guide for TorchEBM! This is your central hub for everything you need to know to contribute to the project, understand its architecture, and follow our development best practices.
Whether you're a new contributor or a seasoned developer, these guides are designed to be clear, concise, and easy to follow. Our goal is to make contributing to TorchEBM a smooth and rewarding experience.
A Path to Contribution¶
We've organized our developer documentation to help you get up to speed quickly and efficiently.
-
Your first stop. This guide walks you through setting up your development environment, our contribution workflow, and how to submit your first pull request.
-
Learn about our coding standards, from Python style and API design principles to our philosophy on testing. Essential reading for writing high-quality code.
-
A deep dive into the heart of TorchEBM. Understand our design philosophy, core components, and how they all fit together.
-
Discover how to write high-performance code, leverage GPU acceleration, and other best practices for optimization.
We're thrilled to have you as part of our community and look forward to your contributions!