Fix typos and documentation (#946)

dftimewolf/lib/processors/llm_base.py

@@ -56,7 +56,7 @@ def SetUp(self, provider_name: str, model_name: str, task: str) -> None:  # pyli
     provider_class = llm_manager.LLMProviderManager.GetProvider(
         provider_name=provider_name
     )
-    self.provider = provider_class()
+    self.provider = provider_class()  # pytype: disable=not-instantiable
     assert self.provider  # to appease mypy
 
     if model_name not in self.provider.models:

dftimewolf/lib/processors/llmproviders/gemini.py

@@ -114,7 +114,7 @@ def Generate(self, prompt: str, model: str, **kwargs: str) -> str:
       The model output.
 
     Raises:
-      Exception on an error occuring when generating content.
+      Exception on an error occurring when generating content.
     """
     genai_model = self._get_model(model)
     try:
@@ -155,7 +155,7 @@ def GenerateWithHistory(self, prompt: str, model: str, **kwargs: str) -> str:
       The model output.
 
     Raises:
-      Exception on an error occuring when generating content.
+      Exception on an error occurring when generating content.
     """
     if not self.chat_session:
       self.chat_session = self._get_model(model).start_chat()

dftimewolf/lib/processors/llmproviders/interface.py

@@ -47,7 +47,7 @@ def _LoadConfig(self) -> None:
     See /data/config.json for an example.
 
     Raises:
-      RuntimeError - if there are no configurations for the LLM provider.
+      RuntimeError: if there are no configurations for the LLM provider.
     """
     llm_provider_config = config.Config.GetExtra(BASE_CONFIG_KEY)
     if not llm_provider_config:
@@ -72,7 +72,7 @@ def Generate(self, prompt: str, model: str, **kwargs: str) -> str:
     Args:
       prompt: The prompt to use for the generation.
       model: The provider model to use.
-      kwargs: Optional keyword arguments to configure the provider.
+      **kwargs: Optional keyword arguments to configure the provider.
 
     Returns:
       The model output.
@@ -89,7 +89,7 @@ def GenerateFromTemplate(
     Args:
       template: The prompt template.
       model: The provider model to use.
-      kwargs: Additional keyword arguments to format the template and
+      **kwargs: Additional keyword arguments to format the template and
           optional keyword arguments to configure the provider.
 
     Returns:
@@ -111,7 +111,7 @@ def GenerateWithHistory(
     Args:
       prompt: The prompt to use for model generation.
       model: The provider model to use.
-      kwargs: Optional keyword arguments to configure the provider.
+      **kwargs: Optional keyword arguments to configure the provider.
 
     Returns:
       The model output.
@@ -128,7 +128,7 @@ def GenerateFromTemplateWithHistory(
     Args:
       template: The prompt template to use for model generation.
       model: The provider model to use.
-      kwargs: Additional keyword arguments to format the template and
+      **kwargs: Additional keyword arguments to format the template and
           optional keyword arguments to configure the provider.
 
     Returns:

dftimewolf/lib/processors/llmproviders/manager.py

@@ -5,7 +5,7 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-  from dftimewolf.lib.providers import interface
+  from dftimewolf.lib.processors.llmproviders import interface
 
 
 class LLMProviderManager:

dftimewolf/metawolf/utils.py

@@ -223,7 +223,7 @@ def RunInBackground(processes: List['output.MetawolfProcess']) -> bool:
     while q not in [False, True]:
       value = input('[Yn]? ') or 'y'
       q = Str2Bool(str(value))
-    return q
+    return q  # pytype: disable=bad-return-type
   return True
 
 

tests/lib/processors/llmproviders/manager.py

@@ -18,10 +18,10 @@ def GenerateWithHistory(self, prompt: str, model: str, **kwargs) -> str:
 
 
 class LLMProviderManagerTests(unittest.TestCase):
-  """Unit tests for the LLMProviderManager"""
+  """Unit tests for the LLMProviderManager."""
 
   def testManager(self):
-    """Tests the LLMProviderManager"""
+    """Tests the LLMProviderManager."""
     with self.subTest('not registered'):
       with self.assertRaisesRegex(KeyError, 'No such provider'):
         manager.LLMProviderManager.GetProvider('test')