Add Requirement #13878 - Support Coefficient parameter

Author: benchuang11046

CHANGELOG.md

@@ -1,7 +1,9 @@
 3.0.2 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Add Requirement #13878 - Support Coefficient parameter
+
+- Fix Bug #13864 - Fix botocore upload incomplete model, and use boto3 instead.
 
 
 3.0.1 (2020-04-27)

afs/models.py

@@ -148,6 +148,7 @@ def upload_model(
         tags={},
         extra_evaluation={},
         feature_importance=None,
+        coefficient=None,
         model_repository_name=None,
         model_name=None,
         blob_mode=True,
@@ -225,8 +226,12 @@ def upload_model(
         data = dict(
             tags=json.dumps(tags), 
             evaluation_result=json.dumps(evaluation_result),
-            feature_importance=json.dumps(feature_importance),
         )
+        if feature_importance:
+            data.update({'feature_importance': json.dumps(feature_importance)})
+        if coefficient:
+            data.update({'coefficient': json.dumps(coefficient)})
+
         if self.afs_version >= '3.1.3':
             data.update(
                 {

docs/Examples.md

@@ -36,6 +36,18 @@ feature_importance = [
 	{'feature': 'sepal_width',  'importance': 0.0033974420712357825}
 ]
 
+coefficient = [
+	{'feature': 'B-0070-0068-1-FN66F_strength', 'coefficient': -4.730741400252476}, 
+	{'feature': 'B-0070-0068-1-FN66F_vendor', 'coefficient': -0.9335123601234512}, 
+	{'feature': 'B-0070-0068-1-FN66F_tensile','coefficient': 0.16411707246054036}, 
+	{'feature': 'B-0070-0068-1-FN66F_lot','coefficient': -0.08745686004816221}, 
+	{'feature': 'Machine','coefficient': 0.015048547152059243}, 
+	{'feature': 'Lot','coefficient': -0.010971975766858174}, 
+	{'feature': 'RPM','coefficient': 0.0003730247816832932}, 
+	{'feature': 'record_purpose','coefficient': 0.0}
+]
+
+
 # Model object
 afs_models = models()
 
@@ -45,15 +57,17 @@ afs_models = models()
 #   3. (optional) extra_evaluation is for other evaluations for the model, you can put them to this parameter.
 #   4. (optional) tags is the label for the model, like the time of data or the type of the algorithm.
 #   5. (optional) feature_importance is the record how the features important in the model.
+#	6. (optional) coefficient indicates the direction of the relationship between a predictor variable and the response variable.
 afs_models.upload_model(
     model_path='model.h5',
 	model_repository_name='model.h5',
 	accuracy=0.4,
 	loss=0.3, 
 	extra_evaluation=extra_evaluation, 
 	tags=tags,
-	feature_importance=feature_importance
-	)
+	feature_importance=feature_importance,
+	coefficient=coefficient,
+)
 
 # Get the latest model info 
 model_info = afs_models.get_latest_model_info(model_repository_name='model.h5')
@@ -94,7 +108,16 @@ print(model_info)
 		'feature': 'sepal_width',
 		'importance': 0.0033974421
 	}],
-	'coefficient': [],
+	'coefficient': [
+		{'feature': 'B-0070-0068-1-FN66F_strength', 'coefficient': -4.730741400252476}, 
+		{'feature': 'B-0070-0068-1-FN66F_vendor', 'coefficient': -0.9335123601234512}, 
+		{'feature': 'B-0070-0068-1-FN66F_tensile','coefficient': 0.16411707246054036}, 
+		{'feature': 'B-0070-0068-1-FN66F_lot','coefficient': -0.08745686004816221}, 
+		{'feature': 'Machine','coefficient': 0.015048547152059243}, 
+		{'feature': 'Lot','coefficient': -0.010971975766858174}, 
+		{'feature': 'RPM','coefficient': 0.0003730247816832932}, 
+		{'feature': 'record_purpose','coefficient': 0.0}
+	],
 	'size': 11,
 	'created_at': '2020-04-06T10:23:56.228000+00:00'
 }

tests/v2/test_models.py

@@ -187,3 +187,44 @@ def test_create_model_with_datasetid_target(test_env, afs_models, clean_mr, dele
     assert "dataset_id" in resp
     assert "afs_target" in resp
     print(resp)
+
+def test_create_model_with_ft_and_cofficient(test_env, afs_models, clean_mr, delete_mr_and_model, model_file, model_repository_name):
+
+    feature_importance = [
+        {'feature': 'petal_length', 'importance': 0.9473576807512394}, 
+        {'feature': 'petal_width',  'importance': 0.038191635936882906}, 
+        {'feature': 'sepal_length', 'importance': 0.011053241240641932}, 
+        {'feature': 'sepal_width',  'importance': 0.0033974420712357825}
+    ]
+
+    coefficient = [
+        {'feature': 'B-0070-0068-1-FN66F_strength', 'coefficient': -4.730741400252476}, 
+        {'feature': 'B-0070-0068-1-FN66F_vendor', 'coefficient': -0.9335123601234512}, 
+        {'feature': 'B-0070-0068-1-FN66F_tensile','coefficient': 0.16411707246054036}, 
+        {'feature': 'B-0070-0068-1-FN66F_lot','coefficient': -0.08745686004816221}, 
+        {'feature': 'Machine','coefficient': 0.015048547152059243}, 
+        {'feature': 'Lot','coefficient': -0.010971975766858174}, 
+        {'feature': 'RPM','coefficient': 0.0003730247816832932}, 
+        {'feature': 'record_purpose','coefficient': 0.0}
+    ]
+
+    resp = afs_models.upload_model(
+        model_path="unit_test_model",
+        accuracy=1.0,
+        loss=1.0,
+        tags={"tag_key": "tag_value"},
+        extra_evaluation={"extra_loss": 1.23},
+        feature_importance=feature_importance,
+        coefficient=coefficient,
+        model_repository_name=model_repository_name,
+        model_name="test_model",
+    )
+    assert isinstance(resp, dict)
+    assert "uuid" in resp
+    assert "name" in resp
+    assert "created_at" in resp
+    assert "tags" in resp
+    assert "evaluation_result" in resp
+    assert "feature_importance" in resp
+    assert "coefficient" in resp
+    print(resp)