Add table of issue type info and relevant column name descriptions #1100
Conversation
Allows to refer to sections by their title.
…red arguments Includes small notes for edge cases.
These doctests are not executed by CI at this moment, but the usage example show where the relevant cleanlab columns are found.
| @@ -56,6 +59,80 @@ To handle mislabeled examples, you can either filter out the data with label iss | |||
|
|
|||
| Learn more about the method used to detect label issues in our paper: `Confident Learning: Estimating Uncertainty in Dataset Labels <https://arxiv.org/abs/1911.00068>`_ | |||
|
|
|||
| .. testsetup:: * | |||
There was a problem hiding this comment.
This testsetup block will be executed for all doctests blocks (..testcode), they just won't run the doctest until we set it up in CI.
There was a problem hiding this comment.
These testsetup cells are not visible in the docs.
| @@ -46,6 +46,7 @@ | |||
| "sphinx.ext.napoleon", | |||
| "nbsphinx", | |||
| "sphinx.ext.autodoc", | |||
| "sphinx.ext.autosectionlabel", | |||
There was a problem hiding this comment.
This is added to allow us to link to local section headings.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1100 +/- ##
==========================================
- Coverage 96.18% 96.03% -0.15%
==========================================
Files 76 80 +4
Lines 5996 6074 +78
Branches 992 1003 +11
==========================================
+ Hits 5767 5833 +66
- Misses 135 142 +7
- Partials 94 99 +5 ☔ View full report in Codecov by Sentry. |
| @@ -0,0 +1,186 @@ | |||
| .. tabs:: | |||
|
|
|||
| .. tab:: Classification task | |||
There was a problem hiding this comment.
opened another TODO related to this table:
#1133
But can save for the future
Addresses #1081
This PR improves the Datalab Issue Types guide.
It adds a table for the different tasks that Datalab supports. It lists out the
issue_typesargument inDatalab.find_issues().Datalab.issuesdataframe.Datalab.find_issues()are required to successfully run the issue check.Here's a screenshot of the table (still WIP):
