Skip to content
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

DOC: Documentation for pymc.math.concatenate refers to join which is not documented. #648

Open
DrEntropy opened this issue Feb 16, 2024 · 0 comments
Labels

Comments

@DrEntropy
Copy link

Issue with current documentation:

https://www.pymc.io/projects/docs/en/stable/api/generated/pymc.math.concatenate.html which is based on the docstring for pytensor.math.concatenate says :

Alias for `join`(axis, *tensor_list).

This function is similar to `join`, but uses the signature of
numpy's concatenate function.

This is not very helpful, because join is not documented as far as I can determine.

Idea or request for content:

I suggest instead that the docstring be based on the documentation at
https://pytensor.readthedocs.io/en/latest/library/tensor/basic.html#pytensor.tensor.concatenate

@DrEntropy DrEntropy added the docs label Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant