aisc-plugin-interface 0.2.4__tar.gz

aisc_plugin_interface-0.2.4/.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+.idea

aisc_plugin_interface-0.2.4/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: aisc-plugin-interface
+Version: 0.2.4
+Summary: Add your description here
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: rich>=14.3.3
+Description-Content-Type: text/markdown
+
+# AISC Plugin Interface
+
+This repository provides the base interface for writing evaluation plugins.
+
+If you are new to the platform, start here:
+
+- [Plugin Developer Guide](PLUGIN_DEVELOPER_GUIDE.md)
+
+That guide covers:
+
+- the plugin contract and discovery model
+- how to create a plugin project
+- how to implement configuration, inputs, metrics, and progress reporting
+- optional integration hooks and current extension points
+- common failure modes and architectural feedback areas
+
+## Quick Start
+
+Create a new plugin project:
+
+```bash
+mkdir my-aisc-plugin
+cd my-aisc-plugin
+uv init --lib
+uv add git+https://github.com/lux-ai-factory/aisc-plugin-interface
+```
+
+Implement a plugin class that inherits from `BaseEvaluationPlugin[T]`, then export it from your package `__init__.py`.
+
+Minimal example:
+
+```python
+from typing import Any
+
+from aisc_plugin_interface.models.measure import Measure
+from aisc_plugin_interface.base_evaluation_plugin import metric, BaseEvaluationPlugin
+from pydantic import BaseModel, Field
+
+from aisc_plugin_interface import BaseEvaluationPlugin, Measure, metric
+
+
+class ConfigFormSchema(BaseModel):
+    threshold: float = Field(default=0.5, ge=0.0, le=1.0)
+
+
+class MyPlugin(BaseEvaluationPlugin[ConfigFormSchema]):
+    def evaluate(self, config_data: dict) -> Any:
+        # Dependencies only used during evaluation should be imported locally here
+        import numpy as np
+
+        # Access configuration form data
+        config: ConfigFormSchema = self.validate_config_form_data(config_data)
+        threshold: float = config.threshold
+        
+        # Your evaluation logic here
+
+        # Use self.logger for logging
+        self.logger.info("Evaluation completed successfully")
+        
+        return {"MyMetric": [0.99, 0.5, 0.67], "OtherMetric": [0.01, 0.22, 0.77]}
+
+
+    @metric("MyMetric")
+    def my_metric(self, evaluation_output: Any) -> list[Measure]:
+        values = evaluation_output.get("MyMetric", [])
+        return [Measure(name="MyMetric", score=value) for value in values]
+```
+
+Export it:
+
+```python
+from .plugin import MyPlugin
+
+__all__ = ["MyPlugin"]
+```
+
+For the full development workflow, use the guide above.

aisc_plugin_interface-0.2.4/README.md

@@ -0,0 +1,77 @@
+# AISC Plugin Interface
+
+This repository provides the base interface for writing evaluation plugins.
+
+If you are new to the platform, start here:
+
+- [Plugin Developer Guide](PLUGIN_DEVELOPER_GUIDE.md)
+
+That guide covers:
+
+- the plugin contract and discovery model
+- how to create a plugin project
+- how to implement configuration, inputs, metrics, and progress reporting
+- optional integration hooks and current extension points
+- common failure modes and architectural feedback areas
+
+## Quick Start
+
+Create a new plugin project:
+
+```bash
+mkdir my-aisc-plugin
+cd my-aisc-plugin
+uv init --lib
+uv add git+https://github.com/lux-ai-factory/aisc-plugin-interface
+```
+
+Implement a plugin class that inherits from `BaseEvaluationPlugin[T]`, then export it from your package `__init__.py`.
+
+Minimal example:
+
+```python
+from typing import Any
+
+from aisc_plugin_interface.models.measure import Measure
+from aisc_plugin_interface.base_evaluation_plugin import metric, BaseEvaluationPlugin
+from pydantic import BaseModel, Field
+
+from aisc_plugin_interface import BaseEvaluationPlugin, Measure, metric
+
+
+class ConfigFormSchema(BaseModel):
+    threshold: float = Field(default=0.5, ge=0.0, le=1.0)
+
+
+class MyPlugin(BaseEvaluationPlugin[ConfigFormSchema]):
+    def evaluate(self, config_data: dict) -> Any:
+        # Dependencies only used during evaluation should be imported locally here
+        import numpy as np
+
+        # Access configuration form data
+        config: ConfigFormSchema = self.validate_config_form_data(config_data)
+        threshold: float = config.threshold
+        
+        # Your evaluation logic here
+
+        # Use self.logger for logging
+        self.logger.info("Evaluation completed successfully")
+        
+        return {"MyMetric": [0.99, 0.5, 0.67], "OtherMetric": [0.01, 0.22, 0.77]}
+
+
+    @metric("MyMetric")
+    def my_metric(self, evaluation_output: Any) -> list[Measure]:
+        values = evaluation_output.get("MyMetric", [])
+        return [Measure(name="MyMetric", score=value) for value in values]
+```
+
+Export it:
+
+```python
+from .plugin import MyPlugin
+
+__all__ = ["MyPlugin"]
+```
+
+For the full development workflow, use the guide above.

aisc_plugin_interface-0.2.4/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "aisc-plugin-interface"
+version = "0.2.4"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.12.5",
+    "rich>=14.3.3",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aisc_plugin_interface"]
+
+[tool.hatch.build]
+include = [
+  "src/aisc_plugin_interface/templates/*.tpl",
+]
+
+[project.scripts]
+aisc-plugin-interface = "aisc_plugin_interface.cli:main"

aisc_plugin_interface-0.2.4/src/aisc_plugin_interface/templates/init.py.tpl

@@ -0,0 +1,3 @@
+from .{{ import_path }} import {{ plugin_name }}
+
+__all__ = ["{{ plugin_name }}"]

aisc_plugin_interface-0.2.4/src/aisc_plugin_interface/templates/plugin.py.tpl

@@ -0,0 +1,19 @@
+from typing import Any
+
+from pydantic import BaseModel
+
+from aisc_plugin_interface import BaseEvaluationPlugin, Measure, metric
+
+
+# Define the configuration form schema
+class ConfigFormSchema(BaseModel):
+    pass
+
+
+class {{ plugin_name }}(BaseEvaluationPlugin[ConfigFormSchema]):
+    def evaluate(self, config_data: dict) -> Any:
+        pass
+
+    @metric("my-metric")
+    def my_metric(self, evaluation_output: Any) -> list[Measure]:
+        pass