How can we make docs better?

[ricardoV94]

The goal of this thread is to collect ideas on how we can make PyTensor docs better.

Suggestions more than welcome

[ricardoV94]

Add sections for different use cases?

• I want to use this library directly for (should I even bother?):

  • Performant code + autodiff
  • Graph features
  • Multi-backend support
  • Math simplification/ reasoning

• Some library I actually care about relies on PyTensor:

  • I guess this is the point I have to know what's under the hood
  • Should I just wrap my existing code in an Op and call it a day?
  • How to debug stuff?

• I'm a developer

  • (There's already lots of good docs)

[ricardoV94]

Add a "Sharp bits" section like JAX does, that explains where behavior deviates from python/numpy most obviously

https://jax.readthedocs.io/en/latest/notebooks/Common_Gotchas_in_JAX.html

• lazy compilation/evaluation
• if/else
• loops
• eq/neq
• set/inc_subtensor
• RandomVariables/updates
• Broadcasting
  ...?