flowyml 1.7.1__py3-none-any.whl → 1.8.0__py3-none-any.whl

flowyml/monitoring/slack_blocks.py

@@ -0,0 +1,323 @@
+"""Slack Block Kit message builders for rich notifications.
+
+This module provides utilities for building professional-looking Slack messages
+using Block Kit components.
+"""
+
+from datetime import datetime
+from typing import Any
+
+
+def _get_emoji(level: str) -> str:
+    """Get emoji for notification level."""
+    return {
+        "info": "ℹ️",
+        "warning": "⚠️",
+        "error": "❌",
+        "success": "✅",
+        "critical": "🚨",
+    }.get(level, "📢")
+
+
+def _get_color(level: str) -> str:
+    """Get color for notification level."""
+    return {
+        "info": "#36a64f",
+        "warning": "#ff9900",
+        "error": "#ff0000",
+        "success": "#2eb886",
+        "critical": "#8b0000",
+    }.get(level, "#cccccc")
+
+
+def build_header_block(text: str, emoji: str = "") -> dict:
+    """Build a header block."""
+    return {
+        "type": "header",
+        "text": {
+            "type": "plain_text",
+            "text": f"{emoji} {text}" if emoji else text,
+            "emoji": True,
+        },
+    }
+
+
+def build_section_block(text: str, accessory: dict | None = None) -> dict:
+    """Build a section block with markdown text."""
+    block = {
+        "type": "section",
+        "text": {
+            "type": "mrkdwn",
+            "text": text,
+        },
+    }
+    if accessory:
+        block["accessory"] = accessory
+    return block
+
+
+def build_context_block(elements: list[str]) -> dict:
+    """Build a context block with multiple text elements."""
+    return {
+        "type": "context",
+        "elements": [{"type": "mrkdwn", "text": el} for el in elements],
+    }
+
+
+def build_divider() -> dict:
+    """Build a divider block."""
+    return {"type": "divider"}
+
+
+def build_fields_section(fields: dict[str, Any]) -> dict:
+    """Build a section with multiple fields."""
+    return {
+        "type": "section",
+        "fields": [{"type": "mrkdwn", "text": f"*{key}*\n{value}"} for key, value in fields.items()],
+    }
+
+
+def build_button_accessory(text: str, url: str, style: str = "primary") -> dict:
+    """Build a button accessory."""
+    return {
+        "type": "button",
+        "text": {"type": "plain_text", "text": text, "emoji": True},
+        "url": url,
+        "style": style,
+    }
+
+
+def build_pipeline_success_message(
+    pipeline_name: str,
+    run_id: str,
+    duration: float,
+    metrics: dict[str, float] | None = None,
+    ui_url: str | None = None,
+) -> dict:
+    """Build a rich message for pipeline success."""
+    emoji = _get_emoji("success")
+
+    blocks = [
+        build_header_block("Pipeline Completed Successfully", emoji),
+        build_section_block(f"*{pipeline_name}* finished in `{duration:.2f}s`"),
+        build_divider(),
+        build_fields_section(
+            {
+                "Run ID": f"`{run_id[:12]}...`",
+                "Duration": f"{duration:.2f} seconds",
+                "Status": "✅ Success",
+                "Completed": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+            },
+        ),
+    ]
+
+    if metrics:
+        metrics_text = "\n".join([f"• *{k}*: `{v:.4f}`" for k, v in metrics.items()])
+        blocks.append(build_section_block(f"*Metrics:*\n{metrics_text}"))
+
+    if ui_url:
+        blocks.append(
+            build_section_block(
+                "View run details in the FlowyML dashboard:",
+                accessory=build_button_accessory("View Run", f"{ui_url}/runs/{run_id}"),
+            ),
+        )
+
+    blocks.append(
+        build_context_block([f"FlowyML | {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"]),
+    )
+
+    return {
+        "attachments": [
+            {
+                "color": _get_color("success"),
+                "blocks": blocks,
+            },
+        ],
+    }
+
+
+def build_pipeline_failure_message(
+    pipeline_name: str,
+    run_id: str,
+    error: str,
+    step_name: str | None = None,
+    ui_url: str | None = None,
+) -> dict:
+    """Build a rich message for pipeline failure."""
+    emoji = _get_emoji("error")
+
+    blocks = [
+        build_header_block("Pipeline Failed", emoji),
+        build_section_block(f"*{pipeline_name}* encountered an error"),
+        build_divider(),
+        build_fields_section(
+            {
+                "Run ID": f"`{run_id[:12]}...`",
+                "Status": "❌ Failed",
+                "Failed At": step_name or "Unknown step",
+                "Time": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+            },
+        ),
+        build_section_block(f"*Error:*\n```{error[:500]}```"),
+    ]
+
+    if ui_url:
+        blocks.append(
+            build_section_block(
+                "Investigate the failure in the FlowyML dashboard:",
+                accessory=build_button_accessory("View Run", f"{ui_url}/runs/{run_id}", style="danger"),
+            ),
+        )
+
+    blocks.append(
+        build_context_block([f"FlowyML | {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"]),
+    )
+
+    return {
+        "attachments": [
+            {
+                "color": _get_color("error"),
+                "blocks": blocks,
+            },
+        ],
+    }
+
+
+def build_drift_warning_message(
+    feature: str,
+    psi: float,
+    threshold: float = 0.2,
+    model_name: str | None = None,
+    ui_url: str | None = None,
+) -> dict:
+    """Build a rich message for data drift detection."""
+    emoji = _get_emoji("warning")
+    severity = "High" if psi > 0.5 else "Medium" if psi > 0.25 else "Low"
+
+    blocks = [
+        build_header_block("Data Drift Detected", emoji),
+        build_section_block(
+            f"Drift detected in feature *{feature}*" + (f" for model *{model_name}*" if model_name else ""),
+        ),
+        build_divider(),
+        build_fields_section(
+            {
+                "Feature": feature,
+                "PSI Score": f"`{psi:.4f}`",
+                "Threshold": f"`{threshold:.2f}`",
+                "Severity": f"{'🔴' if severity == 'High' else '🟡' if severity == 'Medium' else '🟢'} {severity}",
+            },
+        ),
+        build_section_block(
+            "💡 *Recommended Actions:*\n"
+            "• Review recent data pipeline changes\n"
+            "• Check for upstream data quality issues\n"
+            "• Consider retraining the model if drift persists",
+        ),
+    ]
+
+    if ui_url:
+        blocks.append(
+            build_section_block(
+                "View drift analysis in the dashboard:",
+                accessory=build_button_accessory("View Analysis", f"{ui_url}/monitoring/drift"),
+            ),
+        )
+
+    blocks.append(
+        build_context_block([f"FlowyML Monitoring | {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"]),
+    )
+
+    return {
+        "attachments": [
+            {
+                "color": _get_color("warning"),
+                "blocks": blocks,
+            },
+        ],
+    }
+
+
+def build_model_promoted_message(
+    model_name: str,
+    version: str,
+    from_stage: str,
+    to_stage: str,
+    author: str | None = None,
+    metrics: dict[str, float] | None = None,
+    ui_url: str | None = None,
+) -> dict:
+    """Build a rich message for model promotion."""
+    emoji = "🚀" if to_stage == "production" else "📦"
+
+    blocks = [
+        build_header_block(f"Model Promoted to {to_stage.title()}", emoji),
+        build_section_block(f"*{model_name}* version `{version}` has been promoted"),
+        build_divider(),
+        build_fields_section(
+            {
+                "Model": model_name,
+                "Version": f"`{version}`",
+                "Transition": f"{from_stage} → *{to_stage}*",
+                "Promoted By": author or "System",
+            },
+        ),
+    ]
+
+    if metrics:
+        metrics_text = " | ".join([f"*{k}*: `{v:.4f}`" for k, v in metrics.items()])
+        blocks.append(build_context_block([f"Metrics: {metrics_text}"]))
+
+    if ui_url:
+        blocks.append(
+            build_section_block(
+                "View model in registry:",
+                accessory=build_button_accessory("View Model", f"{ui_url}/models/{model_name}"),
+            ),
+        )
+
+    blocks.append(
+        build_context_block([f"FlowyML Registry | {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"]),
+    )
+
+    return {
+        "attachments": [
+            {
+                "color": _get_color("success") if to_stage == "production" else _get_color("info"),
+                "blocks": blocks,
+            },
+        ],
+    }
+
+
+def build_simple_message(
+    title: str,
+    message: str,
+    level: str = "info",
+    metadata: dict[str, Any] | None = None,
+) -> dict:
+    """Build a simple notification message."""
+    emoji = _get_emoji(level)
+
+    blocks = [
+        build_header_block(title, emoji),
+        build_section_block(message),
+    ]
+
+    if metadata:
+        blocks.append(build_divider())
+        blocks.append(build_fields_section(metadata))
+
+    blocks.append(
+        build_context_block([f"FlowyML | {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"]),
+    )
+
+    return {
+        "attachments": [
+            {
+                "color": _get_color(level),
+                "blocks": blocks,
+            },
+        ],
+    }

flowyml/plugins/__init__.py

@@ -0,0 +1,251 @@
+"""FlowyML Native Plugin System.
+
+A powerful, extensible plugin system that allows you to easily
+integrate with external tools without requiring any framework dependencies.
+
+Quick Start:
+    # Install a plugin (just installs the underlying packages)
+    from flowyml.plugins import install, load, get_plugin
+
+    install("mlflow")   # Installs mlflow package directly
+
+    # Load and use
+    tracker = get_plugin("mlflow", tracking_uri="http://localhost:5000")
+    tracker.start_run("my_experiment")
+    tracker.log_metrics({"accuracy": 0.95})
+    tracker.end_run()
+
+Config-Based Usage (Recommended):
+    # flowyml.yaml
+    plugins:
+      experiment_tracker:
+        type: mlflow
+        tracking_uri: http://localhost:5000
+      artifact_store:
+        type: gcs
+        bucket: my-ml-artifacts
+
+    # In code - just use, no setup needed
+    from flowyml.plugins.stack import (
+        start_run, log_metrics, save_artifact, save_model
+    )
+
+    start_run("my_training")
+    log_metrics({"accuracy": 0.95})
+    save_model(model, "models/classifier")
+
+CLI Usage:
+    # List available plugins
+    flowyml plugin list
+
+    # Install a plugin
+    flowyml plugin install mlflow
+
+    # Initialize config
+    flowyml stack init --tracker mlflow --store gcs
+
+Extending FlowyML:
+    Community plugins can register via Python entry points:
+
+    # In pyproject.toml
+    [project.entry-points."flowyml.plugins"]
+    my_tracker = "my_package.plugins:MyTracker"
+"""
+
+# Base classes for creating plugins
+from flowyml.plugins.base import (
+    BasePlugin,
+    PluginType,
+    PluginMetadata,
+    # Core plugin types
+    ExperimentTracker,
+    ArtifactStorePlugin,
+    OrchestratorPlugin,
+    ContainerRegistryPlugin,
+    FeatureStorePlugin,
+    DataValidatorPlugin,
+    ModelRegistryPlugin,
+    ModelDeployerPlugin,
+    AlerterPlugin,
+)
+
+# Registry for discovering plugins
+from flowyml.plugins.registry import (
+    PluginInfo,
+    PluginStatus,
+    PLUGIN_CATALOG,
+    get_plugin_info,
+    list_plugins,
+    list_plugin_names,
+    register_plugin,
+    unregister_plugin,
+)
+
+# Manager for installing and loading plugins
+from flowyml.plugins.manager import (
+    PluginManager,
+    get_manager,
+    install,
+    load,
+    get_plugin,
+    list_available,
+    list_installed,
+    is_installed,
+)
+
+# Config-based plugin access
+from flowyml.plugins.config import (
+    PluginConfig,
+    get_config,
+    reload_config,
+    get_tracker,
+    get_artifact_store,
+    get_orchestrator,
+    get_container_registry,
+    get_feature_store,
+    get_data_validator,
+    get_alerter,
+    generate_config_template,
+)
+
+# Multi-stack configuration
+from flowyml.plugins.stack_config import (
+    StackManager,
+    StackConfig,
+    ArtifactRoutingRule,
+    ArtifactRoutingConfig,
+    get_stack_manager,
+    get_active_stack,
+    list_stacks,
+    set_active_stack,
+    use_stack,
+    use_stack_decorator,
+    get_routing_for_type,
+)
+
+# Unified stack interface (config-driven)
+from flowyml.plugins.stack import (
+    # Experiment tracking
+    start_run,
+    end_run,
+    run,
+    log_params,
+    log_metrics,
+    log_artifact,
+    set_tag,
+    set_tags,
+    # Artifact storage
+    save_artifact,
+    load_artifact,
+    artifact_exists,
+    list_artifacts,
+    delete_artifact,
+    # Model management
+    save_model,
+    load_model,
+    # Container registry
+    push_image,
+    get_image_uri,
+    # Orchestration
+    run_pipeline,
+    # Alerts
+    send_alert,
+    # Stack info
+    show_stack,
+    validate_stack,
+)
+
+# Pipeline integration
+from flowyml.plugins.integration import (
+    StackContext,
+    run_with_stack,
+    tracked,
+    PipelinePluginIntegration,
+    get_integration,
+)
+
+__all__ = [
+    # Base classes
+    "BasePlugin",
+    "PluginType",
+    "PluginMetadata",
+    "ExperimentTracker",
+    "ArtifactStorePlugin",
+    "OrchestratorPlugin",
+    "ContainerRegistryPlugin",
+    "FeatureStorePlugin",
+    "DataValidatorPlugin",
+    "ModelRegistryPlugin",
+    "ModelDeployerPlugin",
+    "AlerterPlugin",
+    # Registry
+    "PluginInfo",
+    "PluginStatus",
+    "PLUGIN_CATALOG",
+    "get_plugin_info",
+    "list_plugins",
+    "list_plugin_names",
+    "register_plugin",
+    "unregister_plugin",
+    # Manager
+    "PluginManager",
+    "get_manager",
+    "install",
+    "load",
+    "get_plugin",
+    "list_available",
+    "list_installed",
+    "is_installed",
+    # Config
+    "PluginConfig",
+    "get_config",
+    "reload_config",
+    "get_tracker",
+    "get_artifact_store",
+    "get_orchestrator",
+    "get_container_registry",
+    "get_feature_store",
+    "get_data_validator",
+    "get_alerter",
+    "generate_config_template",
+    # Stack (unified interface)
+    "start_run",
+    "end_run",
+    "run",
+    "log_params",
+    "log_metrics",
+    "log_artifact",
+    "set_tag",
+    "set_tags",
+    "save_artifact",
+    "load_artifact",
+    "artifact_exists",
+    "list_artifacts",
+    "delete_artifact",
+    "save_model",
+    "load_model",
+    "push_image",
+    "get_image_uri",
+    "run_pipeline",
+    "send_alert",
+    "show_stack",
+    "validate_stack",
+    # Integration
+    "StackContext",
+    "run_with_stack",
+    "tracked",
+    "PipelinePluginIntegration",
+    "get_integration",
+    # Multi-stack configuration
+    "StackManager",
+    "StackConfig",
+    "ArtifactRoutingRule",
+    "ArtifactRoutingConfig",
+    "get_stack_manager",
+    "get_active_stack",
+    "list_stacks",
+    "set_active_stack",
+    "use_stack",
+    "use_stack_decorator",
+    "get_routing_for_type",
+]

flowyml/plugins/alerters/__init__.py

@@ -0,0 +1 @@
+"""Alerter plugins for FlowyML."""