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

FAQ: Methods that can be sped up with low_memory=True #869

Merged
merged 5 commits into from
Oct 11, 2023

Conversation

tataganesh
Copy link
Contributor

@tataganesh tataganesh commented Oct 9, 2023

Summary

In the FAQ, include methods that support speed up using the low_memory=True option.

Impact

Improve documentation for users to leverage memory efficient computation for classification tasks.

Testing

Documentation Screenshot:
image

Ticket(s) or Conversations

Fixes #855

References

N/A

@tataganesh tataganesh changed the title Document methods supporting low memory option FAQ: Methods that can be sped up with low_memory=True Oct 9, 2023
@codecov
Copy link

codecov bot commented Oct 9, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (bd32f11) 96.70% compared to head (c706a42) 96.70%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #869   +/-   ##
=======================================
  Coverage   96.70%   96.70%           
=======================================
  Files          65       65           
  Lines        5091     5091           
  Branches      875      875           
=======================================
  Hits         4923     4923           
  Misses         86       86           
  Partials       82       82           

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

Comment on lines 281 to 283
"1. [classification.CleanLearning](https://docs.cleanlab.ai/stable/cleanlab/classification.html?highlight=cleanlearning#cleanlab.classification.CleanLearning)\n",
"2. [multilabel_classification.filter.find_label_issues](https://docs.cleanlab.ai/stable/cleanlab/multilabel_classification/filter.html#cleanlab.multilabel_classification.filter.find_label_issues)\n",
"3. [token_classification.filter.find_label_issues](https://docs.cleanlab.ai/stable/cleanlab/token_classification/filter.html?highlight=token#cleanlab.token_classification.filter.find_label_issues)"
Copy link
Member

Choose a reason for hiding this comment

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

all links should be relative links, see instructions on how to achieve this here:

https://github.com/cleanlab/cleanlab/blob/master/DEVELOPMENT.md#relative-link-formatting-instructions

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.

Great work!

@jwmueller jwmueller merged commit 55b8389 into cleanlab:master Oct 11, 2023
21 checks passed
@tataganesh tataganesh deleted the low_memory_docs branch October 11, 2023 15:34
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.

clarify in FAQ what methods can be sped up via: low_memory = True
2 participants