seu-injection-framework 1.1.7__py3-none-any.whl

seu_injection/__init__.py

@@ -0,0 +1,65 @@
+"""
+SEU Injection Framework
+======================
+
+A comprehensive framework for Single Event Upset (SEU) injection in neural networks
+for studying fault tolerance in harsh environments.
+
+# TODO PRODUCTION READINESS: Public API improvements per PRODUCTION_READINESS_PLAN.md
+# ISSUE: Current API requires deep understanding (IEEE 754, layer names, device management)
+# NEEDED: High-level convenience functions for common scenarios:
+#   - quick_robustness_check(model, test_data) -> simple robustness score
+#   - compare_architectures(models_dict, test_data) -> comparative analysis
+#   - space_mission_simulation(model, radiation_level) -> space-specific testing
+# TYPE SAFETY: Add comprehensive type stubs for better IDE support
+# ERROR MESSAGES: Custom exception types with helpful guidance for beginners
+# EXAMPLES: In-docstring examples need to be more comprehensive and tested
+# COMPATIBILITY: Ensure consistent device handling across all functions
+# PRIORITY: MEDIUM - Improve user onboarding experience
+
+This package provides tools for:
+- Systematic SEU injection in PyTorch models
+- Performance evaluation under radiation-induced bit flips
+- Analysis of neural network robustness in space and nuclear environments
+
+Basic Usage:
+    >>> from seu_injection import SEUInjector
+    >>> from seu_injection.metrics import classification_accuracy
+    >>> injector = SEUInjector(trained_model=model, criterion=classification_accuracy, x=X, y=y)
+    >>> results = injector.run_stochastic_seu(bit_i=15, p=0.01)
+
+For detailed examples, see the documentation at:
+https://seu-injection-framework.readthedocs.io
+"""
+
+try:  # Prefer dynamic version from installed metadata
+    from importlib.metadata import version as _pkg_version
+
+    __version__ = _pkg_version("seu-injection-framework")
+except Exception:  # Fallback for editable/source checkouts prior to build
+    __version__ = "1.1.7"
+__author__ = "William Dennis"
+__email__ = "william.dennis@bristol.ac.uk"
+
+# Core public API
+from .bitops.float32 import bitflip_float32
+from .core.injector import SEUInjector
+
+# Convenience imports for common use cases
+from .core.injector import SEUInjector as Injector  # Short alias
+from .metrics.accuracy import classification_accuracy, classification_accuracy_loader
+
+__all__ = [
+    # Core classes
+    "SEUInjector",
+    "Injector",  # Short alias
+    # Metrics functions
+    "classification_accuracy",
+    "classification_accuracy_loader",
+    # Bitflip operations
+    "bitflip_float32",
+    # Package metadata
+    "__version__",
+    "__author__",
+    "__email__",
+]

seu_injection/bitops/__init__.py

@@ -0,0 +1,22 @@
+"""
+Bit manipulation operations for SEU injection.
+
+This module provides efficient bit-level operations for different precision formats
+used in neural network fault tolerance research.
+"""
+
+from .float32 import (
+    binary_to_float32,
+    bitflip_float32,
+    bitflip_float32_fast,
+    bitflip_float32_optimized,
+    float32_to_binary,
+)
+
+__all__ = [
+    "bitflip_float32",
+    "bitflip_float32_fast",
+    "bitflip_float32_optimized",
+    "float32_to_binary",
+    "binary_to_float32",
+]