Skip to content

Clarified 0-based indexing requirement for OrderedLogistic and OrderedProbit #7457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2024

Conversation

kdotmanoj
Copy link
Contributor

@kdotmanoj kdotmanoj commented Aug 14, 2024

…dProbit in discrete.rst

Description

This pull request updates the discrete.rst documentation to clarify the requirement for 0-based indexing in the OrderedLogistic and OrderedProbit distribution entries. This addition aims to help users understand that these distributions expect 0-based indexing for their input data, which is crucial for correct implementation and usage

Related Issue

Checklist

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • Maintenance
  • Other (please specify):

📚 Documentation preview 📚: https://pymc--7457.org.readthedocs.build/en/7457/

Copy link

welcome bot commented Aug 14, 2024

Thank You Banner]
💖 Thanks for opening this pull request! 💖 The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

@kdotmanoj
Copy link
Contributor Author

@twiecki can you please review this :)

@kdotmanoj
Copy link
Contributor Author

Hi @twiecki,

Thank you for reviewing the PR! I wanted to check if you know when it might be merged.

Thanks!

@twiecki twiecki merged commit 747fda3 into pymc-devs:main Aug 15, 2024
10 checks passed
Copy link

welcome bot commented Aug 15, 2024

Congratulations Banner]
Congrats on merging your first pull request! 🎉 We here at PyMC are proud of you! 💖 Thank you so much for your contribution 🎁

@twiecki
Copy link
Member

twiecki commented Aug 15, 2024

Thanks!

@ricardoV94
Copy link
Member

ricardoV94 commented Aug 29, 2024

This shouldn't be in discrete.rst but in the docs of the OrderedLogistic/Probit functions.
image

Also as @AllenDowney mentioned the description of the distributions are themselves wrong:

from 1 to K as a function of some predictor, :math:`\eta`. The

vandalt pushed a commit to vandalt/pymc that referenced this pull request May 14, 2025
…dProbit (pymc-devs#7457)

* Clarified 0-based indexing requirement for OrderedLogistic and OrderedProbit in discrete.rst

* Fix end of file issue in discrete.rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Slightly more clarification about the expected target value indexing of pymc.OrderedLogistic
3 participants