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 text classification tutorial #154

Merged
merged 1 commit into from
Apr 5, 2022

Conversation

weijinglok
Copy link
Contributor

This PR introduces the text classification tutorial for the docs site.

This tutorial has been reviewed by @jwmueller offline.

@weijinglok weijinglok added this to the Cleanlab 2.0 milestone Apr 1, 2022
@codecov
Copy link

codecov bot commented Apr 1, 2022

Codecov Report

Merging #154 (d6fbff0) into master (3f17be6) will not change coverage.
The diff coverage is n/a.

❗ Current head d6fbff0 differs from pull request most recent head 8c28c51. Consider uploading reports for the commit 8c28c51 to get more accurate results

@@           Coverage Diff           @@
##           master     #154   +/-   ##
=======================================
  Coverage   87.64%   87.64%           
=======================================
  Files          12       12           
  Lines        1028     1028           
  Branches      191      194    +3     
=======================================
  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 3f17be6...8c28c51. Read the comment docs.

@jwmueller
Copy link
Member

We should standardize the tutorial filenames as well. I vote for the following names, can you update them if you agree?

image_quickstart_tutorial.ipynb
text_quickstart_tutorial.ipynb
tabular_quickstart_tutorial.ipynb

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.

already edited offline

@anishathalye
Copy link
Member

Following up from #163: I think the path notebooks/{modality}_quickstart_tutorial is unnecessarily long. How about something like quickstart/{modality} or tutorials/{modality}?

@weijinglok
Copy link
Contributor Author

Following up from #163: I think the path notebooks/{modality}_quickstart_tutorial is unnecessarily long. How about something like quickstart/{modality} or tutorials/{modality}?

Done!

@jwmueller
Copy link
Member

Following up from #163: I think the path notebooks/{modality}_quickstart_tutorial is unnecessarily long. How about something like quickstart/{modality} or tutorials/{modality}?

This will not work long-term IMO. Eg. There can be multiple tutorials about image, such as: image_quickstart, image_indepth, etc.

@weijinglok For this PR, your rename to tutorials/image.ipynb is fine with me. But we'll need to revisit it in the future when more tutorials are added.

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!

@jwmueller jwmueller merged commit 1f60745 into cleanlab:master Apr 5, 2022
@weijinglok weijinglok deleted the add-text-tut branch April 5, 2022 04:50
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