update docstrings to be dedent compliant

Author: isabelizimm

vetiver/handlers/sklearn.py

@@ -17,7 +17,8 @@ class SKLearnHandler(BaseHandler):
     pip_name = "scikit-learn"
 
     def handler_predict(self, input_data, check_prototype):
-        """Generates method for /predict endpoint in VetiverAPI
+        """
+        Generates method for /predict endpoint in VetiverAPI
 
         The `handler_predict` function executes at each API call. Use this
         function for calling `predict()` and any other tasks that must be executed
@@ -30,7 +31,7 @@ def handler_predict(self, input_data, check_prototype):
 
         Returns
         -------
-        prediction
+        prediction:
             Prediction from model
         """
 

vetiver/handlers/spacy.py

@@ -54,7 +54,8 @@ def construct_prototype(self):
         return prototype
 
     def handler_predict(self, input_data, check_prototype):
-        """Generates method for /predict endpoint in VetiverAPI
+        """
+        Generates method for /predict endpoint in VetiverAPI
 
         The `handler_predict` function executes at each API call. Use this
         function for calling `predict()` and any other tasks that must be executed
@@ -63,7 +64,9 @@ def handler_predict(self, input_data, check_prototype):
         Parameters
         ----------
         input_data:
-            Test data
+            Test data. The SpacyHandler expects an input of a 1 column DataFrame with
+            the same column names as the prototype data, or column name "text" if no
+            prototype was given.
 
         Returns
         -------

vetiver/handlers/statsmodels.py

@@ -23,7 +23,8 @@ class StatsmodelsHandler(BaseHandler):
         pip_name = "statsmodels"
 
     def handler_predict(self, input_data, check_prototype):
-        """Generates method for /predict endpoint in VetiverAPI
+        """
+        Generates method for /predict endpoint in VetiverAPI
 
         The `handler_predict` function executes at each API call. Use this
         function for calling `predict()` and any other tasks that must be executed

vetiver/handlers/torch.py

@@ -23,7 +23,8 @@ class TorchHandler(BaseHandler):
         pip_name = "torch"
 
     def handler_predict(self, input_data, check_prototype):
-        """Generates method for /predict endpoint in VetiverAPI
+        """
+        Generates method for /predict endpoint in VetiverAPI
 
         The `handler_predict` function executes at each API call. Use this
         function for calling `predict()` and any other tasks that must be executed

vetiver/handlers/xgboost.py

@@ -23,7 +23,8 @@ class XGBoostHandler(BaseHandler):
         pip_name = "xgboost"
 
     def handler_predict(self, input_data, check_prototype):
-        """Generates method for /predict endpoint in VetiverAPI
+        """
+        Generates method for /predict endpoint in VetiverAPI
 
         The `handler_predict` function executes at each API call. Use this
         function for calling `predict()` and any other tasks that must be executed

vetiver/server.py

@@ -186,12 +186,17 @@ def vetiver_post(self, endpoint_fx: Callable, endpoint_name: str = None, **kw):
         if not endpoint_name:
             endpoint_name = endpoint_fx.__name__
 
+        if endpoint_fx.__doc__ is not None:
+            api_desc = dedent(endpoint_fx.__doc__)
+        else:
+            api_desc = None
+
         if self.check_prototype is True:
 
             @self.app.post(
                 urljoin("/", endpoint_name),
                 name=endpoint_name,
-                description=dedent(endpoint_fx.__doc__),
+                description=api_desc,
             )
             async def custom_endpoint(input_data: List[self.model.prototype]):
                 _to_frame = api_data_to_frame(input_data)