pymc-devs / pymc-devs/pytensor
Add type hints / documentation for `mode` argument
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 644
- Forks
- 208
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 16
Description
Description
As discussed in https://github.com/pymc-devs/pymc/pull/7212#discussion_r1553967791 it's not clear what the signature / type is.
Besides a Mode object there is a set of strings that are allowed: https://github.com/pymc-devs/pytensor/blob/a76172ee6a9753266150fc7bac4dd66906967a26/pytensor/compile/mode.py#L484-L534
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 pytensor/compile/mode.py, especially lines 484-534, and inspect how the mode argument is defined and accepted. Document or annotate the signature to cover both Mode objects and the allowed strings, then verify that the resulting API description matches those accepted values.
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
- 45/100