pymc-devs / pymc-devs/pytensor
DOC: Debugging flag usage is not described well
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 644
- Forks
- 208
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 16
Description
Issue with current documentation:
The debugging FAQ states that:
Using the PyTensor flag optimizer=fast_compile or optimizer=None can often tell you the faulty line, while exception_verbosity=high will display a debug print of the apply node.
But nowhere in the FAQ is there any information about how to actually use such flags.
In addition, the "code" specified in these examples appears to be incorrect in that None and high must actually be strings (more obvious that high must be a string, but None looks like python's None rather than the string "None").
Idea or request for content:
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the debugging FAQ at pytensor.readthedocs.io/en/latest/tutorial/debug_faq.html and review the existing optimizer and exception_verbosity examples. Document how to use these flags and clarify that None and high are string values, with the completed FAQ providing accurate, actionable examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100