Skip to content

Commit fefb114

Browse files
committed
few notes
1 parent 4ac0545 commit fefb114

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

md-docs/user_guide/model.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Model
22

3-
In the ML Cube Platform, a Model is a representation of the actual machine learning model used for making predictions. The data used
3+
In the ML Cube Platform, a Model is a representation of the actual artificial intelligence model used for making predictions. The data used
44
for its training usually represent the reference data distribution, while production data comprises the data on which the model
55
performs inference.
6+
For more information about reference and production data see the [Data] page.
67

78
A Model is uniquely associated with a [Task] and it can be created both through the WebApp and the Python SDK.
89
Currently, we support only one model per Task.
@@ -39,13 +40,20 @@ the ML cube Platform will use this information to compute additional metrics and
3940
It is optional and currently supported only for Classification and RAG tasks. If specified, the probabilistic output must be provided
4041
as a new column in the predictions file, following the guidelines in the [Data Schema] page.
4142

43+
!!! example
44+
For example, Logistic Regression classification model provides both the probability of belonging to the positive class and the predicted class using a threshold.
45+
In this case, you can upload to ML cube Platform the predicted class as principal prediction and the probability as probabilistic output.
46+
4247
### Model Metric
4348

4449
A Model Metric represents the evaluation metric used to assess the performance of the model.
4550
It can both represent a performance or an error. The chosen metric will be used in the various views of the WebApp to
4651
provide insights on the model's performance and in the [Performance View](modules/retraining.md#performance-view) section
4752
of the Retraining Module.
4853

54+
!!! note
55+
Note that model metrics can only be computed when target data are available.
56+
4957
The available options are:
5058

5159
| Metric | Task Type |
@@ -81,4 +89,5 @@ from the ML cube Platform. More information on how to set up a retrain trigger c
8189

8290
[Task]: task.md
8391
[Data Schema]: data_schema.md#subrole
84-
[Retrain Trigger]: integrations/retrain_trigger.md
92+
[Retrain Trigger]: integrations/retrain_trigger.md
93+
[Data]: data.md

0 commit comments

Comments
 (0)