swarmauri_measurement_mutualinformation 0.6.0.dev154__tar.gz

swarmauri_measurement_mutualinformation-0.6.0.dev154/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: swarmauri_measurement_mutualinformation
+Version: 0.6.0.dev154
+Summary: Swarmauri Mutual Information Measurement Community Package.
+License: Apache-2.0
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: scikit-learn (>=1.5.2,<2.0.0)
+Requires-Dist: swarmauri_base (>=0.6.0.dev154,<0.7.0)
+Requires-Dist: swarmauri_core (>=0.6.0.dev154,<0.7.0)
+Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
+Description-Content-Type: text/markdown
+
+# Swarmauri Example Community Package

swarmauri_measurement_mutualinformation-0.6.0.dev154/README.md

@@ -0,0 +1 @@
+# Swarmauri Example Community Package

swarmauri_measurement_mutualinformation-0.6.0.dev154/pyproject.toml

@@ -0,0 +1,59 @@
+[tool.poetry]
+name = "swarmauri_measurement_mutualinformation"
+version = "0.6.0.dev154"
+description = "Swarmauri Mutual Information Measurement Community Package."
+authors = ["Jacob Stewart <jacob@swarmauri.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+repository = "http://github.com/swarmauri/swarmauri-sdk"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+
+# Swarmauri
+swarmauri_core = {version = "^0.6.0.dev154"}
+swarmauri_base = {version = "^0.6.0.dev154"}
+
+# Dependencies
+scikit-learn = "^1.5.2"
+pandas = "^2.2.3"
+
+
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "^7.0"
+pytest = "^8.0"
+pytest-asyncio = ">=0.24.0"
+pytest-xdist = "^3.6.1"
+pytest-json-report = "^1.5.0"
+python-dotenv = "*"
+requests = "^2.32.3"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+norecursedirs = ["combined", "scripts"]
+
+markers = [
+    "test: standard test",
+    "unit: Unit tests",
+    "integration: Integration tests",
+    "acceptance: Acceptance tests",
+    "experimental: Experimental tests"
+]
+log_cli = true
+log_cli_level = "INFO"
+log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
+log_cli_date_format = "%Y-%m-%d %H:%M:%S"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.poetry.plugins."swarmauri.measurements"]
+MutualInformationMeasurement = "swarmauri_measurement_mutualinformation.MutualInformationMeasurement:MutualInformationMeasurement"

swarmauri_measurement_mutualinformation-0.6.0.dev154/swarmauri_measurement_mutualinformation/MutualInformationMeasurement.py

@@ -0,0 +1,43 @@
+from typing import Literal
+import pandas as pd
+from sklearn.feature_selection import mutual_info_classif
+from swarmauri_core.ComponentBase import ComponentBase
+from swarmauri_base.measurements.MeasurementBase import MeasurementBase
+from swarmauri_base.measurements.MeasurementCalculateMixin import (
+    MeasurementCalculateMixin,
+)
+
+
+@ComponentBase.register_type(MeasurementBase, "MutualInformationMeasurement")
+class MutualInformationMeasurement(MeasurementBase, MeasurementCalculateMixin):
+    """
+    A Measurement class to calculate mutual information between features and a target column in a given dataset.
+
+    This class computes the mutual information between each feature in a DataFrame (excluding the target column)
+    and the target column itself, and returns the average mutual information score.
+    """
+
+    type: Literal["MutualInformationMeasurement"] = "MutualInformationMeasurement"
+    unit: str = "bits"
+
+    def calculate(self, data: pd.DataFrame, target_column: str) -> float:
+        """
+        Calculate the average mutual information between the features and the target column.
+
+        Parameters:
+        - data (pd.DataFrame): A DataFrame containing both the features and the target column.
+
+        - target_column (str) The name of the target column in the DataFrame.
+
+        Returns:
+        - float: The average mutual information across all feature columns.
+        """
+        # Separate features from the target column
+        features_data = data.drop(columns=[target_column])
+        target_data = data[target_column]
+
+        # Calculate mutual information
+        mi = mutual_info_classif(features_data, target_data)
+
+        # Return the average mutual information across all features
+        return float(mi.mean())  # Output as a float

swarmauri_measurement_mutualinformation-0.6.0.dev154/swarmauri_measurement_mutualinformation/__init__.py

@@ -0,0 +1,14 @@
+from .MutualInformationMeasurement import MutualInformationMeasurement
+
+__version__ = "0.6.0.dev26"
+__long_desc__ = """
+
+# Swarmauri MutualInformation Plugin
+
+This repository includes a MutualInformation of a Swarmauri Plugin.
+
+Visit us at: https://swarmauri.com
+Follow us at: https://github.com/swarmauri
+Star us at: https://github.com/swarmauri/swarmauri-sdk
+
+"""