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

Fix edit data fn expansion cell formatting #1177

Merged
merged 4 commits into from
Jul 18, 2024

Conversation

mturk24
Copy link
Contributor

@mturk24 mturk24 commented Jul 17, 2024

Summary

Quick fix to cell that shows expansion of edit_data function to make Python function render properly in docs. Screenshot shows what current docs show: https://docs.cleanlab.ai/master/tutorials/improving_ml_performance.html

Screenshot 2024-07-17 at 2 01 30 PM

@mturk24 mturk24 requested a review from elisno July 17, 2024 18:02
Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.70%. Comparing base (e4be990) to head (b91cd1c).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1177      +/-   ##
==========================================
+ Coverage   96.63%   96.70%   +0.07%     
==========================================
  Files          81       81              
  Lines        5935     5940       +5     
  Branches     1021      954      -67     
==========================================
+ Hits         5735     5744       +9     
+ Misses        110      108       -2     
+ Partials       90       88       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

" ```python\n",
" # Note: This pulldown content is for docs.cleanlab.ai, if running on local Jupyter or Colab, please ignore it.\n",
"```python\n",
"# Note: This pulldown content is for docs.cleanlab.ai, if running on local Jupyter or Colab, please ignore it.\n",
" \n",
" def edit_data(train_features, train_labels, label_issues, near_duplicates, outliers, drop_label_issue, drop_near_duplicate, drop_outlier):\n",
Copy link
Member

Choose a reason for hiding this comment

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

@mturk24 why is this other part all still indented?

And where is your screenshot showing how this fixed the docs build?

Copy link
Member

Choose a reason for hiding this comment

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

I can review this, no need for Elias

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied suggested edit, and rebuilt docs locally

Screenshot 2024-07-17 at 10 48 05 PM

When building I had set

nbsphinx_allow_errors = True

in conf.py so that's potentially why I still saw the correctly built docs when the python ``` and
were out of order?

Copy link
Member

Choose a reason for hiding this comment

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

weird i'm not sure what happened there

@jwmueller jwmueller removed the request for review from elisno July 18, 2024 01:07
@mturk24
Copy link
Contributor Author

mturk24 commented Jul 18, 2024

Screenshot 2024-07-17 at 10 14 39 PM

Confirming the latest commit has the fix when building docs locally @jwmueller and has the indentation fix

Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com>
@jwmueller jwmueller merged commit f96261d into master Jul 18, 2024
38 checks passed
@jwmueller jwmueller deleted the fix-clos-train-test-tutorial-cell branch July 18, 2024 02:53
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.

2 participants