Merge pull request #396 from sunya-ch/server-api-rebase-patch-4

address issue in comment #392, define ModelListParam

Author: Sunil Thaha

src/kepler_model/estimate/model_server_connector.py

@@ -13,7 +13,7 @@
 )
 from kepler_model.util.loader import get_download_output_path
 from kepler_model.util.train_types import ModelOutputType
-
+from kepler_model.server.model_server import ModelListParam
 
 # discover_spec: determine node spec in json format (refer to NodeTypeSpec)
 def discover_spec():
@@ -68,16 +68,23 @@ def make_request(power_request):
     return unpack(power_request.energy_source, output_type, response)
 
 
-def list_all_models(energy_source=None, node_type=None):
+def list_all_models(energy_source=None, output_type=None, feature_group=None, node_type=None, filter=None):
     if not is_model_server_enabled():
         return dict()
     try:
         endpoint = get_model_server_list_endpoint()
         params= {}
         if energy_source:
-            params["source"] = energy_source
+            params[ModelListParam.EnergySource.value] = energy_source
+        if output_type:
+            params[ModelListParam.OutputType.value] = output_type
+        if feature_group:
+            params[ModelListParam.FeatureGroup.value] = feature_group
         if node_type:
-           params["type"] = node_type
+           params[ModelListParam.NodeType.value] = node_type
+        if filter:
+            params[ModelListParam.Filter.value] = filter
+
         response = requests.get(endpoint, params=params)
     except Exception as err:
         print(f"cannot list model: {err}")
@@ -86,4 +93,3 @@ def list_all_models(energy_source=None, node_type=None):
         return dict()
     model_names = json.loads(response.content.decode("utf-8"))
     return model_names
-

src/kepler_model/server/model_server.py

@@ -3,6 +3,7 @@
 import os
 import shutil
 import sys
+import enum
 
 import click
 import requests
@@ -71,6 +72,13 @@ def __init__(self, metrics, output_type, source="rapl-sysfs", node_type=-1, weig
         if spec is not None:
             self.spec = NodeTypeSpec(**spec)
 
+# ModelListParams defines parameters for /best-models API
+class ModelListParam(enum.Enum):
+    EnergySource = "energy-source"
+    OutputType = "output-type"
+    FeatureGroup = "feature-group"
+    NodeType = "node-type"
+    Filter = "filter"
 
 ###########################################
 MODEL_SERVER_PORT = int(getConfig("MODEL_SERVER_PORT", "8100"))
@@ -93,7 +101,7 @@ def __init__(self, metrics, output_type, source="rapl-sysfs", node_type=-1, weig
 """
 
 
-def select_best_model(spec, valid_group_path, filters, energy_source, pipeline_name="", trainer_name="", node_type=any_node_type, weight=False):
+def select_best_model(spec, valid_group_path: str, filters: dict, energy_source: str, pipeline_name: str="", trainer_name: str="", node_type: int=any_node_type, weight: bool=False):
     model_names = [f for f in os.listdir(valid_group_path) if f != CHECKPOINT_FOLDERNAME and not os.path.isfile(os.path.join(valid_group_path, f)) and (trainer_name == "" or trainer_name in f)]
     if weight:
         model_names = [name for name in model_names if name.split("_")[0] in weight_support_trainers]
@@ -186,11 +194,11 @@ def get_model():
 # get_available_models: return name list of best-candidate pipelines
 @app.route(MODEL_SERVER_MODEL_LIST_PATH, methods=["GET"])
 def get_available_models():
-    fg = request.args.get("fg")
-    ot = request.args.get("ot")
-    energy_source = request.args.get("source")
-    node_type = request.args.get("type")
-    filter = request.args.get("filter")
+    fg = request.args.get(ModelListParam.FeatureGroup.value)
+    ot = request.args.get(ModelListParam.OutputType.value)
+    energy_source = request.args.get(ModelListParam.EnergySource.value)
+    node_type = request.args.get(ModelListParam.NodeType.value)
+    filter = request.args.get(ModelListParam.Filter.value)
 
     try:
         if fg is None:

src/kepler_model/util/loader.py

@@ -173,7 +173,7 @@ def parse_filters(filter):
     return filters
 
 
-def is_valid_model(metadata, filters):
+def is_valid_model(metadata, filters: dict):
     for attrb, val in filters.items():
         if not hasattr(metadata, attrb) or getattr(metadata, attrb) is None:
             print("{} has no {}".format(metadata["model_name"], attrb))