Add table of issue type info and relevant column name descriptions #1100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
elisno
commented
Apr 17, 2024
Comment on lines
+14
to
+16
| .. include:: table.rst | ||
|
|
||
|
|
There was a problem hiding this comment.
If the table is outside the scope of the PR, it should be enough to just remove this line so it won't appear in the docs.
| @@ -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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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):
