ENH: small modifs

artefactory · Mar 14, 2024 · 73601b5 · 73601b5
1 parent 72d2fcf
commit 73601b5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/choice_learn/datasets/data/__init__.py b/choice_learn/datasets/data/__init__.py
@@ -1 +1 @@
-"""Directory to store datasets as .csv.gz files."""
+"""Directory to store datasets as zipped .csv files."""
diff --git a/choice_learn/models/rumnet.py b/choice_learn/models/rumnet.py
@@ -443,6 +443,17 @@ class PaperRUMnet(ChoiceModel):
     Representing Random Utility Choice Models with Neural Networks from Ali Aouad and Antoine Désir
     https://arxiv.org/abs/2207.12877
 
+    --- Attention: ---
+    Note that the model uses two type of features that are treated differently:
+        - customer features
+        - product features
+    >>> In this implementation, please make sure that the features are correctly formatted:
+        - customer features: (n_contexts, n_features) are given as 'contexts_features' in the
+        ChoiceDataset used to fit the model
+        - product features: (n_contexts, n_items, n_features) are given as 'contexts_items_features'
+        in the ChoiceDataset used to fit the model
+    ---
+
     Inherits from base_model.ChoiceModel
     TODO: Verify that all parameters are implemented.
     """
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		"""Directory to store datasets as .csv.gz files."""
		"""Directory to store datasets as zipped .csv files."""