From 4b80541030f1189e1ee75479118e7fe5c98068cc Mon Sep 17 00:00:00 2001
From: elenasamuylova <67064421+elenasamuylova@users.noreply.github.com>
Date: Wed, 29 May 2024 14:20:46 +0100
Subject: [PATCH] Update all-metrics.md
---
docs/book/reference/all-metrics.md | 35 +++++++++++++++++++++++++++---
1 file changed, 32 insertions(+), 3 deletions(-)
diff --git a/docs/book/reference/all-metrics.md b/docs/book/reference/all-metrics.md
index 28856ed466..d66d0bfcb8 100644
--- a/docs/book/reference/all-metrics.md
+++ b/docs/book/reference/all-metrics.md
@@ -186,9 +186,38 @@ How to set [data drift parameters](../customization/options-for-statistical-test
RecSys (Recommender System) Preset
-| Preset name and Description | Parameters |
-|---|---|
-|**`RecsysPreset`**
Evaluates the quality of the recommender system.
Recommendations and true relevance scores are required. For some metrics, training data and item features are required.
**Contents**:
- `PrecisionTopKMetric()`
- `RecallTopKMetric()`
- `FBetaTopKMetric()`
- `MAPKMetric()`
- `NDCGKMetric()`
- `MRRKMetric()`
- `HitRateKMetric()`
- `PersonalizationMetric()`
- `PopularityBias()`
- `RecCasesTable()`
- `ScoreDistribution()`
- `DiversityMetric()`
- `SerendipityMetric()`
- `NoveltyMetric()`
- `ItemBiasMetric()` (pass column as a parameter)
- `UserBiasMetric()`(pass column as a parameter)
| **Required**:
`k`
**Optional**:- `min_rel_score: Optional[int]`
- `no_feedback_users: bool`
- `normalize_arp: bool`
- `user_ids: Optional[List[Union[int, str]]]`
- `display_features: Optional[List[str]]`
- `item_features: Optional[List[str]]`
- `user_bias_columns: Optional[List[str]]`
- `item_bias_columns: Optional[List[str]]`
+`RecsysPreset` evaluates the quality of the recommender system. Recommendations and true relevance scores are required. For some metrics, training data and item features are required.
+
+**Composition**:
+* `PrecisionTopKMetric()`
+* `RecallTopKMetric()`
+* `FBetaTopKMetric()`
+* `MAPKMetric()`
+* `NDCGKMetric()`
+* `MRRKMetric()`
+* `HitRateKMetric()`
+* `PersonalizationMetric()`
+* `PopularityBias()`
+* `RecCasesTable()`
+* `ScoreDistribution()`
+* `DiversityMetric()`
+* `SerendipityMetric()`
+* `NoveltyMetric()`
+* `ItemBiasMetric()` (pass column as a parameter)
+* `UserBiasMetric()`(pass column as a parameter)
+
+**Required parameter**:
+* `k`
+
+**Optional parameters***:
+* `min_rel_score: Optional[int]`
+* `no_feedback_users: bool`
+* `normalize_arp: bool`
+* `user_ids: Optional[List[Union[int, str]]]`
+* `display_features: Optional[List[str]]`
+* `item_features: Optional[List[str]]`
+* `user_bias_columns: Optional[List[str]]`
+* `item_bias_columns: Optional[List[str]]`