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

plot_cap example for docs #670

Merged
merged 7 commits into from
May 15, 2023
Merged

Conversation

GStechschulte
Copy link
Collaborator

This draft PR addresses #667 by adding an explicit plot_cap notebook in the docs/notebooks/ directory. The objective of this notebook is to show how to use, and the capabilities, of the plot_cap function. Additionally, there will be sections on why such tooling is needed for GLMs (generally speaking), and what is happening on the backend to produce the plot_cap plots.

This is a work in progress, and at the moment, I only have a draft outline for the doc example. Nonetheless, examples will be taken from this Gist.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tomicapretto
Copy link
Collaborator

@GStechschulte feel free to let me know when you need a review :)

@GStechschulte GStechschulte marked this pull request as ready for review May 9, 2023 13:56
@GStechschulte
Copy link
Collaborator Author

@GStechschulte feel free to let me know when you need a review :)

Just marked as ready for review. Thanks!

docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
@tomicapretto
Copy link
Collaborator

@GStechschulte the example is in very very good shape. I love the amount of detail. We just need to round out some explanations and perhaps add a couple more. But in general this is great and almost ready to be merged. Thanks a lot!

@GStechschulte
Copy link
Collaborator Author

GStechschulte commented May 10, 2023

@tomicapretto Thank you, and thanks for the quick and detailed feedback. You can find my comments to your reviews in this PR or in the ReviewNB

@GStechschulte GStechschulte changed the title plot_cap draft outline for docs example plot_cap example for docs May 10, 2023
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
docs/notebooks/plot_cap.ipynb Show resolved Hide resolved
@tomicapretto
Copy link
Collaborator

@GStechschulte looks even better now. There are one or two points and then we're done. We can chat about them in our call today. Thanks!

@GStechschulte
Copy link
Collaborator Author

Again, thanks for the detailed comments @tomicapretto. I have incorporated these points into the latest commit.

@tomicapretto
Copy link
Collaborator

@GStechschulte it's good to be merged, thanks for the great work!

But there's a final to do 😅. See the conflict with the notebook file. Do you know how to fix it?

@codecov-commenter
Copy link

codecov-commenter commented May 14, 2023

Codecov Report

Merging #670 (18a7d6b) into main (743001f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #670   +/-   ##
=======================================
  Coverage   87.95%   87.95%           
=======================================
  Files          40       40           
  Lines        2665     2665           
=======================================
  Hits         2344     2344           
  Misses        321      321           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@GStechschulte
Copy link
Collaborator Author

Thanks @tomicapretto! Looks like we are good to go now 😄

@tomicapretto tomicapretto merged commit f994df0 into bambinos:main May 15, 2023
4 checks passed
@GStechschulte GStechschulte deleted the plot-cap-example branch July 20, 2023 08:13
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

Successfully merging this pull request may close these issues.

None yet

3 participants