Skip to content

Requesting a Documentation Issue

Documentation clarity and precision are core pillars of this academic-first deep learning template.

📚 Documentation Issue Guidelines

If you notice typos, unclear docstring examples, broken links, or missing API references:

  1. Identify Page or Module: Note the exact filepath (e.g. docs/how-to-document.md or src/backend/losses/cv.py).
  2. Describe Desired Improvements: Explain how the explanation can be made clearer or more detailed.
  3. Open an Issue or PR: Submit a documentation issue on GitHub Issues or directly submit a pull request!