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 CI check that .ipynb outputs are empty #169

Merged
merged 1 commit into from
Apr 5, 2022

Conversation

anishathalye
Copy link
Member

Fixes #168

Preserving the output cells in Jupyter notebooks that are checked in to
this repo bloat the repo size, and keeping the output is not necessary
because the notebooks are run as part of the CI for producing docs.

For example, in cleanlab#165, the
`audio.ipynb` is 112K (and now part of the repo history forever), while
clearing the output cells reduces that size down to 24K. I suspect that
Git's delta compression will also work better without the output cells
there as we make changes to the notebook. Also, the diffs will be more
readable.
@codecov
Copy link

codecov bot commented Apr 5, 2022

Codecov Report

Merging #169 (6cac342) into master (080c7a8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #169   +/-   ##
=======================================
  Coverage   87.64%   87.64%           
=======================================
  Files          12       12           
  Lines        1028     1028           
  Branches      194      194           
=======================================
  Hits          901      901           
  Misses        104      104           
  Partials       23       23           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 080c7a8...6cac342. Read the comment docs.

@@ -358,7 +358,7 @@
"hash": "ced20e3e49bb4fa4ce8ad38f8f2535b7fc4c39b2b89554502b5dbdad1ad67eda"
},
"kernelspec": {
"display_name": "Python 3.10.0 64-bit",
"display_name": "Python 3 (ipykernel)",
Copy link
Member

Choose a reason for hiding this comment

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

just highlighting this in case it's unintentional

@@ -372,7 +372,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.10"
"version": "3.9.10"
Copy link
Member

Choose a reason for hiding this comment

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

just highlighting this in case it's unintentional

Copy link
Member

@jwmueller jwmueller left a comment

Choose a reason for hiding this comment

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

LGTM, great call on this!

@anishathalye anishathalye merged commit f59acf8 into cleanlab:master Apr 5, 2022
@anishathalye anishathalye deleted the notebooks-empty branch April 7, 2022 11:45
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.

Add CI to ensure that Jupyter notebooks don't include output
2 participants