triggerflow 0.1.12__py3-none-any.whl → 0.2__py3-none-any.whl

triggerflow/core.py

@@ -1,32 +1,38 @@
-from pathlib import Path
+import importlib
+import importlib.resources as pkg_resources
 import json
-import numpy as np
+import logging
+import shutil
 import tarfile
-import importlib
+import warnings
 from abc import ABC, abstractmethod
-from typing import Optional, Dict, Any, Union
-import shutil, warnings
-import importlib.resources as pkg_resources
-import triggerflow.templates 
+from pathlib import Path
+from typing import Any
+
+import numpy as np
+
+import triggerflow.templates
+
+logger = logging.getLogger(__name__)
 
 
 class ModelConverter(ABC):
     """Abstract base class for model converters"""
-    
+
     @abstractmethod
-    def convert(self, model, workspace: Path, **kwargs) -> Optional[Path]:
+    def convert(self, model, workspace: Path, **kwargs) -> Path | None:
         """Convert model to intermediate format"""
         pass
 
 
 class CompilerStrategy(ABC):
     """Abstract base class for compilation strategies"""
-    
+
     @abstractmethod
-    def compile(self, model, workspace: Path, config: Optional[Dict] = None,  **kwargs) -> Any:
+    def compile(self, model, workspace: Path, config: dict | None = None,  **kwargs) -> Any:
         """Compile model to firmware"""
         pass
-    
+
     @abstractmethod
     def load_compiled_model(self, workspace: Path) -> Any:
         """Load a previously compiled model"""
@@ -35,7 +41,7 @@ class CompilerStrategy(ABC):
 
 class ModelPredictor(ABC):
     """Abstract base class for model predictors"""
-    
+
     @abstractmethod
     def predict(self, input_data: np.ndarray) -> np.ndarray:
         """Make predictions using the model"""
@@ -44,7 +50,7 @@ class ModelPredictor(ABC):
 
 class KerasToQONNXConverter(ModelConverter):
     """Converts Keras models to QONNX format"""
-    
+
     def convert(self, model, workspace: Path, **kwargs) -> Path:
         import tensorflow as tf
         from qonnx.converters import keras as keras_converter
@@ -52,7 +58,7 @@ class KerasToQONNXConverter(ModelConverter):
         from qonnx.transformation.channels_last import ConvertToChannelsLastAndClean
         from qonnx.transformation.gemm_to_matmul import GemmToMatMul
         from qonnx.util.cleanup import cleanup_model
-        
+
         qonnx_path = workspace / "model_qonnx.onnx"
         input_signature = [tf.TensorSpec(1, model.inputs[0].dtype, name="input_0")]
         qonnx_model, _ = keras_converter.from_keras(model, input_signature, output_path=qonnx_path)
@@ -61,26 +67,26 @@ class KerasToQONNXConverter(ModelConverter):
         qonnx_model = qonnx_model.transform(ConvertToChannelsLastAndClean())
         qonnx_model = qonnx_model.transform(GemmToMatMul())
         cleaned_model = cleanup_model(qonnx_model)
-        
+
         return qonnx_path, cleaned_model
 
 
 class NoOpConverter(ModelConverter):
     """No-operation converter for models that don't need conversion"""
-    
-    def convert(self, model, workspace: Path, **kwargs) -> Optional[Path]:
+
+    def convert(self, model, workspace: Path, **kwargs) -> Path | None:
         return None
 
 
 class HLS4MLStrategy(CompilerStrategy):
     """HLS4ML compilation strategy for Keras models"""
-    
-    def compile(self, model, workspace: Path, config: Optional[Dict] = None, **kwargs) -> Any:
+
+    def compile(self, model, workspace: Path, config: dict | None = None, **kwargs) -> Any:
         import hls4ml
-        
+
         firmware_dir = workspace / "firmware"
         firmware_dir.mkdir(exist_ok=True)
-        
+
         cfg = config or hls4ml.utils.config_from_keras_model(model, granularity="name")
 
         hls_kwargs = {
@@ -103,10 +109,10 @@ class HLS4MLStrategy(CompilerStrategy):
             warnings.warn("Vivado not found in PATH. Firmware build failed.", UserWarning)
         firmware_model.save(workspace / "firmware_model.fml")
         return firmware_model
-    
+
     def load_compiled_model(self, workspace: Path) -> Any:
         from hls4ml.converters import link_existing_project
-        
+
         firmware_model = link_existing_project(workspace / "firmware")
         firmware_model.compile()
         return firmware_model
@@ -114,17 +120,15 @@ class HLS4MLStrategy(CompilerStrategy):
 class ConiferStrategy(CompilerStrategy):
     """Conifer compilation strategy for XGBoost models"""
 
-    def compile(self, model, workspace: Path, config: Optional[Dict] = None, **kwargs) -> Any:
+    def compile(self, model, workspace: Path, config: dict | None = None, **kwargs) -> Any:
         import conifer
-        import shutil
-        import warnings
 
         firmware_dir = workspace / "firmware"
         firmware_dir.mkdir(exist_ok=True)
-        
+
         cfg = config or conifer.backends.xilinxhls.auto_config()
         cfg['OutputDir'] = str(firmware_dir)
-        
+
         for key, value in kwargs.items():
             cfg[key] = value
 
@@ -144,31 +148,31 @@ class ConiferStrategy(CompilerStrategy):
 
 class DA4MLStrategy(CompilerStrategy):
     """DA4ML compilation strategy (placeholder)"""
-    
-    def compile(self, model, workspace: Path, config: Optional[Dict] = None) -> Any:
+
+    def compile(self, model, workspace: Path, config: dict | None = None) -> Any:
         raise NotImplementedError("DA4ML conversion without QONNX not yet implemented")
-    
+
     def load_compiled_model(self, workspace: Path) -> Any:
         raise NotImplementedError("DA4ML loading not yet implemented")
 
 
 class FINNStrategy(CompilerStrategy):
     """FINN compilation strategy (placeholder)"""
-    
-    def compile(self, model, workspace: Path, config: Optional[Dict] = None) -> Any:
+
+    def compile(self, model, workspace: Path, config: dict | None = None) -> Any:
         raise NotImplementedError("FINN conversion without QONNX not yet implemented")
-    
+
     def load_compiled_model(self, workspace: Path) -> Any:
         raise NotImplementedError("FINN loading not yet implemented")
 
 
 class SoftwarePredictor(ModelPredictor):
     """Software-based model predictor"""
-    
+
     def __init__(self, model, backend: str):
         self.model = model
         self.backend = backend.lower()
-    
+
     def predict(self, input_data):
         if input_data.ndim == 1:
             input_data = np.expand_dims(input_data, axis=0)
@@ -177,37 +181,37 @@ class SoftwarePredictor(ModelPredictor):
 
 class QONNXPredictor(ModelPredictor):
     """QONNX-based model predictor"""
-    
+
     def __init__(self, qonnx_model, input_name: str):
         self.qonnx_model = qonnx_model
         self.input_name = input_name
-    
+
     def predict(self, input_data: np.ndarray) -> np.ndarray:
         from qonnx.core.onnx_exec import execute_onnx
-        
+
         input_data = np.asarray(input_data)
         if input_data.ndim == 1:
             input_data = np.expand_dims(input_data, axis=0)
-        
+
         outputs = []
         for i in range(input_data.shape[0]):
             sample = input_data[i].astype("float32").reshape(1, -1)
             output_dict = execute_onnx(self.qonnx_model, {self.input_name: sample})
             outputs.append(output_dict["global_out"])
-        
+
         return np.vstack(outputs)
 
 
 class FirmwarePredictor(ModelPredictor):
     """Firmware-based model predictor"""
-    
+
     def __init__(self, firmware_model, compiler):
         if firmware_model is None:
             raise RuntimeError("Firmware model not built.")
         self.firmware_model = firmware_model
         self.compiler = compiler
-    
-    
+
+
     def predict(self, input_data: np.ndarray) -> np.ndarray:
         if self.compiler == "conifer":
             return self.firmware_model.decision_function(input_data)
@@ -217,7 +221,7 @@ class FirmwarePredictor(ModelPredictor):
 
 class ConverterFactory:
     """Factory for creating model converters"""
-    
+
     @staticmethod
     def create_converter(ml_backend: str, compiler: str) -> ModelConverter:
         if ml_backend.lower() == "keras" and compiler.lower() == "hls4ml":
@@ -228,12 +232,12 @@ class ConverterFactory:
 
 class CompilerFactory:
     """Factory for creating compilation strategies"""
-    
+
     @staticmethod
     def create_compiler(ml_backend: str, compiler: str) -> CompilerStrategy:
         backend = ml_backend.lower()
         comp = compiler.lower()
-        
+
         if backend == "keras" and comp == "hls4ml":
             return HLS4MLStrategy()
         elif backend == "xgboost" and comp == "conifer":
@@ -248,9 +252,9 @@ class CompilerFactory:
 
 class WorkspaceManager:
     """Manages workspace directories and metadata"""
-    
+
     BASE_WORKSPACE = Path.cwd() / "triggermodel"
-    
+
     def __init__(self):
         self.workspace = self.BASE_WORKSPACE
         self.artifacts = {"firmware": None}
@@ -260,7 +264,7 @@ class WorkspaceManager:
             "compiler": None,
             "versions": []
         }
-    
+
     def setup_workspace(self, name: str, ml_backend: str, compiler: str):
         """Initialize workspace and metadata"""
         self.workspace.mkdir(parents=True, exist_ok=True)
@@ -269,22 +273,22 @@ class WorkspaceManager:
             "ml_backend": ml_backend,
             "compiler": compiler,
         })
-    
+
     def save_native_model(self, model, ml_backend: str):
         """Save the native model to workspace"""
         if ml_backend.lower() == "keras":
-            model.save(self.workspace / "keras_model")
+            model.save(self.workspace / "keras_model.keras")
         elif ml_backend.lower() == "xgboost":
             model.save_model(str(self.workspace / "xgb_model.json"))
-    
+
     def add_artifact(self, key: str, value: Any):
         """Add artifact to tracking"""
         self.artifacts[key] = value
-    
-    def add_version(self, version_info: Dict):
+
+    def add_version(self, version_info: dict):
         """Add version information"""
         self.metadata["versions"].append(version_info)
-    
+
     def save_metadata(self):
         """Save metadata to file"""
         with open(self.workspace / "metadata.json", "w") as f:
@@ -297,7 +301,7 @@ class WorkspaceManager:
 
 class ModelSerializer:
     """Handles model serialization and deserialization"""
-    
+
     @staticmethod
     def save(workspace: Path, path: str):
         """Serialize the workspace into a tar.xz archive"""
@@ -305,37 +309,37 @@ class ModelSerializer:
         path.parent.mkdir(parents=True, exist_ok=True)
         with tarfile.open(path, mode="w:xz") as tar:
             tar.add(workspace, arcname=workspace.name)
-        print(f"TriggerModel saved to {path}")
-    
+        logger.info(f"TriggerModel saved to {path}")
+
     @staticmethod
-    def load(path: str) -> Dict[str, Any]:
+    def load(path: str) -> dict[str, Any]:
         """Load workspace from tar.xz archive"""
         path = Path(path)
         if not path.exists():
             raise FileNotFoundError(f"{path} does not exist")
-        
+
         workspace = Path.cwd() / "triggermodel"
-        
+
         if workspace.exists():
             response = input(f"{workspace} already exists. Overwrite? [y/N]: ").strip().lower()
             if response != "y":
-                print("Load cancelled by user.")
+                logger.info("Load cancelled by user.")
                 return None
             shutil.rmtree(workspace)
-        
+
         with tarfile.open(path, mode="r:xz") as tar:
             tar.extractall(path=Path.cwd())
-        
+
         # Load metadata
         metadata_path = workspace / "metadata.json"
-        with open(metadata_path, "r") as f:
+        with open(metadata_path) as f:
             metadata = json.load(f)
-        
+
         return {
             "workspace": workspace,
             "metadata": metadata
         }
-    
+
     @staticmethod
     def load_native_model(workspace: Path, ml_backend: str):
         """Load native model from workspace"""
@@ -352,7 +356,7 @@ class ModelSerializer:
             return model
         else:
             raise ValueError(f"Unsupported ml_backend: {ml_backend}")
-    
+
     @staticmethod
     def load_qonnx_model(workspace: Path):
         """Load QONNX model if it exists"""
@@ -366,13 +370,13 @@ class ModelSerializer:
 
 class TriggerModel:
     """Main facade class that orchestrates model conversion, compilation, and inference"""
-    
+
     def __init__(self, name: str, ml_backend: str, n_outputs:int, compiler: str,
                  native_model: object, compiler_config: dict = None, scales: dict = None):
-        
+
         if ml_backend.lower() not in ("keras", "xgboost"):
             raise ValueError("Only Keras or XGBoost backends are currently supported.")
-        
+
         self.name = name
         self.ml_backend = ml_backend.lower()
         self.scales = scales
@@ -380,67 +384,67 @@ class TriggerModel:
         self.compiler = compiler.lower()
         self.native_model = native_model
         self.compiler_conifg = compiler_config
-        
+
         self.workspace_manager = WorkspaceManager()
         self.converter = ConverterFactory.create_converter(ml_backend, compiler)
         self.compiler_strategy = CompilerFactory.create_compiler(ml_backend, compiler)
-        
+
         self.firmware_model = None
         self.model_qonnx = None
         self.input_name = None
-        
+
         self.workspace_manager.setup_workspace(name, self.ml_backend, self.compiler)
-    
+
     @property
     def workspace(self) -> Path:
         """Get workspace path"""
         return self.workspace_manager.workspace
-    
+
     @property
-    def artifacts(self) -> Dict[str, Any]:
+    def artifacts(self) -> dict[str, Any]:
         """Get artifacts dictionary"""
         return self.workspace_manager.artifacts
-    
+
     @property
-    def metadata(self) -> Dict[str, Any]:
+    def metadata(self) -> dict[str, Any]:
         """Get metadata dictionary"""
         return self.workspace_manager.metadata
-    
+
     def __call__(self, **compiler_kwargs):
         """Execute the full model conversion and compilation pipeline"""
         self.parse_dataset_object()
-        
+
         # Save native model
         self.workspace_manager.save_native_model(self.native_model, self.ml_backend)
-        
+
         # Convert model if needed
         conversion_result = self.converter.convert(
-            self.native_model, 
+            self.native_model,
             self.workspace_manager.workspace
         )
-        
+
         if conversion_result is not None:
             qonnx_path, self.model_qonnx = conversion_result
             self.input_name = self.model_qonnx.graph.input[0].name
             self.workspace_manager.add_artifact("qonnx", qonnx_path)
             self.workspace_manager.add_version({"qonnx": str(qonnx_path)})
-        
+
         # Compile model
         self.firmware_model = self.compiler_strategy.compile(
             self.native_model,
             self.workspace_manager.workspace,
-            self.compiler_conifg, 
+            self.compiler_conifg,
             **compiler_kwargs
         )
-        
+
         self.workspace_manager.add_artifact("firmware", self.workspace_manager.workspace / "firmware")
 
-        if self.compiler is not "conifer" and self.scales is not None:
+        if self.compiler != "conifer" and self.scales is not None:
            self.build_emulator(self.scales['shifts'], self.scales['offsets'], self.n_outputs)
-        
+
         self.workspace_manager.add_artifact("firmware", self.workspace_manager.workspace / "firmware")
         self.workspace_manager.save_metadata()
-    
+
     @staticmethod
     def parse_dataset_object():
         """Parse dataset object (placeholder)"""
@@ -455,24 +459,24 @@ class TriggerModel:
             template = template.replace("{{" + k + "}}", str(v))
         with open(out_path, "w") as f:
             f.write(template)
-    
+
     def software_predict(self, input_data: np.ndarray) -> np.ndarray:
         """Make predictions using software model"""
         predictor = SoftwarePredictor(self.native_model, self.ml_backend)
         return predictor.predict(input_data)
-    
+
     def qonnx_predict(self, input_data: np.ndarray) -> np.ndarray:
         """Make predictions using QONNX model"""
         if self.model_qonnx is None:
             raise RuntimeError("QONNX model not available")
         predictor = QONNXPredictor(self.model_qonnx, self.input_name)
         return predictor.predict(input_data)
-    
+
     def firmware_predict(self, input_data: np.ndarray) -> np.ndarray:
         """Make predictions using firmware model"""
         predictor = FirmwarePredictor(self.firmware_model, self.compiler)
         return predictor.predict(input_data)
-    
+
     def build_emulator(self, ad_shift: list, ad_offsets: list, n_outputs: int):
         """
         Create an emulator directory for this model.
@@ -481,13 +485,13 @@ class TriggerModel:
         emulator_dir = self.workspace / "emulator"
         emulator_dir.mkdir(exist_ok=True)
 
-        model_dir = emulator_dir / self.name 
+        model_dir = emulator_dir / self.name
         model_dir.mkdir(exist_ok=True)
-        
+
         firmware_dir = self.workspace / "firmware" / "firmware"
-        
+
         shutil.copytree(firmware_dir, f"{model_dir}/NN", dirs_exist_ok=True)
-        
+
         # Access scales template from installed package
         with pkg_resources.path(triggerflow.templates, "scales.h") as scales_template_path:
             scales_out_path = model_dir / "scales.h"
@@ -503,7 +507,7 @@ class TriggerModel:
         with pkg_resources.path(triggerflow.templates, "model_template.cpp") as emulator_template_path:
             emulator_out_path = model_dir / "emulator.cpp"
             self._render_template(emulator_template_path, emulator_out_path, context)
-        
+
         with pkg_resources.path(triggerflow.templates, "makefile_version") as makefile_template_path:
             makefile_out_path = model_dir / "Makefile"
             self._render_template(makefile_template_path, makefile_out_path, {"MODEL_NAME": self.name})
@@ -511,44 +515,44 @@ class TriggerModel:
         with pkg_resources.path(triggerflow.templates, "makefile") as makefile_template_path:
             makefile_out_path = emulator_dir / "Makefile"
             self._render_template(makefile_template_path, makefile_out_path, {"MODEL_NAME": self.name})
-        
-    
+
+
     def save(self, path: str):
         """Save the complete model to an archive"""
         ModelSerializer.save(self.workspace_manager.workspace, path)
-    
+
     @classmethod
     def load(cls, path: str) -> 'TriggerModel':
         """Load a model from an archive"""
         load_result = ModelSerializer.load(path)
         if load_result is None:
             return None
-        
+
         workspace = load_result["workspace"]
         metadata = load_result["metadata"]
-        
+
         obj = cls.__new__(cls)
         obj.workspace_manager = WorkspaceManager()
         obj.workspace_manager.workspace = workspace
         obj.workspace_manager.metadata = metadata
         obj.workspace_manager.artifacts = {"firmware": workspace / "firmware"}
-        
+
         obj.name = metadata.get("name", "")
         obj.ml_backend = metadata.get("ml_backend")
         obj.compiler = metadata.get("compiler")
-        
+
         obj.native_model = ModelSerializer.load_native_model(workspace, obj.ml_backend)
-        
+
         obj.model_qonnx, obj.input_name = ModelSerializer.load_qonnx_model(workspace)
-        
+
         if obj.compiler.lower() in ("hls4ml", "conifer"):
             obj.compiler_strategy = CompilerFactory.create_compiler(obj.ml_backend, obj.compiler)
             obj.firmware_model = obj.compiler_strategy.load_compiled_model(workspace)
         else:
             obj.firmware_model = None
             obj.compiler_strategy = None
-        
+
         obj.converter = ConverterFactory.create_converter(obj.ml_backend, obj.compiler)
-        obj.dataset_object = None 
-        
-        return obj
+        obj.dataset_object = None
+
+        return obj