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

Add docstring for sigma and other objects. #14

Open
codetalker7 opened this issue Jul 4, 2022 · 3 comments
Open

Add docstring for sigma and other objects. #14

codetalker7 opened this issue Jul 4, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@codetalker7
Copy link
Member

This is in conjunction with PR #12. Currently the PR does not contain any docstring for the sigma getter function in src/frequentist/getter.jl. This function is not in StatsAPI.jl either, we'll have to add our own docstring to it, describing what it does.

@codetalker7 codetalker7 changed the title Add docstring for sigma. Add docstring for sigma and other objects. Jul 4, 2022
@codetalker7
Copy link
Member Author

While we're on the subject, a lot of improvements in the documentation can be made. Roughly the following comes to mind as of now.

  1. Add documentation for priors (currently we don't have any docstrings for those).
  2. Add more documentation describing the models.
  3. In relation to 2), add more documentation mathematically describing the bayesian models, eg. what are the prior distributions, how is inference done etc.

Currently the docstrings for everything are quite general and don't explain the specifics of the models.

@sourish-cmi
Copy link
Collaborator

The Bayesian code with Turing.jl is a great extent, self-explanatory. We can directly take the code-piece and make it part of the doc

@sourish-cmi sourish-cmi added the documentation Improvements or additions to documentation label Sep 7, 2022
@codetalker7
Copy link
Member Author

I see. On a side note, it will be better to write the models in LaTeX instead of Julia code, no?

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

No branches or pull requests

3 participants