Skip to content

Commit 3fdcb39

Browse files
committed
fixes
1 parent b65b652 commit 3fdcb39

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

md-docs/user_guide/task.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A Task is associated with a unique identifier that will be used by SDK to operat
99
The identifier can be retrieved from the Task homepage or by looking at the url.
1010

1111
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.
1313

1414
Moreover, in the Task homepage is present the section named "Data events" which shows the most recent detection events generated by the monitoring module.
1515
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:
2525
| Name | Name of the Task, unique for the Project. |
2626
| Tags | Optional customizable list of tags. They are used to better describe the Task and to improve search. |
2727
| 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> |
2929
|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. |
3030
| 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. |
3234

3335
!!! warning
3436
Some Task's attributes are immutable: type, data structure and optional target flag cannot be modified after the creation of the Task.
3537

38+
## Platform modules and Task Type compatibility
39+
3640
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:
3842

3943
| Module | Regression | Classification | RAG | Object Detection |
4044
| --------- | --------- | --------- | --------- | --------- |
@@ -46,21 +50,21 @@ Indeed, each task type has a set of ML cube Platform modules:
4650
| LLM Security | :material-close: | :material-close: | :material-check: | :material-close: |
4751

4852
!!! Tip
49-
On the left side of the web app page is present the Task menù with links to the above mentioned modules and Task settings.
53+
On the left side of the web app page the Task menù is present, with links to the above mentioned modules and Task settings.
5054

5155
## Task Type
5256

53-
ML cube Platform supports several task types providing specific features for each of them.
54-
Not all task types are compatible with data structures, in the table below are shown which data structure is supported by which task type:
57+
ML cube Platform supports several Task Types providing specific features for each of them.
58+
Not all Task Types are compatible with data structures, in the table below are shown which data structure is supported by which Task Type:
5559

56-
|Task type| Tabular | Image | Text | Embedding|
60+
|Task Type| Tabular | Image | Text | Embedding|
5761
| -- | -- | -- | -- | -- |
5862
| Regression | :material-check: | :material-check: | :material-check: | :material-check: |
5963
| Classification | :material-check: | :material-check: | :material-check: | :material-check: |
6064
| RAG | :material-close: | :material-close: | :material-check: | :material-check: |
6165
| Object Detection | :material-close: | :material-check: | :material-close: | :material-check: |
6266

63-
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.
6468

6569
### Regression
6670

@@ -103,7 +107,7 @@ $$
103107
where $N_{FP}$ and $N_{FN}$ are the number of false positives and false negatives respectively.
104108

105109
- **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
107111

108112
Given a data batch, the mean cost $\bar{C}$ is expressed as
109113
$$
@@ -125,20 +129,20 @@ where $N_{FP}^{k}$ and $N_{FN}^{k}$ are the number of false positives and false
125129

126130
### Retrieval Augmented Generation
127131

128-
Retrieval Augmented Generation is a particular AI task for Text data based on Large Language Models to 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.
129133

130134
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:
132136

133137
- User Input: the user query that the model needs to answer
134138
- Retrieved Context: the set of documents the retrieval engine selected to help the model
135139

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.
137141

138142
!!! example
139-
Context separator: <CONTEXT>
143+
Context separator: <<sep>>
140144

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.
142146

143147
Contexts:
144148

0 commit comments

Comments
 (0)