Create explainable user model classes

.gitignore

@@ -24,3 +24,4 @@ data/users.db
 
 # local experimentation
 local/
+.vscode/

moviebot/explainability/explainable_user_model.py

@@ -13,14 +13,14 @@ class ExplainableUserModel(ABC):
     def generate_explanation(
         self, user_preferences: UserPreferences
     ) -> AnnotatedUtterance:
-        """Generate an explanation based on the provided input data.
+        """Generates an explanation based on the provided input data.
 
         Args:
             input_data: The input data for which an explanation is to be
             generated.
 
         Returns:
-            The generated explanation.
+            A system utterance containing an explanation.
 
         Raises:
             NotImplementedError: This method must be implemented by a subclass.

moviebot/explainability/explainable_user_model_tag_based.py

@@ -1,9 +1,13 @@
-"""This module contains the ExplainableUserModelTagBased class.
+"""Class for creating a tag-based user model explanations.
 
-The class generates explanations for user preferences in the movie domain based
-on templates loaded from a YAML file.
+The class generates explanations for user preferences in the movie domain.
+Currently, the explanations are based on the explicit movie tags/attributes.
+Future versions of the class will also support implicit tags/attributes, which
+are inferred from the movie recommendation feedback. Explanations are based on
+the templates loaded from a YAML file.
 """
 
+import os
 import random
 import re
 
@@ -16,27 +20,35 @@
     UserPreferences,
 )
 
-_DEFAULT_TEMPLATE_FILE = "moviebot/explainability/explanation_templates.yaml"
+_DEFAULT_TEMPLATE_FILE = "data/explainability/explanation_templates.yaml"
 
 
 class ExplainableUserModelTagBased(ExplainableUserModel):
     def __init__(self, template_file: str = _DEFAULT_TEMPLATE_FILE):
-        """Initialize the ExplainableUserModelTagBased class.
+        """Initializes the ExplainableUserModelTagBased class.
 
         Args:
             template_file: Path to the YAML file containing explanation
-            templates. Defaults to _DEFAULT_TEMPLATE_FILE.
+                templates. Defaults to _DEFAULT_TEMPLATE_FILE.
+
+        Raises:
+            FileNotFoundError: The template file could not be found.
         """
+        if not os.isfile(template_file):
+            raise FileNotFoundError(
+                f"Could not find template file {template_file}."
+            )
+
         with open(template_file, "r") as f:
             self.templates = yaml.safe_load(f)
 
     def generate_explanation(
         self, user_preferences: UserPreferences
     ) -> AnnotatedUtterance:
-        """Generate an explanation based on the provided user preferences.
+        """Generates an explanation based on the provided user preferences.
 
         Args:
-            user_preferences: Nested dictionary of user preferences.
+            user_preferences: User preferences.
 
         Returns:
             The generated explanation.
@@ -68,7 +80,7 @@ def _clean_negative_keyword(
 
         Args:
             template: Template containing negative keyword.
-            remove: If True, remove the negative keyword.
+            remove: If True, remove the negative keyword. Defaults to True.
 
         Returns:
             Template with negative keyword removed or replaced.

tests/explainability/test_explainable_user_model_tag_based.py

@@ -6,10 +6,8 @@
 
 
 @pytest.fixture
-def explainable_model():
-    return ExplainableUserModelTagBased(
-        "moviebot/explainability/explanation_templates.yaml"
-    )
+def explainable_model() -> ExplainableUserModelTagBased:
+    return ExplainableUserModelTagBased()
 
 
 def test_generate_explanation_positive(explainable_model):