You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: md-docs/user_guide/task.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ A Task is associated with a unique identifier that will be used by SDK to operat
9
9
The identifier can be retrieved from the Task homepage or by looking at the url.
10
10
11
11
A Task has a *status* that summarizes the health of its AI model.
12
-
The status depends on the monitoring module and changes from Ok, Warning or Drift when the Monitoring modules detects drifts on monitored quantities.
12
+
The status depends on the monitoring module and changes from Ok, Warning or Drift when the Monitoring modules detect drifts on monitored quantities.
13
13
14
14
Moreover, in the Task homepage is present the section named "Data events" which shows the most recent detection events generated by the monitoring module.
15
15
It is possible to click on *view* to see more details or discard the notification (the event will remain available for future analysis on the [Detection] page).
@@ -25,16 +25,20 @@ Generic attributes are:
25
25
| Name | Name of the Task, unique for the Project. |
26
26
| Tags | Optional customizable list of tags. They are used to better describe the Task and to improve search. |
27
27
| Task type | Artificial intelligence type of Task. Possible values are:<br><ul><li>[Regression](task.md#regression)</li><li>[Binary classification](task.md#classification)</li><li>[Multiclass classification](task.md#classification)</li><li>[Multilabel classification](task.md#classification)</li><li>[Retrieval Augmented Generation](task.md#retrieval-augmented-generation)</li><li>[Object Detection](task.md#object-detection)</li></ul>|
28
-
| Data structure | Type of input data the Task uses. Possible values are:<br><ul><li>Tabular: standard table based data used in contexts like regression or classification.</li><li>Image: images in their different formats and channels.</li><li>Text: textual data expressed as strings. When data structure is Text, attribute *Text Language* is required.</li><li>Embeddings: input data are arrays that could represent embedding either image or text data. This data structure is used when raw data are not shared with ML cube Platform.</li></ul> |
28
+
| Data structure | Type of input data the Task uses. Possible values are:<br><ul><li>Tabular: standard table based data used in contexts like regression or classification.</li><li>Image: images in their different formats and channels.</li><li>Text: textual data expressed as strings. When data structure is Text, attribute *Text Language* is required.</li><li>Embedding: input data are arrays that could represent embedding either image or text data. This data structure is used when raw data are not shared with ML cube Platform.</li></ul> |
29
29
|Optional target| Boolean value that specifies if the ground truth is always available or not. In some Tasks, the actual value is not present until explicit labeling is done. In this cases, the Task is marked as with optional target so that ML cube Platform works accordingly. |
30
30
| Cost info | Optional information about costs that depend on Task Type. |
31
-
31
+
| Text language | Which language is used in the Task when input data structure is text.|
32
+
|Positive class| Required when Task Type is Binary Classification, it indicates the positive class to be predicted.|
33
+
|Context separator| Available when Task Type is RAG, it specifies the string separator to split retrieved context into different chunks. |
32
34
33
35
!!! warning
34
36
Some Task's attributes are immutable: type, data structure and optional target flag cannot be modified after the creation of the Task.
35
37
38
+
## Platform modules and Task Type compatibility
39
+
36
40
Most of ML cube Platform operations are done at Task level: monitoring, retraining, analytics and other features are specific to AI models and data that belong to a Task.
37
-
Indeed, each task type has a set of ML cube Platform modules:
41
+
Indeed, each Task Type has a set of ML cube Platform modules:
In the following sections, you can find a description of each task type with its specific information.
67
+
In the following sections, you can find a description of each Task Type with its specific information.
64
68
65
69
### Regression
66
70
@@ -103,7 +107,7 @@ $$
103
107
where $N_{FP}$ and $N_{FN}$ are the number of false positives and false negatives respectively.
104
108
105
109
-**Multiclass:**
106
-
- $c_{k}$ is the cost of misclassifying a sample which actual class is $k$ with another class
110
+
- $c_{k}$ is the cost of misclassifying a sample, whose actual class is $k$, with another class
107
111
108
112
Given a data batch, the mean cost $\bar{C}$ is expressed as
109
113
$$
@@ -125,20 +129,20 @@ where $N_{FP}^{k}$ and $N_{FN}^{k}$ are the number of false positives and false
125
129
126
130
### Retrieval Augmented Generation
127
131
128
-
Retrieval Augmented Generation is a particular AI task for Text data based on Large Language Modelsto generate responses of user query using a set of retrieved documents as context to generate a precise and more focused response.
132
+
Retrieval Augmented Generation is a particular AI task for Text data based on Large Language Models, in which they are used to generate responses of user query using a set of retrieved documents as context to provide a precise and more focused response.
129
133
130
134
RAG Tasks, do not have a Target therefore, the attribute *optional target* is always set to True.
131
-
Moreover, in this Task, the Target is a text as well and the input is composed of two entities:
135
+
Moreover, in this Task, the Prediction is a text as well and the input is composed of two entities:
132
136
133
137
- User Input: the user query that the model needs to answer
134
138
- Retrieved Context: the set of documents the retrieval engine selected to help the model
135
139
136
-
RAG tasks has additional attribute *context separator* which is string used to separate different retrieved contexts into chunks. Context data is sent as a single string, however, in RAG settings multiple documents can be retrieved. In this case, context separator is used to distinguish them. It is optional since a single context can be provided.
140
+
RAG tasks has additional the attribute *context separator* which is a string used to separate different retrieved contexts into chunks. Context data is sent as a single string, however, in RAG settings multiple documents can be retrieved. In this case, context separator is used to distinguish them. It is optional since a single context can be provided.
137
141
138
142
!!! example
139
-
Context separator: <CONTEXT>
143
+
Context separator: <<sep>>
140
144
141
-
Context data: The capital of Italy is Rome.<CONTEXT>Rome is the capital of Italy.<CONTEXT>Rome was the capital of Roman Empire.
145
+
Context data: The capital of Italy is Rome.<<sep>>Rome is the capital of Italy.<<sep>>Rome was the capital of Roman Empire.
0 commit comments