model-compose 0.4.8__tar.gz → 0.4.10__tar.gz

{model_compose-0.4.8/src/model_compose.egg-info → model_compose-0.4.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: model-compose
-Version: 0.4.8
+Version: 0.4.10
 Summary: model-compose: Declarative AI Model and Workflow Orchestrator
 Author-email: Hanyeol Cho <hanyeol.cho@gmail.com>
 License-Expression: MIT
@@ -65,6 +65,26 @@ pip install -e .
 
 ---
 
+## 📚 Documentation
+
+**📖 [Complete User Guide](docs/user-guide/00-table-of-contents.md)**
+
+Need help getting started or want to explore advanced features? Check out our comprehensive user guide:
+
+- **🌍 English**: [User Guide](docs/user-guide/00-table-of-contents.md)
+- **🇰🇷 한국어**: [사용자 가이드](docs/user-guide/ko/00-table-of-contents.md)
+
+The guide covers everything from basic concepts to advanced workflows, including:
+- Getting started with model-compose
+- Component and workflow configuration
+- Local AI models and training
+- Streaming mode and variable binding
+- System integration with listeners and gateways
+- Deployment strategies
+- Practical examples and troubleshooting
+
+---
+
 ## 🚀 How to Run
 
 **model-compose** provides a CLI interface to launch and manage your AI workflows — inspired by `docker-compose`.
@@ -194,35 +214,7 @@ This minimal example defines a simple workflow that calls the OpenAI ChatGPT API
 
 You can easily expand this example by adding more components (e.g., text-to-speech, image generation) and connecting them through additional jobs.
 
-#### 📡 Listener Example
-
-```
-listener:
-  type: http-callback
-  port: 8090
-  base_path: /callbacks
-  callbacks:
-    - path: /chat-ai
-      method: POST
-      item: ${body.data}
-      identify_by: ${item.task_id}
-      result: ${item.choices[0].message.content}
-```
-
-This listener sets up an HTTP callback endpoint at `http://localhost:8090/callbacks/chat-ai` to handle asynchronous responses from an external service that behaves like ChatGPT but supports delayed or push-based results. This is useful when integrating with services that notify results via webhook-style callbacks.
-
-#### 🌐 Gateway Example
-
-```
-gateway:
-  type: http-tunnel
-  driver: ngrok
-  port: 8090
-```
-
-This gateway configuration exposes the local listener defined above to the public internet using an HTTP tunnel powered by ngrok. It forwards incoming traffic from a secure, public URL (e.g., `https://abc123.ngrok.io`) directly to your local callback endpoint at `http://localhost:8090`. This is essential when integrating with third-party services that need to push data back to your workflow via webhooks or asynchronous callbacks.
-
-> 📁 For more example model-compose.yml configurations, check the [examples directory](examples) in the source code.
+> 📁 For more example configurations including listeners, gateways, and advanced workflows, check the [examples directory](examples) or refer to the [User Guide](docs/user-guide/00-table-of-contents.md).
 
 ---
 ## 🖥 Web UI

{model_compose-0.4.8 → model_compose-0.4.10}/README.md

@@ -41,6 +41,26 @@ pip install -e .
 
 ---
 
+## 📚 Documentation
+
+**📖 [Complete User Guide](docs/user-guide/00-table-of-contents.md)**
+
+Need help getting started or want to explore advanced features? Check out our comprehensive user guide:
+
+- **🌍 English**: [User Guide](docs/user-guide/00-table-of-contents.md)
+- **🇰🇷 한국어**: [사용자 가이드](docs/user-guide/ko/00-table-of-contents.md)
+
+The guide covers everything from basic concepts to advanced workflows, including:
+- Getting started with model-compose
+- Component and workflow configuration
+- Local AI models and training
+- Streaming mode and variable binding
+- System integration with listeners and gateways
+- Deployment strategies
+- Practical examples and troubleshooting
+
+---
+
 ## 🚀 How to Run
 
 **model-compose** provides a CLI interface to launch and manage your AI workflows — inspired by `docker-compose`.
@@ -170,35 +190,7 @@ This minimal example defines a simple workflow that calls the OpenAI ChatGPT API
 
 You can easily expand this example by adding more components (e.g., text-to-speech, image generation) and connecting them through additional jobs.
 
-#### 📡 Listener Example
-
-```
-listener:
-  type: http-callback
-  port: 8090
-  base_path: /callbacks
-  callbacks:
-    - path: /chat-ai
-      method: POST
-      item: ${body.data}
-      identify_by: ${item.task_id}
-      result: ${item.choices[0].message.content}
-```
-
-This listener sets up an HTTP callback endpoint at `http://localhost:8090/callbacks/chat-ai` to handle asynchronous responses from an external service that behaves like ChatGPT but supports delayed or push-based results. This is useful when integrating with services that notify results via webhook-style callbacks.
-
-#### 🌐 Gateway Example
-
-```
-gateway:
-  type: http-tunnel
-  driver: ngrok
-  port: 8090
-```
-
-This gateway configuration exposes the local listener defined above to the public internet using an HTTP tunnel powered by ngrok. It forwards incoming traffic from a secure, public URL (e.g., `https://abc123.ngrok.io`) directly to your local callback endpoint at `http://localhost:8090`. This is essential when integrating with third-party services that need to push data back to your workflow via webhooks or asynchronous callbacks.
-
-> 📁 For more example model-compose.yml configurations, check the [examples directory](examples) in the source code.
+> 📁 For more example configurations including listeners, gateways, and advanced workflows, check the [examples directory](examples) or refer to the [User Guide](docs/user-guide/00-table-of-contents.md).
 
 ---
 ## 🖥 Web UI

{model_compose-0.4.8 → model_compose-0.4.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "model-compose"
-version = "0.4.8"
+version = "0.4.10"
 description = "model-compose: Declarative AI Model and Workflow Orchestrator"
 authors = [
     { name = "Hanyeol Cho", email = "hanyeol.cho@gmail.com" }

{model_compose-0.4.8 → model_compose-0.4.10}/src/mindor/cli/compose.py

@@ -1,11 +1,18 @@
-import click
-import json
+from typing import Optional, List
+import importlib.metadata
 from pathlib import Path
+import click
 import asyncio
+import json
 
-from mindor.dsl.loader import load_compose_config
-from mindor.core.runtime.env import load_env_files, merge_env_data
-from mindor.core.compose import *
+def _load_compose_config(config_files: List[Path], env_files: List[Path], env_data: List[str]):
+    from mindor.dsl.loader import load_compose_config
+    from mindor.core.runtime.env import load_env_files, merge_env_data
+
+    env = load_env_files(".", env_files or [])
+    env = merge_env_data(env, env_data)
+
+    return load_compose_config(".", config_files, env)
 
 @click.group()
 @click.option(
@@ -13,6 +20,10 @@ from mindor.core.compose import *
     type=click.Path(exists=True, dir_okay=False, path_type=Path),
     help="Compose configuration files."
 )
+@click.version_option(
+    version=importlib.metadata.version("model-compose"),
+    message="%(prog)s %(version)s"
+)
 @click.pass_context
 def compose_command(ctx: click.Context, config_files: List[Path]) -> None:
     """model-compose"""
@@ -34,18 +45,17 @@ def compose_command(ctx: click.Context, config_files: List[Path]) -> None:
 @click.option("--verbose", "-v", is_flag=True, help="Enable verbose output.")
 @click.pass_context
 def up_command(
-    ctx: click.Context, 
+    ctx: click.Context,
     detach: bool,
     env_files: List[Path],
     env_data: List[str],
     verbose: bool
 ) -> None:
+    from mindor.core.compose import launch_services
     config_files = ctx.obj.get("config_files", [])
     async def _async_command():
         try:
-            env = load_env_files(".", env_files or [])
-            env = merge_env_data(env, env_data)
-            config = load_compose_config(".", config_files, env)
+            config = _load_compose_config(config_files, env_files, env_data)
             await launch_services(config, detach, verbose)
         except Exception as e:
             click.echo(f"❌ {e}", err=True)
@@ -70,12 +80,11 @@ def down_command(
     env_data: List[str],
     verbose: bool
 ) -> None:
+    from mindor.core.compose import terminate_services
     config_files = ctx.obj.get("config_files", [])
     async def _async_command():
         try:
-            env = load_env_files(".", env_files or [])
-            env = merge_env_data(env, env_data)
-            config = load_compose_config(".", config_files, env)
+            config = _load_compose_config(config_files, env_files, env_data)
             await terminate_services(config, verbose)
         except Exception as e:
             click.echo(f"❌ {e}", err=True)
@@ -100,12 +109,11 @@ def start_command(
     env_data: List[str],
     verbose: bool
 ) -> None:
+    from mindor.core.compose import start_services
     config_files = ctx.obj.get("config_files", [])
     async def _async_command():
         try:
-            env = load_env_files(".", env_files or [])
-            env = merge_env_data(env, env_data)
-            config = load_compose_config(".", config_files, env)
+            config = _load_compose_config(config_files, env_files, env_data)
             await start_services(config, verbose)
         except Exception as e:
             click.echo(f"❌ {e}", err=True)
@@ -130,12 +138,11 @@ def stop_command(
     env_data: List[str],
     verbose: bool
 ) -> None:
+    from mindor.core.compose import stop_services
     config_files = ctx.obj.get("config_files", [])
     async def _async_command():
         try:
-            env = load_env_files(".", env_files or [])
-            env = merge_env_data(env, env_data)
-            config = load_compose_config(".", config_files, env)
+            config = _load_compose_config(config_files, env_files, env_data)
             await stop_services(config, verbose)
         except Exception as e:
             click.echo(f"❌ {e}", err=True)
@@ -176,12 +183,11 @@ def run_command(
     output_path: Optional[Path],
     verbose: bool
 ) -> None:
+    from mindor.core.compose import run_workflow
     config_files = ctx.obj.get("config_files", [])
     async def _async_command():
         try:
-            env = load_env_files(".", env_files or [])
-            env = merge_env_data(env, env_data)
-            config = load_compose_config(".", config_files, env)
+            config = _load_compose_config(config_files, env_files, env_data)
             input = json.loads(input_json) if input_json else {}
             state = await run_workflow(config, workflow_id or "__default__", input, output_path, verbose)
             if isinstance(state.output, (dict, list)) or state.error:

{model_compose-0.4.8 → model_compose-0.4.10}/src/mindor/core/component/context.py

@@ -1,6 +1,7 @@
 from typing import Type, Union, Literal, Optional, Dict, List, Tuple, Set, Annotated, Any
 from mindor.core.utils.renderers import VariableRenderer, ImageValueRenderer
 from mindor.core.gateway import find_gateway_by_port
+from PIL import Image as PILImage
 
 class ComponentActionContext:
     def __init__(self, run_id: str, input: Dict[str, Any]):
@@ -16,7 +17,7 @@ class ComponentActionContext:
     async def render_variable(self, value: Any, ignore_files: bool = False) -> Any:
         return await self.renderer.render(value, ignore_files)
 
-    async def render_image(self, value: Any) -> Any:
+    async def render_image(self, value: Any) -> Optional[PILImage.Image]:
         return await ImageValueRenderer().render(await self.render_variable(value))
 
     def contains_variable_reference(self, key: str, value: Any) -> bool:

{model_compose-0.4.8 → model_compose-0.4.10}/src/mindor/core/component/services/__init__.py

@@ -8,3 +8,4 @@ from .vector_store import *
 from .workflow import *
 from .shell import *
 from .text_splitter import *
+from .image_processor import *

{model_compose-0.4.8 → model_compose-0.4.10}/src/mindor/core/component/services/datasets/datasets.py

@@ -6,6 +6,7 @@ from mindor.dsl.schema.action import DatasetsActionConfig, DatasetsActionMethod,
 from ...base import ComponentService, ComponentType, ComponentGlobalConfigs, register_component
 from ...context import ComponentActionContext
 from .providers import HuggingfaceDatasetsProvider, LocalDatasetsProvider
+from .utils import format_template_example
 
 if TYPE_CHECKING:
     from datasets import Dataset
@@ -30,6 +31,9 @@ class DatasetsAction:
         if self.config.method == DatasetsActionMethod.SELECT:
             return await self._select(context)
 
+        if self.config.method == DatasetsActionMethod.MAP:
+            return await self._map(context)
+
         raise ValueError(f"Unsupported datasets action method: {self.config.method}")
 
     async def _load(self, context: ComponentActionContext) -> Dataset:
@@ -64,6 +68,10 @@ class DatasetsAction:
         info      = await context.render_variable(self.config.info)
         split     = await context.render_variable(self.config.split)
 
+        for dataset in datasets:
+            if not isinstance(dataset, Dataset):
+                raise ValueError(f"Expected Dataset instance, but got {type(dataset).__name__}")
+
         return concatenate_datasets(
             datasets,
             info=info,
@@ -77,6 +85,9 @@ class DatasetsAction:
         indices = await context.render_variable(self.config.indices)
         columns = await context.render_variable(self.config.columns)
 
+        if not isinstance(dataset, Dataset):
+            raise ValueError(f"Expected Dataset instance, but got {type(dataset).__name__}")
+
         if axis == "rows":
             if indices is None:
                 raise ValueError("indices must be provided when axis='rows'")
@@ -89,6 +100,20 @@ class DatasetsAction:
 
         raise ValueError(f"Unsupported axis: {axis}")
 
+    async def _map(self, context: ComponentActionContext) -> Dataset:
+        dataset        = await context.render_variable(self.config.dataset)
+        template       = await context.render_variable(self.config.template)
+        output_column  = await context.render_variable(self.config.output_column)
+        remove_columns = await context.render_variable(self.config.remove_columns)
+
+        if not isinstance(dataset, Dataset):
+            raise ValueError(f"Expected Dataset instance, but got {type(dataset).__name__}")
+
+        def format_example(example):
+            return { output_column: format_template_example(template, example) }
+
+        return dataset.map(format_example, remove_columns=remove_columns)
+
 @register_component(ComponentType.DATASETS)
 class DatasetsComponent(ComponentService):
     def __init__(self, id: str, config: DatasetsActionConfig, global_configs: ComponentGlobalConfigs, daemon: bool):

model_compose-0.4.10/src/mindor/core/component/services/datasets/utils.py

@@ -0,0 +1,12 @@
+from typing import Dict, List, Any
+import re
+
+def format_template_example(template: str, example: Dict[str, Any]) -> str:
+    column_names = set(re.findall(r"\{(\w+)\}", template))
+    formatted = template
+
+    for column in column_names:
+        if column in example:
+            formatted = formatted.replace(f"{{{column}}}", str(example[column]))
+
+    return formatted

model_compose-0.4.10/src/mindor/core/component/services/image_processor.py

@@ -0,0 +1,210 @@
+from typing import Type, Union, Literal, Optional, Dict, List, Tuple, Set, Annotated, Any
+from mindor.dsl.schema.component import ImageProcessorComponentConfig
+from mindor.dsl.schema.action import ActionConfig, ImageProcessorActionConfig, ImageProcessorActionMethod, ImageScaleMode, FlipDirection
+from ..base import ComponentService, ComponentType, ComponentGlobalConfigs, register_component
+from ..context import ComponentActionContext
+from PIL import Image as PILImage, ImageFilter, ImageEnhance
+
+class ImageProcessorAction:
+    def __init__(self, config: ImageProcessorActionConfig):
+        self.config: ImageProcessorActionConfig = config
+
+    async def run(self, context: ComponentActionContext) -> Any:
+        result = await self._dispatch(context)
+        context.register_source("result", result)
+
+        return (await context.render_variable(self.config.output, ignore_files=True)) if self.config.output else result
+
+    async def _dispatch(self, context: ComponentActionContext) -> Any:
+        if self.config.method == ImageProcessorActionMethod.RESIZE:
+            return await self._resize(context)
+
+        if self.config.method == ImageProcessorActionMethod.CROP:
+            return await self._crop(context)
+
+        if self.config.method == ImageProcessorActionMethod.ROTATE:
+            return await self._rotate(context)
+
+        if self.config.method == ImageProcessorActionMethod.FLIP:
+            return await self._flip(context)
+
+        if self.config.method == ImageProcessorActionMethod.GRAYSCALE:
+            return await self._grayscale(context)
+
+        if self.config.method == ImageProcessorActionMethod.BLUR:
+            return await self._blur(context)
+
+        if self.config.method == ImageProcessorActionMethod.SHARPEN:
+            return await self._sharpen(context)
+
+        if self.config.method == ImageProcessorActionMethod.ADJUST_BRIGHTNESS:
+            return await self._adjust_brightness(context)
+
+        if self.config.method == ImageProcessorActionMethod.ADJUST_CONTRAST:
+            return await self._adjust_contrast(context)
+
+        if self.config.method == ImageProcessorActionMethod.ADJUST_SATURATION:
+            return await self._adjust_saturation(context)
+
+        raise ValueError(f"Unsupported image processing action method: {self.config.method}")
+
+    async def _resize(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image      = await context.render_image(self.config.image)
+        width      = await context.render_variable(self.config.width) if self.config.width else None
+        height     = await context.render_variable(self.config.height) if self.config.height else None
+        scale_mode = await context.render_variable(self.config.scale_mode)
+
+        if width is None and height is None:
+            raise ValueError("At least one of width or height must be specified for resize")
+
+        if image:
+            return self._resize_image(image, width, height, scale_mode)
+        
+        return None
+
+    async def _crop(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        x      = await context.render_variable(self.config.x)
+        y      = await context.render_variable(self.config.y)
+        width  = await context.render_variable(self.config.width)
+        height = await context.render_variable(self.config.height)
+
+        if image:
+            return image.crop(x, y, x + width, y + height)
+        
+        return None
+
+    async def _rotate(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        angle  = await context.render_variable(self.config.angle)
+        expand = await context.render_variable(self.config.expand)
+
+        if image:
+            return image.rotate(-angle, expand=expand, resample=PILImage.Resampling.BICUBIC)
+
+        return None
+
+    async def _flip(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image     = await context.render_image(self.config.image)
+        direction = await context.render_variable(self.config.direction)
+
+        if image:
+            if direction == FlipDirection.HORIZONTAL:
+                return image.transpose(PILImage.Transpose.FLIP_LEFT_RIGHT)
+
+            if direction == FlipDirection.VERTICAL:
+                return image.transpose(PILImage.Transpose.FLIP_TOP_BOTTOM)
+
+        return None
+
+    async def _grayscale(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image = await context.render_image(self.config.image)
+
+        if image:
+            return image.convert("L")
+
+        return None
+
+    async def _blur(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        radius = await context.render_variable(self.config.radius)
+
+        if image:
+            return image.filter(ImageFilter.GaussianBlur(radius=radius))
+
+    async def _sharpen(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        factor = await context.render_variable(self.config.factor)
+
+        if image:
+            return ImageEnhance.Sharpness(image).enhance(factor)
+
+        return FileNotFoundError
+
+    async def _adjust_brightness(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        factor = await context.render_variable(self.config.factor)
+
+        if image:
+            return ImageEnhance.Brightness(image).enhance(factor)
+
+        return None
+
+    async def _adjust_contrast(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        factor = await context.render_variable(self.config.factor)
+
+        if image:
+            return ImageEnhance.Contrast(image).enhance(factor)
+
+        return image
+
+    async def _adjust_saturation(self, context: ComponentActionContext) -> Optional[PILImage.Image]:
+        image  = await context.render_image(self.config.image)
+        factor = await context.render_variable(self.config.factor)
+
+        if image:
+            return ImageEnhance.Color(image).enhance(factor)
+
+        return None
+
+    def _resize_image(self, image: PILImage.Image, width: int, height: int, scale_mode: str) -> PILImage.Image:
+        original_width, original_height = image.size
+        target_width  = width  or original_width
+        target_height = height or original_height
+
+        if scale_mode == ImageScaleMode.FIT:
+            new_width, new_height = self._get_size_aspect_fit(target_width, target_height, original_width, original_height)
+            return image.resize((new_width, new_height), PILImage.Resampling.LANCZOS)
+
+        if scale_mode == ImageScaleMode.FILL:
+            new_width, new_height = self._get_size_aspect_fill(target_width, target_height, original_width, original_height)
+            image = image.resize((new_width, new_height), PILImage.Resampling.LANCZOS)
+
+            crop_box = self._get_center_crop_box(new_width, new_height, target_width, target_height)
+            return image.crop(crop_box)
+
+        if scale_mode == ImageScaleMode.STRETCH:
+            return image.resize((target_width, target_height), PILImage.Resampling.LANCZOS)
+
+        raise ValueError(f"Invalid scale_mode: {scale_mode}")
+
+    def _get_size_aspect_fit(self, target_width: int, target_height: int, original_width: int, original_height: int) -> Tuple[int, int]:
+        aspect_ratio = original_width / original_height
+
+        height = target_height
+        width  = height * aspect_ratio
+
+        if width > target_width:
+            width  = target_width
+            height = width / aspect_ratio
+
+        return (int(width), int(height))
+
+    def _get_size_aspect_fill(self, target_width: int, target_height: int, original_width: int, original_height: int) -> Tuple[int, int]:
+        aspect_ratio = original_width / original_height
+
+        height = target_height
+        width  = height * aspect_ratio
+
+        if width < target_width:
+            width  = target_width
+            height = width / aspect_ratio
+
+        return (int(width), int(height))
+
+    def _get_center_crop_box(self, image_width: int, image_height: int, target_width: int, target_height: int) -> Tuple[int, int, int, int]:
+        left   = (image_width  - target_width ) // 2
+        top    = (image_height - target_height) // 2
+        right  = left + target_width
+        bottom = top + target_height
+
+        return (left, top, right, bottom)
+
+@register_component(ComponentType.IMAGE_PROCESSOR)
+class ImageProcessorComponent(ComponentService):
+    def __init__(self, id: str, config: ImageProcessorComponentConfig, global_configs: ComponentGlobalConfigs, daemon: bool):
+        super().__init__(id, config, global_configs, daemon)
+
+    async def _run(self, action: ActionConfig, context: ComponentActionContext) -> Any:
+        return await ImageProcessorAction(action).run(context)