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

write more comments before lines in example notebooks #9

Open
pmcdonal opened this issue Jan 30, 2023 · 0 comments
Open

write more comments before lines in example notebooks #9

pmcdonal opened this issue Jan 30, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pmcdonal
Copy link
Member

E.g., in fisher_planck.ipynb, there is a line
fisher_clik = Fisher(likelihood_clik)
which takes quite a bit of time and looks like it might be doing derivatives, but at the end there is, e.g., no "precision" set so I guess not. Then the line
precision_clik = fisher_clik()
takes a longer time (printing nothing), where now I understand it must be doing the real calculation.
(I took the change to 3.044 out in case this was forcing recalculation, before realizing I could check that no "precision" was set before)

So I am curious what the first line was doing, but the more general comment is that a lot more comments in the notebooks would help really understand what is going on. (I'd like to just read through code path/step through in debugger... but I haven't had great luck with that)

@pmcdonal pmcdonal added the documentation Improvements or additions to documentation label Jan 30, 2023
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

1 participant