Add Docstrings for pymc.dims.distributions.scalar #8041
+34
−0
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
MSK-005
changed the title
Author
|
@ricardoV94, looking forward to your code review. |
ricardoV94
reviewed
Jan 13, 2026
pymc/dims/distributions/scalar.py
Outdated
Comment on lines
207
to
212
| # Get all subclasses of Continuous class | ||
| imported_dists = { | ||
| name: cls | ||
| for name, cls in inspect.getmembers(_regular_dists, inspect.isclass) | ||
| if issubclass(cls, Continuous) and cls is not Continuous | ||
| } |
Member
There was a problem hiding this comment.
Small performance idea: I guess we can get dims_dists first and do a more targetted filter (matches name -> is a subclass of Distribution)?
Member
|
Seems to work for the docs: https://pymcio--8041.org.readthedocs.build/projects/docs/en/8041/api/dims/generated/pymc.dims.HalfCauchy.html |
MSK-005
force-pushed
the
docstrings/7861
branch
from
524a95c to
1958aaa
Compare
MSK-005
force-pushed
the
docstrings/7861
branch
from
1958aaa to
f480347
Compare
ricardoV94
reviewed
Jan 17, 2026
| return super().dist([alpha, beta], **kwargs) | ||
|
|
||
|
|
||
| def create_scalar_dims_docstrings(): |
Member
There was a problem hiding this comment.
Sorry to rethink again.
What if instead we use a decorator on the specific classes or manually do Univariate.__doc__ = foo(regular_dists.Univariate.__doc__)? So we don't need to loop and try to guess what goes with what. This also avoids accidentally overriding custom docstrings if we add them in the future.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR (for #7861) adds a function
create_scalar_dims_docstrings()that copies the docstrings from all relevant classes inpymc.distributions.continuoustopymc.dims.distributions.scalar, replacing "tensor_like" with "xtensor_like" where applicable.Related Issue
Checklist
Type of change