Fix C0116: Missing function or method docstring (missing-function-docstring)

Signed-off-by: Mattt Zmuda <[email protected]>

Fix C0116: Missing function or method docstring (missing-function-docstring)

Signed-off-by: Mattt Zmuda <[email protected]>

Author: mattt

replicate/client.py

@@ -84,18 +84,30 @@ def _request(self, method: str, path: str, **kwargs) -> httpx.Response:
 
     @property
     def models(self) -> ModelCollection:
+        """
+        Namespace for operations related to models.
+        """
         return ModelCollection(client=self)
 
     @property
     def predictions(self) -> PredictionCollection:
+        """
+        Namespace for operations related to predictions.
+        """
         return PredictionCollection(client=self)
 
     @property
     def trainings(self) -> TrainingCollection:
+        """
+        Namespace for operations related to trainings.
+        """
         return TrainingCollection(client=self)
 
     @property
     def deployments(self) -> DeploymentCollection:
+        """
+        Namespace for operations related to deployments.
+        """
         return DeploymentCollection(client=self)
 
     def run(self, model_version: str, **kwargs) -> Union[Any, Iterator[Any]]:  # noqa: ANN401

replicate/deployment.py

@@ -38,6 +38,12 @@ class DeploymentCollection(Collection):
     model = Deployment
 
     def list(self) -> List[Deployment]:
+        """
+        List deployments.
+
+        Raises:
+            NotImplementedError: This method is not implemented.
+        """
         raise NotImplementedError()
 
     def get(self, name: str) -> Deployment:
@@ -56,6 +62,12 @@ def get(self, name: str) -> Deployment:
         return self.prepare_model({"username": username, "name": name})
 
     def create(self, **kwargs) -> Deployment:
+        """
+        Create a deployment.
+
+        Raises:
+            NotImplementedError: This method is not implemented.
+        """
         raise NotImplementedError()
 
     def prepare_model(self, attrs: Union[Deployment, Dict]) -> Deployment:
@@ -74,6 +86,12 @@ def __init__(self, client: "Client", deployment: Deployment) -> None:
         self._deployment = deployment
 
     def list(self) -> List[Prediction]:
+        """
+        List predictions in a deployment.
+
+        Raises:
+            NotImplementedError: This method is not implemented.
+        """
         raise NotImplementedError()
 
     def get(self, id: str) -> Prediction:

replicate/model.py

@@ -136,6 +136,12 @@ def get(self, key: str) -> Model:
         return self.prepare_model(resp.json())
 
     def create(self, **kwargs) -> Model:
+        """
+        Create a model.
+
+        Raises:
+            NotImplementedError: This method is not implemented.
+        """
         raise NotImplementedError()
 
     def prepare_model(self, attrs: Union[Model, Dict]) -> Model:

replicate/version.py

@@ -76,7 +76,6 @@ def __init__(self, client: "Client", model: "Model") -> None:
         super().__init__(client=client)
         self._model = model
 
-    # doesn't exist yet
     def get(self, id: str) -> Version:
         """
         Get a specific model version.
@@ -92,6 +91,12 @@ def get(self, id: str) -> Version:
         return self.prepare_model(resp.json())
 
     def create(self, **kwargs) -> Version:
+        """
+        Create a model version.
+
+        Raises:
+            NotImplementedError: This method is not implemented.
+        """
         raise NotImplementedError()
 
     def list(self) -> List[Version]: