Skip to content

Commit f11177d

Browse files
committed
updates
1 parent 6fb567e commit f11177d

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

md-docs/user_guide/task.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,34 @@ A Task represents an ordinary artificial intelligence task like regression, clas
55

66
A Task is associated with a [Model] and a [Data schema] that describes all the information about the data in the Task.
77

8+
A Task is associated with a unique identifier that will be used by SDK to operate on it.
9+
The identifier can be retrieved from the Task homepage or by looking at the url.
10+
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.
13+
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+
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).
16+
17+
## Attributes
18+
819
A Task is described by a set of attributes specified during its creation.
9-
Some attributes are common for every Task while, others vary according to its type.
20+
Some attributes are common for every Task, while others vary according to its type.
1021
Generic attributes are:
1122

1223
| Attribute | Description |
1324
|--|--|
1425
| Name | Name of the Task, unique for the Project. |
15-
| Tags | Optional customizable list of tags. It is used to better describe the Task and to improve search. |
26+
| Tags | Optional customizable list of tags. They are used to better describe the Task and to improve search. |
1627
| 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>|
17-
| Data structure | Type of input data the Task uses. Possible values are:<br><ul><li>Tabular</li><li>Image</li><li>Text: 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>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> |
1829
|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. |
1930
| Cost info | Optional information about costs that depend on Task Type. |
2031

32+
33+
!!! warning
34+
Some Task's attributes are immutable: type, data structure and optional target flag cannot be modified after the creation of the Task.
35+
2136
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.
2237
Indeed, each task type has a set of ML cube Platform modules:
2338

@@ -30,9 +45,12 @@ Indeed, each task type has a set of ML cube Platform modules:
3045
| RAG Evaluation | :material-close: | :material-close: | :material-check: | :material-close: |
3146
| LLM Security | :material-close: | :material-close: | :material-check: | :material-close: |
3247

48+
!!! 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.
50+
3351
## Task Type
3452

35-
ML cube Platform support several task types providing specific features for each of them.
53+
ML cube Platform supports several task types providing specific features for each of them.
3654
Not all task types are compatible with data structures, in the table below are shown which data structure is supported by which task type:
3755

3856
|Task type| Tabular | Image | Text | Embedding|
@@ -117,10 +135,23 @@ Moreover, in this Task, the Target is a text as well and the input is composed o
117135

118136
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.
119137

138+
!!! example
139+
Context separator: <CONTEXT>
140+
141+
Context data: The capital of Italy is Rome.<CONTEXT>Rome is the capital of Italy.<CONTEXT>Rome was the capital of Roman Empire.
142+
143+
Contexts:
144+
145+
- The capital of Italy is Rome.
146+
- Rome is the capital of Italy.
147+
- Rome was the capital of Roman Empire.
148+
149+
120150
### Object Detection
121151

122152
Object Detection task processes images and provides as output a list of bounding boxes with associated label indicating the type of identified entity.
123153
Therefore, target is a list of four elements tuples indicating the vertex of the box and a string label for the entity type.
124154

125155
[Model]: model.md
126-
[Data schema]: data_schema.md
156+
[Data schema]: data_schema.md
157+
[Detection]: detection.md

0 commit comments

Comments
 (0)