Add docstrings

huggingface · Dec 13, 2024 · f654848 · f654848
1 parent c9cff7b
commit f654848
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/src/lighteval/models/endpoints/endpoint_model.py b/src/lighteval/models/endpoints/endpoint_model.py
@@ -111,6 +111,14 @@ def __post_init__(self):
 
     @classmethod
     def from_path(cls, path: str) -> "InferenceEndpointModelConfig":
+        """Load configuration for inference endpoint model from YAML file path.
+
+        Args:
+            path (`str`): Path of the model configuration YAML file.
+
+        Returns:
+            [`InferenceEndpointModelConfig`]: Configuration for inference endpoint model.
+        """
         import yaml
 
         with open(path, "r") as f:

diff --git a/src/lighteval/models/endpoints/tgi_model.py b/src/lighteval/models/endpoints/tgi_model.py
@@ -53,6 +53,14 @@ class TGIModelConfig:
 
     @classmethod
     def from_path(cls, path: str) -> "TGIModelConfig":
+        """Load configuration for TGI endpoint model from YAML file path.
+
+        Args:
+            path (`str`): Path of the model configuration YAML file.
+
+        Returns:
+            [`TGIModelConfig`]: Configuration for TGI endpoint model.
+        """
         import yaml
 
         with open(path, "r") as f: