Update llm/apimodels/hf_model.py

llm/apimodels/hf_model.py

@@ -520,4 +520,76 @@ class HF_Qwen2(HFInterface, ABC):
           `HF_Qwen2(llm=not initialized)`, indicating the state.
         """
         llm_info = f"llm={self.llm}" if hasattr(self, 'llm') else 'llm=not initialized'
+        return f"{self.__class__.__name__}({llm_info})"
+
+class FreeThinker3B(HFInterface, ABC):
+    """
+    This class represents an interface for the FreeThinker3B small language model from Hugging Face.
+    It inherits from `HFInterface` (likely an interface from a Hugging Face library)
+    and `ABC` (for abstract base class) to enforce specific functionalities.
+    """
+
+    def __init__(self):
+        """
+        Initializer for the `FreeThinker3B` class.
+        - Retrieves configuration values for the FreeThinker3B model from a `config` dictionary:
+            - `repo_id`: The ID of the repository containing the FreeThinker3B model on Hugging Face.
+            - `max_length`: Maximum length of the generated text.
+            - `temperature`: Controls randomness in the generation process.
+            - `top_k`: Restricts the vocabulary used for generation.
+        - Raises a `ValueError` if the `api` key (presumably stored elsewhere) is missing.
+        - Creates an instance of `HuggingFaceEndpoint` using the retrieved configuration
+          and the `api` key.
+        """
+
+        repo_id = config["FreeThinker3B"]["model"]
+        max_length = config["FreeThinker3B"]["max_new_tokens"]
+        temperature = config["FreeThinker3B"]["temperature"]
+        top_k = config["FreeThinker3B"]["top_k"]
+
+        if not _api:
+            raise ValueError(f"API key not provided {_api}")
+
+        self.llm = HuggingFaceEndpoint(
+            repo_id=repo_id, max_length=max_length, temperature=temperature, top_k=top_k, token=_api
+        )
+
+    def execution(self) -> Any:
+        """
+        This method attempts to return the underlying `llm` (likely a language model object).
+        It wraps the retrieval in a `try-except` block to catch potential exceptions.
+        On success, it returns the `llm` object.
+        On failure, it logs an error message with the exception details using a logger
+        (assumed to be available elsewhere).
+        """
+        try:
+            return self.llm  # `invoke()`
+        except Exception as e:
+            print(f"Something wrong with API or HuggingFaceEndpoint: {e}")
+
+    def model_name(self):
+        """
+        Simple method that returns the FreeThinker3B model name from the configuration.
+        This can be useful for identifying the specific model being used.
+        """
+        return config["HF_Qwen2"]["model"]
+
+    def __str__(self):
+        """
+        Defines the string representation of the `FreeThinker3B` object for human readability.
+        It combines the class name and the model name retrieved from the `model_name` method
+        with an underscore separator.
+        """
+        return f"{self.__class__.__name__}_{self.model_name()}"
+
+    def __repr__(self):
+        """
+        Defines the representation of the `FreeThinker3B` object for debugging purposes.
+        It uses `hasattr` to check if the `llm` attribute is set.
+        - If `llm` exists, it returns a string like `FreeThinker3B(llm=HuggingFaceEndpoint(...))`,
+          showing the class name and the `llm` object information.
+        - If `llm` is not yet set (during initialization), it returns
+          `FreeThinker3B(llm=not initialized)`, indicating the state.
+        """
+        llm_info = f"llm={self.llm}" if hasattr(self, 'llm') else 'llm=not initialized'
         return f"{self.__class__.__name__}({llm_info})"