list_possible_issue_types as _list_possible_issue_types ,
)
from cleanlab.datalab.internal.serialize import _Serializer
+from cleanlab.datalab.internal.task import Task
if TYPE_CHECKING : # pragma: no cover
import numpy.typing as npt
@@ -609,7 +611,11 @@ Source code for cleanlab.datalab.datalab
task : str
The type of machine learning task that the dataset is used for.
- By default, this is set to "classification", but you can also set it to "regression" if you are working with a regression dataset.
+
+ Supported tasks:
+ - "classification" (default): Multiclass classification
+ - "regression" : Regression
+ - "multilabel" : Multilabel classification
label_name : str, optional
The name of the label column in the dataset.
@@ -640,17 +646,11 @@ Source code for cleanlab.datalab.datalab
image_key : Optional [ str ] = None ,
verbosity : int = 1 ,
) -> None :
- self . _validate_task ( task )
# Assume continuous values of labels for regression task
# Map labels to integers for classification task
- map_labels_to_int = task == "classification" # TODO: handle more generally
- is_multilabel = task == "multilabel"
-
- self . _data = Data (
- data , label_name , map_to_int = map_labels_to_int , is_multilabel = is_multilabel
- )
+ self . task = Task . from_str ( task )
+ self . _data = Data ( data , self . task , label_name )
self . data = self . _data . _data
- self . task = task
self . _labels = self . _data . labels
self . _label_map = self . _labels . label_map
self . label_name = self . _labels . label_name
@@ -661,7 +661,7 @@ Source code for cleanlab.datalab.datalab
# Create the builder for DataIssues
builder = _DataIssuesBuilder ( self . _data )
- builder . set_imagelab ( self . _imagelab ) . set_task ( task )
+ builder . set_imagelab ( self . _imagelab ) . set_task ( self . task )
self . data_issues = builder . build ()
# todo: check displayer methods
@@ -671,13 +671,6 @@ Source code for cleanlab.datalab.datalab
def __str__ ( self ) -> str :
return _Displayer ( data_issues = self . data_issues ) . __str__ ()
- def _validate_task ( self , task : str ) -> None :
- """Validates the task parameter passed to the Datalab constructor."""
- _valid_tasks = [ "classification" , "regression" , "multilabel" ]
- if task not in _valid_tasks :
- error_msg = f "Invalid task: { task } . Datalab only supports { _valid_tasks } ."
- raise ValueError ( error_msg )
-
@property
def labels ( self ) -> Union [ np . ndarray , List [ List [ int ]]]:
"""Labels of the dataset, in a [0, 1, ..., K-1] format."""
diff --git a/master/_modules/cleanlab/datalab/internal/data.html b/master/_modules/cleanlab/datalab/internal/data.html
index 405cbacb1..948704e75 100644
--- a/master/_modules/cleanlab/datalab/internal/data.html
+++ b/master/_modules/cleanlab/datalab/internal/data.html
@@ -238,6 +238,7 @@
report
+
task
@@ -547,6 +548,8 @@
Source code for cleanlab.datalab.internal.data import os
from typing import Any , Callable , Dict , List , Mapping , Optional , Union , cast , TYPE_CHECKING , Tuple
+from cleanlab.datalab.internal.task import Task
+
try :
import datasets
except ImportError as error :
@@ -646,9 +649,21 @@
Source code for cleanlab.datalab.internal.data label_name : Union[str, List[str]]
Name of the label column in the dataset.
- map_to_int : bool
- Whether to map the labels to integers, e.g. [0, 1, ..., K-1] where K is the number of classes.
- If False, the labels are not mapped to integers, e.g. for regression tasks.
+ task :
+ The task associated with the dataset. This is used to determine how to
+ to format the labels.
+
+ Note:
+
+ - If the task is a classification task, the labels
+ will be mapped to integers, e.g. [0, 1, ..., K-1] where K is the number
+ of classes. If the task is a regression task, the labels will not be
+ mapped to integers.
+
+ - If the task is a multilabel task, the labels will be formatted as a
+ list of lists, e.g. [[0, 1], [1, 2], [0, 2]] where each sublist contains
+ the labels for a single example. If the task is not a multilabel task,
+ the labels will be formatted as a 1D numpy array.
Warnings
--------
@@ -663,15 +678,15 @@
Source code for cleanlab.datalab.internal.data def __init__ (
self ,
data : "DatasetLike" ,
+ task : Task ,
label_name : Optional [ str ] = None ,
- map_to_int : bool = True ,
- is_multilabel : bool = False ,
) -> None :
self . _validate_data ( data )
self . _data = self . _load_data ( data )
self . _data_hash = hash ( self . _data )
self . labels : Label
- label_class = MultiLabel if is_multilabel else MultiClass
+ label_class = MultiLabel if task . is_multilabel else MultiClass
+ map_to_int = task . is_classification
self . labels = label_class ( data = self . _data , label_name = label_name , map_to_int = map_to_int )
def _load_data ( self , data : "DatasetLike" ) -> Dataset :
diff --git a/master/_modules/cleanlab/datalab/internal/data_issues.html b/master/_modules/cleanlab/datalab/internal/data_issues.html
index 5c5b3ecc4..912eb9d53 100644
--- a/master/_modules/cleanlab/datalab/internal/data_issues.html
+++ b/master/_modules/cleanlab/datalab/internal/data_issues.html
@@ -238,6 +238,7 @@
report
+
task
@@ -559,7 +560,7 @@
Source code for cleanlab.datalab.internal.data_issues import
warnings
from abc import ABC , abstractmethod
-
from typing import TYPE_CHECKING , Any , Dict , List , Optional , Union
+
from typing import TYPE_CHECKING , Any , Dict , List , Optional , Type , Union
import numpy as np
import pandas as pd
@@ -727,7 +728,7 @@
Source code for cleanlab.datalab.internal.data_issues A dictionary that contains information and statistics about the data and each issue type.
"""
-
def __init__ ( self , data : Data , strategy : _InfoStrategy ) -> None :
+
def __init__ ( self , data : Data , strategy : Type [ _InfoStrategy ]) -> None :
self . issues : pd . DataFrame = pd . DataFrame ( index = range ( len ( data )))
self . issue_summary : pd . DataFrame = pd . DataFrame (
columns = [ "issue_type" , "score" , "num_issues" ]
diff --git a/master/_modules/cleanlab/datalab/internal/issue_finder.html b/master/_modules/cleanlab/datalab/internal/issue_finder.html
index 8d440d56a..0ab7a38a3 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_finder.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_finder.html
@@ -238,6 +238,7 @@
report
+
task
@@ -573,6 +574,7 @@
Source code for cleanlab.datalab.internal.issue_finder RegressionPredictions
,
MultiLabelPredProbs ,
)
+
from cleanlab.datalab.internal.task import Task
if TYPE_CHECKING : # pragma: no cover
import numpy.typing as npt
@@ -700,7 +702,7 @@
Source code for cleanlab.datalab.internal.issue_finder return
args_dict
-
def _select_strategy_for_resolving_required_args ( task : str ) -> Callable :
+
def _select_strategy_for_resolving_required_args ( task : Task ) -> Callable :
"""Helper function that selects the strategy for resolving required arguments for each issue type.
Each strategy resolves the required arguments for each issue type.
@@ -721,9 +723,9 @@
Source code for cleanlab.datalab.internal.issue_finder Dictionary of required arguments for each issue type, if available.
"""
strategies = {
-
"classification" : _resolve_required_args_for_classification ,
-
"regression" : _resolve_required_args_for_regression ,
-
"multilabel" : _resolve_required_args_for_multilabel ,
+
Task . CLASSIFICATION : _resolve_required_args_for_classification ,
+
Task . REGRESSION : _resolve_required_args_for_regression ,
+
Task . MULTILABEL : _resolve_required_args_for_multilabel ,
}
selected_strategy = strategies . get ( task , None )
if selected_strategy is None :
@@ -762,7 +764,7 @@
Source code for cleanlab.datalab.internal.issue_finder `Datalab.find_issues` method which internally utilizes an IssueFinder instance.
"""
-
def __init__ ( self , datalab : "Datalab" , task : str , verbosity = 1 ):
+
def __init__ ( self , datalab : "Datalab" , task : Task , verbosity = 1 ):
self . datalab = datalab
self . task = task
self . verbosity = verbosity
@@ -943,9 +945,9 @@
Source code for cleanlab.datalab.internal.issue_finder model_output
= None
if pred_probs is not None :
model_output_dict = {
-
"regression" : RegressionPredictions ,
-
"classification" : MultiClassPredProbs ,
-
"multilabel" : MultiLabelPredProbs ,
+
Task . REGRESSION : RegressionPredictions ,
+
Task . CLASSIFICATION : MultiClassPredProbs ,
+
Task . MULTILABEL : MultiLabelPredProbs ,
}
model_output_class = model_output_dict . get ( self . task )
@@ -976,7 +978,7 @@
Source code for cleanlab.datalab.internal.issue_finder drop_label_check
= (
"label" in issue_types_copy
and not self . datalab . has_labels
-
and self . task != "regression"
+
and self . task != Task . REGRESSION
)
if drop_label_check :
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/data_valuation.html b/master/_modules/cleanlab/datalab/internal/issue_manager/data_valuation.html
index 6f79850ee..d9246cc91 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/data_valuation.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/data_valuation.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/duplicate.html b/master/_modules/cleanlab/datalab/internal/issue_manager/duplicate.html
index b14bea6d1..aa67fab16 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/duplicate.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/duplicate.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/imbalance.html b/master/_modules/cleanlab/datalab/internal/issue_manager/imbalance.html
index 32c84c3ca..d602083ce 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/imbalance.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/imbalance.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/issue_manager.html b/master/_modules/cleanlab/datalab/internal/issue_manager/issue_manager.html
index 95b1bd4f8..45a8ed9d3 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/issue_manager.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/issue_manager.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/label.html b/master/_modules/cleanlab/datalab/internal/issue_manager/label.html
index b4e58eca3..aaa8ff2a1 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/label.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/label.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/noniid.html b/master/_modules/cleanlab/datalab/internal/issue_manager/noniid.html
index f5b422638..a57a0e954 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/noniid.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/noniid.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/null.html b/master/_modules/cleanlab/datalab/internal/issue_manager/null.html
index dac92a906..93062fd4b 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/null.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/null.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/outlier.html b/master/_modules/cleanlab/datalab/internal/issue_manager/outlier.html
index df9be4f26..cc74ba8f5 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/outlier.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/outlier.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/regression/label.html b/master/_modules/cleanlab/datalab/internal/issue_manager/regression/label.html
index dfb385275..26e273d73 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/regression/label.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/regression/label.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager/underperforming_group.html b/master/_modules/cleanlab/datalab/internal/issue_manager/underperforming_group.html
index 670dfe8a7..8028633c2 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager/underperforming_group.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager/underperforming_group.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/datalab/internal/issue_manager_factory.html b/master/_modules/cleanlab/datalab/internal/issue_manager_factory.html
index debe5ff0e..7c98ea668 100644
--- a/master/_modules/cleanlab/datalab/internal/issue_manager_factory.html
+++ b/master/_modules/cleanlab/datalab/internal/issue_manager_factory.html
@@ -238,6 +238,7 @@
report
+
task
@@ -584,10 +585,11 @@
Source code for cleanlab.datalab.internal.issue_manager_factory )
from cleanlab.datalab.internal.issue_manager.regression import RegressionLabelIssueManager
from cleanlab.datalab.internal.issue_manager.multilabel.label import MultilabelIssueManager
+
from cleanlab.datalab.internal.task import Task
-
REGISTRY : Dict [ str , Dict [ str , Type [ IssueManager ]]] = {
-
"classification" : {
+
REGISTRY : Dict [ Task , Dict [ str , Type [ IssueManager ]]] = {
+
Task . CLASSIFICATION : {
"outlier" : OutlierIssueManager ,
"label" : LabelIssueManager ,
"near_duplicate" : NearDuplicateIssueManager ,
@@ -597,14 +599,14 @@
Source code for cleanlab.datalab.internal.issue_manager_factory "data_valuation"
: DataValuationIssueManager ,
"null" : NullIssueManager ,
},
-
"regression" : {
+
Task . REGRESSION : {
"label" : RegressionLabelIssueManager ,
"outlier" : OutlierIssueManager ,
"near_duplicate" : NearDuplicateIssueManager ,
"non_iid" : NonIIDIssueManager ,
"null" : NullIssueManager ,
},
-
"multilabel" : {
+
Task . MULTILABEL : {
"label" : MultilabelIssueManager ,
"outlier" : OutlierIssueManager ,
"near_duplicate" : NearDuplicateIssueManager ,
@@ -612,16 +614,31 @@
Source code for cleanlab.datalab.internal.issue_manager_factory "null"
: NullIssueManager ,
},
}
-
"""Registry of issue managers that can be constructed from a string
+
"""Registry of issue managers that can be constructed from a task and issue type
and used in the Datalab class.
:meta hide-value:
-
Currently, the following issue managers are registered by default:
+
Currently, the following issue managers are registered by default for a given task:
-
- ``"outlier"``: :py:class:`OutlierIssueManager <cleanlab.datalab.internal.issue_manager.outlier.OutlierIssueManager>`
-
- ``"near_duplicate"``: :py:class:`NearDuplicateIssueManager <cleanlab.datalab.internal.issue_manager.duplicate.NearDuplicateIssueManager>`
-
- ``"non_iid"``: :py:class:`NonIIDIssueManager <cleanlab.datalab.internal.issue_manager.noniid.NonIIDIssueManager>`
+
- Classification:
+
+
- ``"outlier"``: :py:class:`OutlierIssueManager <cleanlab.datalab.internal.issue_manager.outlier.OutlierIssueManager>`
+
- ``"label"``: :py:class:`LabelIssueManager <cleanlab.datalab.internal.issue_manager.label.LabelIssueManager>`
+
- ``"near_duplicate"``: :py:class:`NearDuplicateIssueManager <cleanlab.datalab.internal.issue_manager.duplicate.NearDuplicateIssueManager>`
+
- ``"non_iid"``: :py:class:`NonIIDIssueManager <cleanlab.datalab.internal.issue_manager.noniid.NonIIDIssueManager>`
+
- ``"class_imbalance"``: :py:class:`ClassImbalanceIssueManager <cleanlab.datalab.internal.issue_manager.class_imbalance.ClassImbalanceIssueManager>`
+
- ``"underperforming_group"``: :py:class:`UnderperformingGroupIssueManager <cleanlab.datalab.internal.issue_manager.underperforming_group.UnderperformingGroupIssueManager>`
+
- ``"data_valuation"``: :py:class:`DataValuationIssueManager <cleanlab.datalab.internal.issue_manager.data_valuation.DataValuationIssueManager>`
+
- ``"null"``: :py:class:`NullIssueManager <cleanlab.datalab.internal.issue_manager.null.NullIssueManager>`
+
+
- Regression:
+
+
- ``"label"``: :py:class:`RegressionLabelIssueManager <cleanlab.datalab.internal.issue_manager.regression.label.RegressionLabelIssueManager>`
+
+
- Multilabel:
+
+
- ``"label"``: :py:class:`MultilabelIssueManager <cleanlab.datalab.internal.issue_manager.multilabel.label.MultilabelIssueManager>`
Warning
-------
@@ -634,7 +651,7 @@
Source code for cleanlab.datalab.internal.issue_manager_factory """Factory class for constructing concrete issue managers."""
@classmethod
-
def from_str ( cls , issue_type : str , task : str ) -> Type [ IssueManager ]:
+
def from_str ( cls , issue_type : str , task : Task ) -> Type [ IssueManager ]:
"""Constructs a concrete issue manager class from a string."""
if isinstance ( issue_type , list ):
raise ValueError (
@@ -649,12 +666,12 @@
Source code for cleanlab.datalab.internal.issue_manager_factory return
REGISTRY [ task ][ issue_type ]
@classmethod
-
def from_list ( cls , issue_types : List [ str ], task : str ) -> List [ Type [ IssueManager ]]:
+
def from_list ( cls , issue_types : List [ str ], task : Task ) -> List [ Type [ IssueManager ]]:
"""Constructs a list of concrete issue manager classes from a list of strings."""
return [ cls . from_str ( issue_type , task ) for issue_type in issue_types ]
-
[docs] def register ( cls : Type [ IssueManager ], task : str = "classification" ) -> Type [ IssueManager ]:
+
[docs] def register ( cls : Type [ IssueManager ], task : str = str ( Task . CLASSIFICATION )) -> Type [ IssueManager ]:
"""Registers the issue manager factory.
Parameters
@@ -665,6 +682,8 @@
Source code for cleanlab.datalab.internal.issue_manager_factory task :
Specific machine learning task like classification or regression.
+
See :py:meth:`Task.from_str <cleanlab.datalab.internal.task.Task.from_str>`` for more details,
+
to see which task type corresponds to which string.
Returns
-------
@@ -711,20 +730,24 @@
Source code for cleanlab.datalab.internal.issue_manager_factory name: str = str ( cls . issue_name )
- if task not in REGISTRY :
+ try :
+ _task = Task . from_str ( task )
+ if _task not in REGISTRY :
+ raise ValueError ( f "Invalid task type: { _task } , must be in { list ( REGISTRY . keys ()) } " )
+ except KeyError :
raise ValueError ( f "Invalid task type: { task } , must be in { list ( REGISTRY . keys ()) } " )
- if name in REGISTRY [ task ]:
+ if name in REGISTRY [ _task ]:
print (
- f "Warning: Overwriting existing issue manager { name } with { cls } for task { task } ."
+ f "Warning: Overwriting existing issue manager { name } with { cls } for task { _task } ."
"This may cause unexpected behavior."
)
- REGISTRY [ task ][ name ] = cls
+ REGISTRY [ _task ][ name ] = cls
return cls
-
[docs] def list_possible_issue_types ( task : str ) -> List [ str ]:
+
[docs] def list_possible_issue_types ( task : Task ) -> List [ str ]:
"""Returns a list of all registered issue types.
Any issue type that is not in this list cannot be used in the :py:meth:`find_issues` method.
@@ -736,16 +759,19 @@
Source code for cleanlab.datalab.internal.issue_manager_factory return list ( REGISTRY . get ( task , []))
-
[docs] def list_default_issue_types ( task : str ) -> List [ str ]:
+
[docs] def list_default_issue_types ( task : Task ) -> List [ str ]:
"""Returns a list of the issue types that are run by default
when :py:meth:`find_issues` is called without specifying `issue_types`.
+
task :
+
Specific machine learning task supported by Datalab.
+
See Also
--------
:py:class:`REGISTRY <cleanlab.datalab.internal.issue_manager_factory.REGISTRY>` : All available issue types and their corresponding issue managers can be found here.
"""
default_issue_types_dict = {
-
"classification" : [
+
Task . CLASSIFICATION : [
"null" ,
"label" ,
"outlier" ,
@@ -753,14 +779,14 @@
Source code for cleanlab.datalab.internal.issue_manager_factory "non_iid"
,
"class_imbalance" ,
],
-
"regression" : [
+
Task . REGRESSION : [
"null" ,
"label" ,
"outlier" ,
"near_duplicate" ,
"non_iid" ,
],
-
"multilabel" : [
+
Task . MULTILABEL : [
"null" ,
"label" ,
"outlier" ,
@@ -769,7 +795,7 @@
Source code for cleanlab.datalab.internal.issue_manager_factory ],
}
if task not in default_issue_types_dict :
- task = "classification"
+ task = Task . CLASSIFICATION
default_issue_types = default_issue_types_dict [ task ]
return default_issue_types
diff --git a/master/_modules/cleanlab/datalab/internal/report.html b/master/_modules/cleanlab/datalab/internal/report.html
index 76298e5c2..24b19b43e 100644
--- a/master/_modules/cleanlab/datalab/internal/report.html
+++ b/master/_modules/cleanlab/datalab/internal/report.html
@@ -238,6 +238,7 @@
report
+
task
@@ -552,6 +553,7 @@
Source code for cleanlab.datalab.internal.report
from cleanlab.datalab.internal.adapter.constants import DEFAULT_CLEANVISION_ISSUES
from cleanlab.datalab.internal.issue_manager_factory import _IssueManagerFactory
+
from cleanlab.datalab.internal.task import Task
if TYPE_CHECKING : # pragma: no cover
from cleanlab.datalab.internal.data_issues import DataIssues
@@ -568,7 +570,8 @@
Source code for cleanlab.datalab.internal.report
and then passed to the :py:class:`Reporter` class to generate a report.
task :
-
Specific machine learning task like classification or regression.
+
Specific machine learning task that the datset is intended for.
+
See details about supported tasks in :py:class:`Task <cleanlab.datalab.internal.task.Task>`.
verbosity :
The default verbosity of the report to generate. Each :py:class`IssueManager`
@@ -588,7 +591,7 @@
Source code for cleanlab.datalab.internal.report
def __init__ (
self ,
data_issues : "DataIssues" ,
-
task : str ,
+
task : Task ,
verbosity : int = 1 ,
include_description : bool = True ,
show_summary_score : bool = False ,
diff --git a/master/_modules/cleanlab/datalab/internal/task.html b/master/_modules/cleanlab/datalab/internal/task.html
new file mode 100644
index 000000000..1c092e013
--- /dev/null
+++ b/master/_modules/cleanlab/datalab/internal/task.html
@@ -0,0 +1,733 @@
+
+
+
+
+
+
+
+
+
+
+
cleanlab.datalab.internal.task - cleanlab
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+
+
+
+
Warning
+
Parts of this site uses JavaScript, but your browser does not support it.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source code for cleanlab.datalab.internal.task
+# Copyright (C) 2017-2024 Cleanlab Inc.
+# This file is part of cleanlab.
+#
+# cleanlab is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cleanlab is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with cleanlab. If not, see <https://www.gnu.org/licenses/>.
+from enum import Enum
+
+
+[docs] class Task ( Enum ):
+
"""
+
Represents a task supported by Datalab.
+
+
Datalab supports the following tasks:
+
+
* **Classification**: for predicting discrete class labels.
+
* **Regression**: for predicting continuous numerical values.
+
* **Multilabel**: for predicting multiple binary labels simultaneously.
+
+
Example
+
-------
+
>>> task = Task.CLASSIFICATION
+
>>> task
+
<Task.CLASSIFICATION: 'classification'>
+
"""
+
+
CLASSIFICATION = "classification"
+
"""Classification task."""
+
REGRESSION = "regression"
+
"""Regression task."""
+
MULTILABEL = "multilabel"
+
"""Multilabel task."""
+
+
def __str__ ( self ):
+
"""
+
Returns the string representation of the task.
+
+
Returns:
+
str: The string representation of the task.
+
"""
+
return self . value
+
+
[docs] @classmethod
+
def from_str ( cls , task_str : str ) -> "Task" :
+
"""
+
Converts a string representation of a task to a Task enum value.
+
+
Parameters
+
----------
+
task_str :
+
The string representation of the task.
+
+
Returns
+
-------
+
Task :
+
The corresponding Task enum value.
+
+
Raises
+
------
+
ValueError :
+
If the provided task_str is not a valid task supported by Datalab.
+
+
Examples
+
--------
+
>>> Task.from_str("classification")
+
<Task.CLASSIFICATION: 'classification'>
+
>>> print(Task.from_str("regression"))
+
regression
+
"""
+
_value_to_enum = { task . value : task for task in Task }
+
try :
+
return _value_to_enum [ task_str ]
+
except KeyError :
+
valid_tasks = list ( _value_to_enum . keys ())
+
raise ValueError ( f "Invalid task: { task_str } . Datalab only supports { valid_tasks } ." )
+
+
@property
+
def is_classification ( self ):
+
"""
+
Checks if the task is classification.
+
+
Returns
+
-------
+
bool :
+
True if the task is classification, False otherwise.
+
+
Examples
+
--------
+
>>> task = Task.CLASSIFICATION
+
>>> print(task.is_classification)
+
True
+
"""
+
return self == Task . CLASSIFICATION
+
+
@property
+
def is_regression ( self ):
+
"""
+
Checks if the task is regression.
+
+
Returns
+
-------
+
bool :
+
True if the task is regression, False otherwise.
+
+
Examples
+
--------
+
>>> task = Task.CLASSIFICATION
+
>>> print(task.is_regression)
+
False
+
"""
+
return self == Task . REGRESSION
+
+
@property
+
def is_multilabel ( self ):
+
"""
+
Checks if the task is multilabel.
+
+
Returns
+
-------
+
bool :
+
True if the task is multilabel, False otherwise.
+
+
Examples
+
--------
+
>>> task = Task.CLASSIFICATION
+
>>> print(task.is_multilabel)
+
False
+
"""
+
return self == Task . MULTILABEL
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/master/_modules/cleanlab/dataset.html b/master/_modules/cleanlab/dataset.html
index 738f8f55c..f613a9fea 100644
--- a/master/_modules/cleanlab/dataset.html
+++ b/master/_modules/cleanlab/dataset.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/experimental/cifar_cnn.html b/master/_modules/cleanlab/experimental/cifar_cnn.html
index 84edc9eba..53f343d19 100644
--- a/master/_modules/cleanlab/experimental/cifar_cnn.html
+++ b/master/_modules/cleanlab/experimental/cifar_cnn.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/experimental/coteaching.html b/master/_modules/cleanlab/experimental/coteaching.html
index 278204bd7..cfe201d20 100644
--- a/master/_modules/cleanlab/experimental/coteaching.html
+++ b/master/_modules/cleanlab/experimental/coteaching.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/experimental/label_issues_batched.html b/master/_modules/cleanlab/experimental/label_issues_batched.html
index 96673cc6b..376288183 100644
--- a/master/_modules/cleanlab/experimental/label_issues_batched.html
+++ b/master/_modules/cleanlab/experimental/label_issues_batched.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/experimental/mnist_pytorch.html b/master/_modules/cleanlab/experimental/mnist_pytorch.html
index 6ef027e5b..b685fee38 100644
--- a/master/_modules/cleanlab/experimental/mnist_pytorch.html
+++ b/master/_modules/cleanlab/experimental/mnist_pytorch.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/filter.html b/master/_modules/cleanlab/filter.html
index bd6edb9b6..f33a309c6 100644
--- a/master/_modules/cleanlab/filter.html
+++ b/master/_modules/cleanlab/filter.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/label_quality_utils.html b/master/_modules/cleanlab/internal/label_quality_utils.html
index aa1821739..4e6618dea 100644
--- a/master/_modules/cleanlab/internal/label_quality_utils.html
+++ b/master/_modules/cleanlab/internal/label_quality_utils.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/latent_algebra.html b/master/_modules/cleanlab/internal/latent_algebra.html
index baef74ae9..cb636bd16 100644
--- a/master/_modules/cleanlab/internal/latent_algebra.html
+++ b/master/_modules/cleanlab/internal/latent_algebra.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/multiannotator_utils.html b/master/_modules/cleanlab/internal/multiannotator_utils.html
index fd93b9ee5..3e66fdf51 100644
--- a/master/_modules/cleanlab/internal/multiannotator_utils.html
+++ b/master/_modules/cleanlab/internal/multiannotator_utils.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/multilabel_scorer.html b/master/_modules/cleanlab/internal/multilabel_scorer.html
index e4df0e9d6..f292889cd 100644
--- a/master/_modules/cleanlab/internal/multilabel_scorer.html
+++ b/master/_modules/cleanlab/internal/multilabel_scorer.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/multilabel_utils.html b/master/_modules/cleanlab/internal/multilabel_utils.html
index 6ffe1c292..9b73a0ca4 100644
--- a/master/_modules/cleanlab/internal/multilabel_utils.html
+++ b/master/_modules/cleanlab/internal/multilabel_utils.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/outlier.html b/master/_modules/cleanlab/internal/outlier.html
index a8183a41f..a03a6aec5 100644
--- a/master/_modules/cleanlab/internal/outlier.html
+++ b/master/_modules/cleanlab/internal/outlier.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/token_classification_utils.html b/master/_modules/cleanlab/internal/token_classification_utils.html
index 7a27fa947..98f44066d 100644
--- a/master/_modules/cleanlab/internal/token_classification_utils.html
+++ b/master/_modules/cleanlab/internal/token_classification_utils.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/util.html b/master/_modules/cleanlab/internal/util.html
index 8e71a20f3..b9ead498a 100644
--- a/master/_modules/cleanlab/internal/util.html
+++ b/master/_modules/cleanlab/internal/util.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/internal/validation.html b/master/_modules/cleanlab/internal/validation.html
index 01c2f68fb..03dbd9e82 100644
--- a/master/_modules/cleanlab/internal/validation.html
+++ b/master/_modules/cleanlab/internal/validation.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/models/keras.html b/master/_modules/cleanlab/models/keras.html
index 4ed0e32a8..89ca1d80c 100644
--- a/master/_modules/cleanlab/models/keras.html
+++ b/master/_modules/cleanlab/models/keras.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/multiannotator.html b/master/_modules/cleanlab/multiannotator.html
index 0864cc174..a5a831d36 100644
--- a/master/_modules/cleanlab/multiannotator.html
+++ b/master/_modules/cleanlab/multiannotator.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/multilabel_classification/dataset.html b/master/_modules/cleanlab/multilabel_classification/dataset.html
index 7a782ff33..d51a0968c 100644
--- a/master/_modules/cleanlab/multilabel_classification/dataset.html
+++ b/master/_modules/cleanlab/multilabel_classification/dataset.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/multilabel_classification/filter.html b/master/_modules/cleanlab/multilabel_classification/filter.html
index c0f7b1234..7798f7251 100644
--- a/master/_modules/cleanlab/multilabel_classification/filter.html
+++ b/master/_modules/cleanlab/multilabel_classification/filter.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/multilabel_classification/rank.html b/master/_modules/cleanlab/multilabel_classification/rank.html
index 8e18e1c6d..46ccae06d 100644
--- a/master/_modules/cleanlab/multilabel_classification/rank.html
+++ b/master/_modules/cleanlab/multilabel_classification/rank.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/object_detection/filter.html b/master/_modules/cleanlab/object_detection/filter.html
index 97ef5c75c..fcc59a390 100644
--- a/master/_modules/cleanlab/object_detection/filter.html
+++ b/master/_modules/cleanlab/object_detection/filter.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/object_detection/rank.html b/master/_modules/cleanlab/object_detection/rank.html
index 4d6c79990..79c1c7fc4 100644
--- a/master/_modules/cleanlab/object_detection/rank.html
+++ b/master/_modules/cleanlab/object_detection/rank.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/object_detection/summary.html b/master/_modules/cleanlab/object_detection/summary.html
index d8c3ca714..022fcc370 100644
--- a/master/_modules/cleanlab/object_detection/summary.html
+++ b/master/_modules/cleanlab/object_detection/summary.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/outlier.html b/master/_modules/cleanlab/outlier.html
index 8a607766d..ced745e1b 100644
--- a/master/_modules/cleanlab/outlier.html
+++ b/master/_modules/cleanlab/outlier.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/rank.html b/master/_modules/cleanlab/rank.html
index e54247f19..4deb09878 100644
--- a/master/_modules/cleanlab/rank.html
+++ b/master/_modules/cleanlab/rank.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/regression/learn.html b/master/_modules/cleanlab/regression/learn.html
index 9db04ed12..d0d5e3489 100644
--- a/master/_modules/cleanlab/regression/learn.html
+++ b/master/_modules/cleanlab/regression/learn.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/regression/rank.html b/master/_modules/cleanlab/regression/rank.html
index de1377cf2..20beb65f0 100644
--- a/master/_modules/cleanlab/regression/rank.html
+++ b/master/_modules/cleanlab/regression/rank.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/segmentation/filter.html b/master/_modules/cleanlab/segmentation/filter.html
index 5017285f7..f05cc2d8f 100644
--- a/master/_modules/cleanlab/segmentation/filter.html
+++ b/master/_modules/cleanlab/segmentation/filter.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/segmentation/rank.html b/master/_modules/cleanlab/segmentation/rank.html
index 9ada56b19..52c4dc808 100644
--- a/master/_modules/cleanlab/segmentation/rank.html
+++ b/master/_modules/cleanlab/segmentation/rank.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/segmentation/summary.html b/master/_modules/cleanlab/segmentation/summary.html
index b597ac2a6..d3498d354 100644
--- a/master/_modules/cleanlab/segmentation/summary.html
+++ b/master/_modules/cleanlab/segmentation/summary.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/token_classification/filter.html b/master/_modules/cleanlab/token_classification/filter.html
index 1f9a8e945..43ae890e4 100644
--- a/master/_modules/cleanlab/token_classification/filter.html
+++ b/master/_modules/cleanlab/token_classification/filter.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/token_classification/rank.html b/master/_modules/cleanlab/token_classification/rank.html
index c56f0b1aa..cb89d85bf 100644
--- a/master/_modules/cleanlab/token_classification/rank.html
+++ b/master/_modules/cleanlab/token_classification/rank.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/cleanlab/token_classification/summary.html b/master/_modules/cleanlab/token_classification/summary.html
index 953d124e2..dde86da10 100644
--- a/master/_modules/cleanlab/token_classification/summary.html
+++ b/master/_modules/cleanlab/token_classification/summary.html
@@ -238,6 +238,7 @@
report
+
task
diff --git a/master/_modules/index.html b/master/_modules/index.html
index db00cc094..be778fc59 100644
--- a/master/_modules/index.html
+++ b/master/_modules/index.html
@@ -238,6 +238,7 @@
report
+
task
@@ -546,6 +547,7 @@
All modules for which code is available
cleanlab.datalab.internal.issue_manager.underperforming_group cleanlab.datalab.internal.issue_manager_factory cleanlab.datalab.internal.report
+
cleanlab.datalab.internal.task cleanlab.dataset cleanlab.experimental.cifar_cnn cleanlab.experimental.coteaching
diff --git a/master/_sources/cleanlab/datalab/internal/index.rst b/master/_sources/cleanlab/datalab/internal/index.rst
index 2a5f6050c..6e8d335f7 100644
--- a/master/_sources/cleanlab/datalab/internal/index.rst
+++ b/master/_sources/cleanlab/datalab/internal/index.rst
@@ -21,3 +21,4 @@ internal
factory
issue_manager/index
report
+ task
diff --git a/master/_sources/cleanlab/datalab/internal/task.rst b/master/_sources/cleanlab/datalab/internal/task.rst
new file mode 100644
index 000000000..42ded02f5
--- /dev/null
+++ b/master/_sources/cleanlab/datalab/internal/task.rst
@@ -0,0 +1,11 @@
+task
+====
+
+.. note:: This module is not intended to be used directly by users. It is used by the :mod:`cleanlab.datalab.datalab` module.
+
+.. automodule:: cleanlab.datalab.internal.task
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :ignore-module-all:
\ No newline at end of file
diff --git a/master/_sources/tutorials/audio.ipynb b/master/_sources/tutorials/audio.ipynb
index 14895a485..a2c987fb9 100644
--- a/master/_sources/tutorials/audio.ipynb
+++ b/master/_sources/tutorials/audio.ipynb
@@ -91,7 +91,7 @@
"os.environ[\"TF_CPP_MIN_LOG_LEVEL\"] = \"3\" \n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/datalab/datalab_advanced.ipynb b/master/_sources/tutorials/datalab/datalab_advanced.ipynb
index 57628de2b..ef09fc76f 100644
--- a/master/_sources/tutorials/datalab/datalab_advanced.ipynb
+++ b/master/_sources/tutorials/datalab/datalab_advanced.ipynb
@@ -87,7 +87,7 @@
"dependencies = [\"cleanlab\", \"matplotlib\", \"datasets\"] # TODO: make sure this list is updated\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/datalab/datalab_quickstart.ipynb b/master/_sources/tutorials/datalab/datalab_quickstart.ipynb
index 7d51cb908..2f9a3eb5c 100644
--- a/master/_sources/tutorials/datalab/datalab_quickstart.ipynb
+++ b/master/_sources/tutorials/datalab/datalab_quickstart.ipynb
@@ -85,7 +85,7 @@
"dependencies = [\"cleanlab\", \"matplotlib\", \"datasets\"] # TODO: make sure this list is updated\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/datalab/tabular.ipynb b/master/_sources/tutorials/datalab/tabular.ipynb
index 9a1588077..b2db9adb1 100644
--- a/master/_sources/tutorials/datalab/tabular.ipynb
+++ b/master/_sources/tutorials/datalab/tabular.ipynb
@@ -81,7 +81,7 @@
"dependencies = [\"cleanlab\", \"datasets\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/datalab/text.ipynb b/master/_sources/tutorials/datalab/text.ipynb
index 13339a083..5a14ef4c3 100644
--- a/master/_sources/tutorials/datalab/text.ipynb
+++ b/master/_sources/tutorials/datalab/text.ipynb
@@ -90,7 +90,7 @@
"os.environ[\"TOKENIZERS_PARALLELISM\"] = \"false\" # disable parallelism to avoid deadlocks with huggingface\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/dataset_health.ipynb b/master/_sources/tutorials/dataset_health.ipynb
index 75b5b8936..a5797f6ee 100644
--- a/master/_sources/tutorials/dataset_health.ipynb
+++ b/master/_sources/tutorials/dataset_health.ipynb
@@ -77,7 +77,7 @@
"dependencies = [\"cleanlab\", \"requests\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/indepth_overview.ipynb b/master/_sources/tutorials/indepth_overview.ipynb
index 1979e19cb..1b95dff44 100644
--- a/master/_sources/tutorials/indepth_overview.ipynb
+++ b/master/_sources/tutorials/indepth_overview.ipynb
@@ -62,7 +62,7 @@
"dependencies = [\"cleanlab\", \"matplotlib\", \"datasets\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/multiannotator.ipynb b/master/_sources/tutorials/multiannotator.ipynb
index 06fb97345..3faabb648 100644
--- a/master/_sources/tutorials/multiannotator.ipynb
+++ b/master/_sources/tutorials/multiannotator.ipynb
@@ -96,7 +96,7 @@
"dependencies = [\"cleanlab\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/multilabel_classification.ipynb b/master/_sources/tutorials/multilabel_classification.ipynb
index 8dfb97daa..3a2b29659 100644
--- a/master/_sources/tutorials/multilabel_classification.ipynb
+++ b/master/_sources/tutorials/multilabel_classification.ipynb
@@ -73,7 +73,7 @@
"dependencies = [\"cleanlab\", \"matplotlib\", \"datasets\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/object_detection.ipynb b/master/_sources/tutorials/object_detection.ipynb
index f491f2948..7163db06a 100644
--- a/master/_sources/tutorials/object_detection.ipynb
+++ b/master/_sources/tutorials/object_detection.ipynb
@@ -77,7 +77,7 @@
"dependencies = [\"cleanlab\", \"matplotlib\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/outliers.ipynb b/master/_sources/tutorials/outliers.ipynb
index 492030165..12eccde38 100644
--- a/master/_sources/tutorials/outliers.ipynb
+++ b/master/_sources/tutorials/outliers.ipynb
@@ -119,7 +119,7 @@
"dependencies = [\"matplotlib\", \"torch\", \"torchvision\", \"timm\", \"cleanlab\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/regression.ipynb b/master/_sources/tutorials/regression.ipynb
index d3e9e9f07..cc4da388c 100644
--- a/master/_sources/tutorials/regression.ipynb
+++ b/master/_sources/tutorials/regression.ipynb
@@ -103,7 +103,7 @@
"dependencies = [\"cleanlab\", \"matplotlib>=3.6.0\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = \" \".join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/segmentation.ipynb b/master/_sources/tutorials/segmentation.ipynb
index 1ec4a4b86..59432150c 100644
--- a/master/_sources/tutorials/segmentation.ipynb
+++ b/master/_sources/tutorials/segmentation.ipynb
@@ -91,7 +91,7 @@
"dependencies = [\"cleanlab\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/tabular.ipynb b/master/_sources/tutorials/tabular.ipynb
index 8b8491d07..b17411a2f 100644
--- a/master/_sources/tutorials/tabular.ipynb
+++ b/master/_sources/tutorials/tabular.ipynb
@@ -119,7 +119,7 @@
"dependencies = [\"cleanlab\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/text.ipynb b/master/_sources/tutorials/text.ipynb
index 3e23a3669..e8f4d7239 100644
--- a/master/_sources/tutorials/text.ipynb
+++ b/master/_sources/tutorials/text.ipynb
@@ -128,7 +128,7 @@
"os.environ[\"TOKENIZERS_PARALLELISM\"] = \"false\" # disable parallelism to avoid deadlocks with huggingface\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/_sources/tutorials/token_classification.ipynb b/master/_sources/tutorials/token_classification.ipynb
index 44816420d..7f1825644 100644
--- a/master/_sources/tutorials/token_classification.ipynb
+++ b/master/_sources/tutorials/token_classification.ipynb
@@ -95,7 +95,7 @@
"dependencies = [\"cleanlab\"]\n",
"\n",
"if \"google.colab\" in str(get_ipython()): # Check if it's running in Google Colab\n",
- " %pip install git+https://github.com/cleanlab/cleanlab.git@f03cdd8f3c75a5f550d00a20cb320ddc53d49705\n",
+ " %pip install git+https://github.com/cleanlab/cleanlab.git@16c5866a8b1b16ae3bc83a4f730d0c2a568a41cd\n",
" cmd = ' '.join([dep for dep in dependencies if dep != \"cleanlab\"])\n",
" %pip install $cmd\n",
"else:\n",
diff --git a/master/cleanlab/benchmarking/index.html b/master/cleanlab/benchmarking/index.html
index 162210136..8a9bb9d26 100644
--- a/master/cleanlab/benchmarking/index.html
+++ b/master/cleanlab/benchmarking/index.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/benchmarking/noise_generation.html b/master/cleanlab/benchmarking/noise_generation.html
index bbd1d658c..8836c2f5c 100644
--- a/master/cleanlab/benchmarking/noise_generation.html
+++ b/master/cleanlab/benchmarking/noise_generation.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/classification.html b/master/cleanlab/classification.html
index f120dc7b1..60c7cdacd 100644
--- a/master/cleanlab/classification.html
+++ b/master/cleanlab/classification.html
@@ -21,7 +21,7 @@
-
+
classification - cleanlab
@@ -247,6 +247,7 @@
report
+
task
@@ -1188,14 +1189,14 @@
-
+
diff --git a/master/cleanlab/count.html b/master/cleanlab/count.html
index 5735b2407..8f941152c 100644
--- a/master/cleanlab/count.html
+++ b/master/cleanlab/count.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/datalab/datalab.html b/master/cleanlab/datalab/datalab.html
index 11891904a..1c4cda8dd 100644
--- a/master/cleanlab/datalab/datalab.html
+++ b/master/cleanlab/datalab/datalab.html
@@ -247,6 +247,7 @@
report
+
task
@@ -590,8 +591,16 @@
-
task (str
+
task (str
The type of machine learning task that the dataset is used for.
+
+Supported tasks:
+”classification” (default): Multiclass classification
”regression” : Regression
”multilabel” : Multilabel classification
+
+label_name (str optional ) – The name of the label column in the dataset.
image_key (str optional ) – Optional key that can be specified for image datasets to point to the field containing the actual images themselves.
If specified, additional image-specific issue types can be detected in the dataset.
diff --git a/master/cleanlab/datalab/guide/custom_issue_manager.html b/master/cleanlab/datalab/guide/custom_issue_manager.html
index 615989478..bb3974dcf 100644
--- a/master/cleanlab/datalab/guide/custom_issue_manager.html
+++ b/master/cleanlab/datalab/guide/custom_issue_manager.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/datalab/guide/generating_cluster_ids.html b/master/cleanlab/datalab/guide/generating_cluster_ids.html
index 350d429e2..f2f9a165a 100644
--- a/master/cleanlab/datalab/guide/generating_cluster_ids.html
+++ b/master/cleanlab/datalab/guide/generating_cluster_ids.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/datalab/guide/index.html b/master/cleanlab/datalab/guide/index.html
index ee426e8da..e445bf691 100644
--- a/master/cleanlab/datalab/guide/index.html
+++ b/master/cleanlab/datalab/guide/index.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/datalab/guide/issue_type_description.html b/master/cleanlab/datalab/guide/issue_type_description.html
index d56f01635..840646935 100644
--- a/master/cleanlab/datalab/guide/issue_type_description.html
+++ b/master/cleanlab/datalab/guide/issue_type_description.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/cleanlab/datalab/index.html b/master/cleanlab/datalab/index.html
index f655d21e5..7827d1462 100644
--- a/master/cleanlab/datalab/index.html
+++ b/master/cleanlab/datalab/index.html
@@ -247,6 +247,7 @@
report
+
task
@@ -576,6 +577,7 @@
issue_manager report
+
task
diff --git a/master/cleanlab/datalab/internal/data.html b/master/cleanlab/datalab/internal/data.html
index e28272cf0..ee68c98ce 100644
--- a/master/cleanlab/datalab/internal/data.html
+++ b/master/cleanlab/datalab/internal/data.html
@@ -247,6 +247,7 @@
report
+
task
@@ -559,7 +560,7 @@
-Data
Data
Class that holds and validates datasets for Datalab.
Label
-class cleanlab.datalab.internal.data. Data ( data label_name = None map_to_int = True is_multilabel = False ) [source]
+class cleanlab.datalab.internal.data. Data ( data task label_name = None ) [source] Bases: object
Class that holds and validates datasets for Datalab.
Internally, the data is stored as a datasets.Dataset object and the labels
@@ -714,8 +715,24 @@
label_name (Union[str List[str]]
map_to_int (bool
task (Task
The task associated with the dataset. This is used to determine how to
+to format the labels.
+Note:
+
+
+
will be mapped to integers, e.g. [0, 1, …, K-1] where K is the number
+of classes. If the task is a regression task, the labels will not be
+mapped to integers.
+
+If the task is a multilabel task, the labels will be formatted as a
+list of lists, e.g. [[0, 1], [1, 2], [0, 2]] where each sublist contains
+the labels for a single example. If the task is not a multilabel task,
+the labels will be formatted as a 1D numpy array.
+
+report task Parameters:
data (Data
strategy (_InfoStrategy
strategy (Type _InfoStrategy
report task
REGISTRY
Registry of issue managers that can be constructed from a string and used in the Datalab class.
Registry of issue managers that can be constructed from a task and issue type and used in the Datalab class.
@@ -585,16 +586,41 @@
-cleanlab.datalab.internal.issue_manager_factory. REGISTRY : Dict [ str , Dict [ str , Type [ IssueManager ] ] ]
-Registry of issue managers that can be constructed from a string
+cleanlab.datalab.internal.issue_manager_factory. REGISTRY : Dict [ Task , Dict [ str , Type [ IssueManager ] ] ]
Registry of issue managers that can be constructed from a task and issue type
and used in the Datalab class.
-Currently, the following issue managers are registered by default:
-
+Currently, the following issue managers are registered by default for a given task:
+
+Classification:
+
+
+Regression:
+
+
+Multilabel:
+
+
+
Warning
@@ -611,7 +637,9 @@
cls (Type IssueManager IssueManager
task (str
task (str Task.from_str <cleanlab.datalab.internal.task.Task.from_str>`()
Return type:
@@ -667,8 +695,16 @@
cleanlab.datalab.internal.issue_manager_factory. list_default_issue_types ( task ) [source]
Returns a list of the issue types that are run by default
-when find_issues() issue_types .
-:rtype: List str
+when find_issues() issue_types .
+
+Return type:
+List str
+
+
+task : Specific machine learning task supported by Datalab.
+
See also
REGISTRY
diff --git a/master/cleanlab/datalab/internal/index.html b/master/cleanlab/datalab/internal/index.html
index cabbd4c07..631e9246e 100644
--- a/master/cleanlab/datalab/internal/index.html
+++ b/master/cleanlab/datalab/internal/index.html
@@ -247,6 +247,7 @@
report
+
task
@@ -580,6 +581,10 @@
task
+
diff --git a/master/cleanlab/datalab/internal/issue_finder.html b/master/cleanlab/datalab/internal/issue_finder.html
index 1fd909454..bee50ae2d 100644
--- a/master/cleanlab/datalab/internal/issue_finder.html
+++ b/master/cleanlab/datalab/internal/issue_finder.html
@@ -247,6 +247,7 @@
report task report task report task report task report task report task report task report task report task report task report task report task report task report task report - cleanlab
@@ -247,6 +247,7 @@
report task report
@@ -648,6 +665,8 @@
C
(cleanlab.datalab.internal.data.MultiLabel property)
+
CLASSIFICATION (cleanlab.datalab.internal.task.Task attribute)
+ClassImbalanceIssueManager (class in cleanlab.datalab.internal.issue_manager.imbalance)
ClassLabelScorer (class in cleanlab.internal.multilabel_scorer)
@@ -804,6 +823,13 @@ C
+
+ cleanlab.datalab.internal.task
+
+
@@ -918,6 +944,8 @@ C
module
+
+
cleanlab.internal.validation
@@ -925,8 +953,6 @@ C
module
-
-
- from_str() (cleanlab.internal.multilabel_scorer.ClassLabelScorer class method)
+ from_str() (cleanlab.datalab.internal.task.Task class method)
+
+
@@ -1679,6 +1709,12 @@
I
(cleanlab.datalab.internal.data.MultiLabel property)
+
is_classification (cleanlab.datalab.internal.task.Task property)
+
+
is_multilabel (cleanlab.datalab.internal.task.Task property)
+
+
is_regression (cleanlab.datalab.internal.task.Task property)
+is_tensorflow_dataset() (in module cleanlab.internal.util)
is_torch_dataset() (in module cleanlab.internal.util)
@@ -1920,6 +1956,8 @@ M
cleanlab.datalab.internal.issue_manager_factory
cleanlab.datalab.internal.report
+
+
cleanlab.datalab.internal.task
cleanlab.dataset
@@ -2017,6 +2055,8 @@
M
MultiClass (class in cleanlab.datalab.internal.data)
MultiLabel (class in cleanlab.datalab.internal.data)
+
+
MULTILABEL (cleanlab.datalab.internal.task.Task attribute)
multilabel_health_summary() (in module cleanlab.multilabel_classification.dataset)
@@ -2249,6 +2289,8 @@
R
REGISTRY (in module cleanlab.datalab.internal.issue_manager_factory)
+
+
REGRESSION (cleanlab.datalab.internal.task.Task attribute)
RegressionLabelIssueManager (class in cleanlab.datalab.internal.issue_manager.regression.label)
@@ -2438,6 +2480,8 @@
T
(cleanlab.experimental.mnist_pytorch.SimpleNet attribute)
+
Task (class in cleanlab.datalab.internal.task)
+temp_scale_pred_probs() (in module cleanlab.internal.multiannotator_utils)
test_batch_size (cleanlab.experimental.mnist_pytorch.CNN attribute)
diff --git a/master/index.html b/master/index.html
index ed1606852..c0fb0d405 100644
--- a/master/index.html
+++ b/master/index.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/migrating/migrate_v2.html b/master/migrating/migrate_v2.html
index 6a86064be..b3bbe736b 100644
--- a/master/migrating/migrate_v2.html
+++ b/master/migrating/migrate_v2.html
@@ -247,6 +247,7 @@
report
+
task
diff --git a/master/objects.inv b/master/objects.inv
index 077b158ee..1df5aa507 100644
Binary files a/master/objects.inv and b/master/objects.inv differ
diff --git a/master/py-modindex.html b/master/py-modindex.html
index 2c48873ca..78dc5dc48 100644
--- a/master/py-modindex.html
+++ b/master/py-modindex.html
@@ -237,6 +237,7 @@
report
+
task
@@ -632,6 +633,12 @@
Python Module Index
cleanlab.datalab.internal.report
+
+
+ cleanlab.datalab.internal.task
+
+
diff --git a/master/search.html b/master/search.html
index 93d328ace..f621cbc68 100644
--- a/master/search.html
+++ b/master/search.html
@@ -236,6 +236,7 @@
report task report task 5. Use cleanlab to find label issues