model: scikit: Adding scikit models with dynamic config

CHANGELOG.md

@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documentation on how to use ML models on docs Models plugin page.
 - Mailing list info
 - Issue template for questions
+- Multiple Scikit Models with dynamic config
 ### Changed
 - feature/codesec became it's own branch, binsec
 - BaseOrchestratorContext `run_operations` strict is default to true. With

model/scikit/dffml_model_scikit/scikit_base.py

@@ -0,0 +1,128 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019 Intel Corporation
+"""
+Base class for Scikit models
+"""
+import os
+import json
+import hashlib
+from pathlib import Path
+from typing import AsyncIterator, Tuple, Any, NamedTuple
+
+import joblib
+import numpy as np
+import pandas as pd
+
+from dffml.repo import Repo
+from dffml.source.source import Sources
+from dffml.accuracy import Accuracy
+from dffml.model.model import ModelConfig, ModelContext, Model
+
+
+class ScikitConfig(ModelConfig, NamedTuple):
+    directory: str
+    predict: str
+
+
+class ScikitContext(ModelContext):
+    def __init__(self, parent, features):
+        super().__init__(parent, features)
+        self.features = self.applicable_features(features)
+        self._features_hash = self._feature_predict_hash()
+        self.clf = None
+
+    @property
+    def confidence(self):
+        return self.parent.saved.get(self._features_hash, None)
+
+    @confidence.setter
+    def confidence(self, confidence):
+        self.parent.saved[self._features_hash] = confidence
+
+    def _feature_predict_hash(self):
+        return hashlib.sha384(
+            "".join(self.features + [self.parent.config.predict]).encode()
+        ).hexdigest()
+
+    def _filename(self):
+        return os.path.join(
+            self.parent.config.directory, self._features_hash + ".joblib"
+        )
+
+    async def __aenter__(self):
+        if os.path.isfile(self._filename()):
+            self.clf = joblib.load(self._filename())
+        else:
+            self.clf = self.parent.SCIKIT_MODEL
+        return self
+
+    async def __aexit__(self, exc_type, exc_value, traceback):
+        joblib.dump(self.clf, self._filename())
+
+    async def train(self, sources: Sources):
+        data = []
+        async for repo in sources.with_features(self.features):
+            feature_data = repo.features(
+                self.features + [self.parent.config.predict]
+            )
+            data.append(feature_data)
+        df = pd.DataFrame(data)
+        xdata = np.array(df.drop([self.parent.config.predict], 1))
+        ydata = np.array(df[self.parent.config.predict])
+        self.logger.info("Number of input repos: {}".format(len(xdata)))
+        self.clf.fit(xdata, ydata)
+        joblib.dump(self.clf, self._filename())
+
+    async def accuracy(self, sources: Sources) -> Accuracy:
+        data = []
+        async for repo in sources.with_features(self.features):
+            feature_data = repo.features(
+                self.features + [self.parent.config.predict]
+            )
+            data.append(feature_data)
+        df = pd.DataFrame(data)
+        xdata = np.array(df.drop([self.parent.config.predict], 1))
+        ydata = np.array(df[self.parent.config.predict])
+        self.logger.debug("Number of input repos: {}".format(len(xdata)))
+        self.confidence = self.clf.score(xdata, ydata)
+        self.logger.debug("Model Accuracy: {}".format(self.confidence))
+        return self.confidence
+
+    async def predict(
+        self, repos: AsyncIterator[Repo]
+    ) -> AsyncIterator[Tuple[Repo, Any, float]]:
+        if self.confidence is None:
+            raise ValueError("Model Not Trained")
+        async for repo in repos:
+            feature_data = repo.features(self.features)
+            df = pd.DataFrame(feature_data, index=[0])
+            predict = np.array(df)
+            self.logger.debug(
+                "Predicted Value of {} for {}: {}".format(
+                    self.parent.config.predict,
+                    predict,
+                    self.clf.predict(predict),
+                )
+            )
+            yield repo, self.clf.predict(predict)[0], self.confidence
+
+
+class Scikit(Model):
+    def __init__(self, config) -> None:
+        super().__init__(config)
+        self.saved = {}
+
+    def _filename(self):
+        return os.path.join(
+            self.config.directory,
+            hashlib.sha384(self.config.predict.encode()).hexdigest() + ".json",
+        )
+
+    async def __aenter__(self) -> "Scikit":
+        path = Path(self._filename())
+        if path.is_file():
+            self.saved = json.loads(path.read_text())
+        return self
+
+    async def __aexit__(self, exc_type, exc_value, traceback):
+        Path(self._filename()).write_text(json.dumps(self.saved))