How to read this book

Throughout this book, we maintain the following structure.

Linking

When referring to structures or functions within codebase, we provide permalinks to the lines in specific commits, and indicate them by the relative path of their parent file from the project root. For example this is a reference to the Tensor struct in crates/burn-tensor/src/tensor/api/base.rs

When some reference information is useful but is beyond the scope of contributing to Burn, we provide that information in a footnote. To build on the previous example, the Tensor mentioned is what's referred to as a newtype struct¹.

Direct hyperlinks are for tools and resources that are not part of the Burn project, but are useful for contributing to it. For example, when working on implementing an operation for autodiff, it can be useful to use symbolab to calculate the left and right partial derivatives.