Add example for get_model_status

huggingface · Sep 8, 2023 · 3734d74 · 3734d74
1 parent 681815c
commit 3734d74
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/src/huggingface_hub/inference/_client.py b/src/huggingface_hub/inference/_client.py
@@ -1894,6 +1894,14 @@ def get_model_status(self, model: Optional[str] = None) -> ModelStatus:
         Returns:
             [`ModelStatus`]: An instance of ModelStatus dataclass, containing information,
                          about the state of the model: load, state, compute type and framework.
+
+        Example:
+        ```py
+        >>> from huggingface_hub import InferenceClient
+        >>> client = InferenceClient()
+        >>> client.get_model_status("bigcode/starcoder")
+        ModelStatus(loaded=True, state='Loaded', compute_type='gpu', framework='text-generation-inference')
+        ```
         """
         model = model or self.model
         if model is None:

diff --git a/src/huggingface_hub/inference/_generated/_async_client.py b/src/huggingface_hub/inference/_generated/_async_client.py
@@ -1923,6 +1923,15 @@ async def get_model_status(self, model: Optional[str] = None) -> ModelStatus:
         Returns:
             [`ModelStatus`]: An instance of ModelStatus dataclass, containing information,
                          about the state of the model: load, state, compute type and framework.
+
+        Example:
+        ```py
+        # Must be run in an async context
+        >>> from huggingface_hub import AsyncInferenceClient
+        >>> client = AsyncInferenceClient()
+        >>> await client.get_model_status("bigcode/starcoder")
+        ModelStatus(loaded=True, state='Loaded', compute_type='gpu', framework='text-generation-inference')
+        ```
         """
         model = model or self.model
         if model is None: