Reformatting, improve docstring and fixing type hints for python < 3.12

Author: amanjaiswal73892

src/agentlab/analyze/inspect_results.py

@@ -276,7 +276,9 @@ def summarize(sub_df):
         if "stats.cum_cost" in sub_df:
             record["cum_cost"] = sub_df["stats.cum_cost"].sum(skipna=True).round(4)
         if "stats.cum_effective_cost" in sub_df:
-            record["cum_effective_cost"] = sub_df["stats.cum_effective_cost"].sum(skipna=True).round(4)
+            record["cum_effective_cost"] = (
+                sub_df["stats.cum_effective_cost"].sum(skipna=True).round(4)
+            )
             record.pop("cum_cost", None)
 
     return pd.Series(record)

src/agentlab/llm/response_api.py

@@ -26,8 +26,8 @@
 """
 
 
-type ContentItem = Dict[str, Any]
-type Message = Dict[str, Union[str, List[ContentItem]]]
+ContentItem = Dict[str, Any]
+Message = Dict[str, Union[str, List[ContentItem]]]
 
 
 @dataclass

src/agentlab/llm/tracking.py

@@ -173,7 +173,9 @@ def __call__(self, *args, **kwargs):
     def fetch_pricing_information_from_provider(self) -> Optional[dict]:
         """
         Fetch the pricing information dictionary for the given provider.
-        Returns a dict mapping model names to pricing info, or None if not found.
+
+        Returns:
+            Optional[dict]: A dict mapping model names to pricing info, or None if not found.
         """
         pricing_fn_map = {
             "openai": get_pricing_openai,
@@ -248,11 +250,19 @@ def get_effective_cost(self, response):
             )
             return 0.0
 
-    def get_effective_cost_from_antrophic_api(self, response):
-        """Get the effective cost from the Anthropic API response.
-        ## Anthropic usage 'input_tokens' are new input tokens (tokens that are not cached).
-        ## Anthorphic has different pricing for cache write and cache read tokens.
-        ## See https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching#tracking-cache-performance
+    def get_effective_cost_from_antrophic_api(self, response) -> float:
+        """
+        Get the effective cost from the Anthropic API response.
+
+        Anthropic usage 'input_tokens' are new input tokens (tokens that are not cached).
+        Anthropic has different pricing for cache write and cache read tokens.
+        See https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching#tracking-cache-performance
+
+        Args:
+            response: The response object from the Anthropic API.
+
+        Returns:
+            float: The effective cost calculated from the response.
         """
         usage = getattr(response, "usage", {})
         new_input_tokens = getattr(usage, "input_tokens", 0)  # new input tokens
@@ -272,13 +282,21 @@ def get_effective_cost_from_antrophic_api(self, response):
         )
         return effective_cost
 
-    def get_effective_cost_from_openai_api(self, response):
-        """Get the effective cost from the OpenAI API response.
-        ## OpenAI usage 'prompt_tokens' are the total input tokens (cache read tokens + new input tokens).
-        ## See https://openai.com/index/api-prompt-caching/
-        ## OpenAI has only one price for cache tokens i.e. cache read price. (Generally 50% cheaper)
-        ## OpenAI had no extra charge for cache write tokens.
-        ## See Pricing Here: https://platform.openai.com/docs/pricing
+    def get_effective_cost_from_openai_api(self, response) -> float:
+        """
+        Get the effective cost from the OpenAI API response.
+
+        OpenAI usage 'prompt_tokens' are the total input tokens (cache read tokens + new input tokens).
+        See https://openai.com/index/api-prompt-caching/
+        OpenAI has only one price for cache tokens, i.e., cache read price (generally 50% cheaper).
+        OpenAI has no extra charge for cache write tokens.
+        See Pricing Here: https://platform.openai.com/docs/pricing
+
+        Args:
+            response: The response object from the OpenAI API.
+
+        Returns:
+            float: The effective cost calculated from the response.
         """
         usage = getattr(response, "usage", {})
         prompt_token_details = getattr(response, "prompt_tokens_details", {})