Documentation for modelParameters

Author: djm21

src/sasctl/pzmm/modelParameters.py

@@ -5,6 +5,20 @@
 
 
 def find_file(model, fileName):
+    """
+    Retrieves first file from specified model that contains fileName as a substring.
+    Parameters
+    ----------
+    model : str
+        ID of the model the desired file is located in
+    fileName : str
+        The name of the desired file, or a substring that is contained within the file name
+    Returns
+    -------
+    RestObj
+        The first file with a name containing fileName
+
+    """
     from ..core import current_session
 
     sess = current_session()
@@ -22,6 +36,18 @@ def find_file(model, fileName):
 class ModelParameters:
     @classmethod
     def generate_hyperparameters(cls, model, modelPrefix, pPath):
+        """
+        Generates hyperparameters for a given model
+        Parameters
+        ----------
+        model : str, list, dict
+            Name, id, or dictionary representation of the model
+        modelPrefix : str
+            Name used to create model files
+            e.g. (modelPrefix) + "Hyperparameters.json")
+        pPath : str, Path
+            Directory location of model files
+        """
         if all(hasattr(model, attr) for attr in ["_estimator_type", "get_params"]):
             cls.sklearn_params(model, modelPrefix, pPath)
         else:
@@ -36,7 +62,18 @@ def update_kpis(
         server="cas-shared-default",
         caslib="ModelPerformanceData",
     ):
-        """Updates"""
+        """
+        Updates hyperparameter file to include KPIs generated by performance definitions, as well
+        as any custom KPIs imported by user to the SAS KPI data table.
+        Parameters
+        ----------
+        project : dict, str, list
+            Name, id, or dictionary representation of the project
+        server : str, optional
+            Server on which the KPI data table is stored. Defaults to "cas-shared-default".
+        caslib : str, optional
+            CAS Library on which the KPI data table is stored. Defaults to "ModelPerformanceData".
+        """
         from ..tasks import get_project_kpis
         from io import StringIO
 
@@ -61,6 +98,17 @@ def update_kpis(
 
     @classmethod
     def get_hyperparameters(cls, model):
+        """
+        Gets hyperparameter json file from specified model.
+        Parameters
+        ----------
+        model : str, dict, list
+            Name, id, or dictionary representation of the model
+        Returns
+        -------
+        dict
+            dictionary containing the contents of the hyperparameter file
+        """
         if mr.is_uuid(model):
             id_ = model
         elif isinstance(model, dict) and "id" in model:
@@ -73,6 +121,15 @@ def get_hyperparameters(cls, model):
 
     @classmethod
     def add_hyperparameters(cls, model, **kwargs):
+        """
+        Adds custom hyperparameters to the hyperparameter file contained within the model in Model Manager.
+        Parameters
+        ----------
+        model : str, dict
+            name, id, or dictionary representation of the model
+        kwargs
+            named variables representing hyperparameters to be added to the hyperparameter file
+        """
         from io import StringIO
 
         if not isinstance(model, dict):
@@ -87,9 +144,18 @@ def add_hyperparameters(cls, model, **kwargs):
         )
 
     def sklearn_params(model, modelPrefix, pPath):
+        """
+        Generates hyperparameters for the models genereated by SciKit Learn.
+        Parameters
+        ----------
+        modelPrefix : str
+            Name used to create model files
+        pPath : str, Path
+            Directory location of model files
+        """
         hyperparameters = model.get_params()
         modelJson = {"hyperparameters": hyperparameters}
         with open(
             Path(pPath) / ("{}Hyperparameters.json".format(modelPrefix)), "w"
         ) as f:
-            f.write(json.dumps(modelJson, indent=4))
+            f.write(json.dumps(modelJson, indent=4))