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

GaussianProcess docstring would benefit from enhancements #39

Open
mrtommyb opened this issue May 18, 2021 · 2 comments
Open

GaussianProcess docstring would benefit from enhancements #39

mrtommyb opened this issue May 18, 2021 · 2 comments

Comments

@mrtommyb
Copy link

There is an inconsistency between the celerite2 Getting Started tutorial and the Exoplanet tutorials in the use of GaussianProcess and compute. Specifically, in the celerite2 tutorial compute is called explicitly but in the Exoplanet tutorials that include celerite2, compute is implicitly called through supplying the t keyword.

I don't think this is a particular problem, but it would be good if the main GaussianProcess docstring stated that if t is supplied then the compute method is automatically run.

In addition, the theano.GaussianProcess class doesn't have a docstring so this would benefit from having the same docstring as the main GaussianProcess class, also with the addition of the note about compute.

@mrtommyb
Copy link
Author

I would be happy to make these changes and submit a pull request, if that would be useful and you agree these changes are a good idea.

@dfm
Copy link
Member

dfm commented May 18, 2021

Sure - that would be awesome! Thanks Tom!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants