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

Update notebook to reflect the most recent changes #114

Merged
merged 5 commits into from
Nov 16, 2022
Merged

Conversation

andersy005
Copy link
Member

Description of proposed changes

Fixes #

@codecov-commenter
Copy link

codecov-commenter commented Oct 21, 2022

Codecov Report

Merging #114 (21c86d1) into main (f04ad18) will increase coverage by 2.02%.
The diff coverage is n/a.

❗ Current head 21c86d1 differs from pull request most recent head c5d9c3b. Consider uploading reports for the commit c5d9c3b to get more accurate results

@@             Coverage Diff             @@
##             main      #114      +/-   ##
===========================================
+ Coverage   97.97%   100.00%   +2.02%     
===========================================
  Files           5         5              
  Lines         198       192       -6     
  Branches       35        35              
===========================================
- Hits          194       192       -2     
+ Misses          4         0       -4     
Impacted Files Coverage Δ
xbatcher/loaders/torch.py 100.00% <0.00%> (+6.06%) ⬆️
xbatcher/loaders/keras.py 100.00% <0.00%> (+9.52%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @andersy005, thanks for submitting these changes!

Rather than manually updating the notebook to account for changes, I think it would be better to execute the notebook when building the docs through nbsphinx. In addition to automatically keeping it up to date and reducing the number of blob objects in the git history, that should allow us to notice breaking changes easier.

I see that you've made some helpful changes to the cell contents in addition to updating the output. Do you mind clearing the outputs from the notebook, so that we can merge in those changes? I can configure nbsphinx to execute the notebook as a separate PR.

@andersy005
Copy link
Member Author

Sounds good @maxrjones

I'm going to push the changes shortly

Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Anderson!

@maxrjones maxrjones merged commit 20f1e81 into main Nov 16, 2022
@maxrjones maxrjones deleted the update-notebook branch November 16, 2022 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants