Fix domain specification in OrderedLogistic and OrderedProbit documentation #7732
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
OriolAbril
requested changes
May 22, 2025
There was a problem hiding this comment.
Thanks!
Would you mind also updating the parameters section?
cutpoints : tensor_like of array->cutpoints : tensor_like of floatcompute_p: boolean, default Trueneeds a space before the colon as numpydoc requires spaces both before and after the colon that separates name and type of parameters
| from 1 to K as a function of some predictor, :math:`\eta`. The | ||
| from 0 to K-1 as a function of some predictor, :math:`\eta` |
There was a problem hiding this comment.
It looks like you also removed the ". The" part which makes the docstring confusing:
Seems there are eta cutpoints with this updated wording which is not the case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR corrects the domain specification in the documentation of the OrderedLogistic and OrderedProbit distributions. It ensures that the indexing is clearly mentioned as 0-based to avoid errors.
📚 Documentation preview 📚: https://pymc--7732.org.readthedocs.build/en/7732/