owl-imdl 1.0.0__tar.gz

owl_imdl-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 kwen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

owl_imdl-1.0.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: owl-imdl
+Version: 1.0.0
+Summary: IMDL template engine
+Author-email: kwen <aikwen@outlook.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: rich>=13.4.0
+Requires-Dist: python-statemachine>=3.0.0
+Requires-Dist: questionary>=2.1.1
+Requires-Dist: prettytable>=3.17.0
+Dynamic: license-file
+
+# owl-imdl
+![Python Version](https://img.shields.io/badge/python->3.7-blue)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation (TestPyPI)
+
+Currently, this package is available on **TestPyPI**. You can install it using the following command:
+
+```bash
+pip install -i https://test.pypi.org/simple/ owl-imdl
+```
+
+## Manual Dependencies
+
+To keep the package lightweight and flexible, this project does not enforce deep learning framework dependencies (to avoid version conflicts).
+
+Please manually install the following dependencies according to your environment before use:
+
+1. **PyTorch**: Visit [pytorch](https://pytorch.org/get-started/locally/) to get the command for your CUDA version.
+2. Other Essentials:
+```bash
+pip install numpy Pillow albumentations
+```
+
+## Quick Start
+
+### Initialize a Project
+
+Run the following command in any directory to generate a training script (e.g., `my_project.py`):
+
+```bash
+owl init
+```
+
+## Dataset Structure
+
+```text
+my_dataset/
+├── gt/                 # Ground Truth images
+├── tp/                 # Tampered/Target images
+└── my_dataset.json     # Index file (MUST match the folder name!)
+```
+
+JSON Format (my_dataset.json):
+
+```json
+[
+  {
+    "tp": "tampered_image_01.jpg",
+    "gt": "mask_01.png"
+  },
+  {
+    "tp": "tampered_image_02.jpg",
+    "gt": "mask_02.png"
+  }
+]
+```

owl_imdl-1.0.0/README.md

@@ -0,0 +1,57 @@
+# owl-imdl
+![Python Version](https://img.shields.io/badge/python->3.7-blue)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation (TestPyPI)
+
+Currently, this package is available on **TestPyPI**. You can install it using the following command:
+
+```bash
+pip install -i https://test.pypi.org/simple/ owl-imdl
+```
+
+## Manual Dependencies
+
+To keep the package lightweight and flexible, this project does not enforce deep learning framework dependencies (to avoid version conflicts).
+
+Please manually install the following dependencies according to your environment before use:
+
+1. **PyTorch**: Visit [pytorch](https://pytorch.org/get-started/locally/) to get the command for your CUDA version.
+2. Other Essentials:
+```bash
+pip install numpy Pillow albumentations
+```
+
+## Quick Start
+
+### Initialize a Project
+
+Run the following command in any directory to generate a training script (e.g., `my_project.py`):
+
+```bash
+owl init
+```
+
+## Dataset Structure
+
+```text
+my_dataset/
+├── gt/                 # Ground Truth images
+├── tp/                 # Tampered/Target images
+└── my_dataset.json     # Index file (MUST match the folder name!)
+```
+
+JSON Format (my_dataset.json):
+
+```json
+[
+  {
+    "tp": "tampered_image_01.jpg",
+    "gt": "mask_01.png"
+  },
+  {
+    "tp": "tampered_image_02.jpg",
+    "gt": "mask_02.png"
+  }
+]
+```

owl_imdl-1.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "owl-imdl"
+version = "1.0.0"
+description = "IMDL template engine"
+readme = "README.md"
+authors = [
+  {name = "kwen", email = "aikwen@outlook.com"},
+]
+license = "MIT"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "loguru>=0.7.3",
+    "rich>=13.4.0",
+    "python-statemachine>=3.0.0",
+    "questionary>=2.1.1",
+    "prettytable>=3.17.0",
+]
+
+[project.scripts]
+owl = "owl.cli.main:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

owl_imdl-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

owl_imdl-1.0.0/src/owl/__init__.py

@@ -0,0 +1,34 @@
+import importlib
+from typing import TYPE_CHECKING
+
+try:
+    from importlib.metadata import version
+    __version__ = version("owl-imdl")
+except ImportError:
+    __version__ = "unknown"
+
+# IDE 提示
+if TYPE_CHECKING:
+    from . import engine
+    from . import toolkits
+
+
+_delayed_imports = {
+    "engine": ".engine",
+    "toolkits": ".toolkits",
+}
+
+def __getattr__(name:str):
+    if name in _delayed_imports:
+        module =  importlib.import_module(_delayed_imports[name], package=__package__)
+        # 缓存
+        globals()[name] = module
+        return module
+    raise AttributeError(f"module 'owl' has no attribute '{name}'")
+
+
+__all__ = [
+    "__version__",
+    "engine",
+    "toolkits",
+]

owl_imdl-1.0.0/src/owl/cli/__init__.py

@@ -0,0 +1 @@
+from .main import main

owl_imdl-1.0.0/src/owl/cli/cmd_init.py

@@ -0,0 +1,64 @@
+from pathlib import Path
+import shutil
+import questionary
+from questionary import Choice
+
+TEMPLATE_DIR = Path(__file__).resolve().parent / "templates"
+
+def func(args):
+    choices = [
+        Choice(title="训练", value="train.py"),
+        Choice(title="微调", value="finetune.py"),
+        Choice(title="验证", value="val_metric.py"),
+        Choice(title="可视化", value="visual.py"),
+    ]
+    selected_template = questionary.select(
+        message="请选择一个要生成的模板 (上下键移动，回车确认):",
+        choices=choices
+    ).ask()
+
+    if not selected_template:
+        return
+
+    # 当前工作目录
+    current_cwd = Path.cwd()
+    # 选择的模板文件路径
+    src_path = TEMPLATE_DIR / selected_template
+    # 生成的模板文件
+    target_filename = selected_template
+    dst_path = current_cwd / target_filename
+
+    # 检查模板源文件是否存在
+    if not src_path.exists():
+        print(f"内部模板丢失: {src_path}")
+        return
+
+    # 文件名重复检测循环
+    while dst_path.exists():
+        print(f"文件 '{target_filename}' 在当前目录下已存在。")
+
+        # 让用户输入新名字
+        new_name = questionary.text(
+            "请输入新的文件名 (留空则取消):",
+            default=f"{target_filename}"
+        ).ask()
+
+        # 如果用户没输入直接取消
+        if not new_name or not new_name.strip():
+            print("操作已取消。")
+            return
+
+        # 更新目标文件名和路径并补全后缀
+        target_filename = new_name.strip()
+        if not target_filename.endswith(".py"):
+            target_filename += ".py"
+
+        dst_path = current_cwd / target_filename
+
+    # 复制
+    try:
+        shutil.copy(src_path, dst_path)
+        print(f"\n[success] 已生成文件: {dst_path.name}")
+        print(f"   路径: {dst_path}")
+    except Exception as e:
+        print(f"[fail] 无法写入文件: {e}")

owl_imdl-1.0.0/src/owl/cli/cmd_version.py

@@ -0,0 +1,3 @@
+def func(args):
+    from .. import __version__
+    print(__version__)

owl_imdl-1.0.0/src/owl/cli/main.py

@@ -0,0 +1,38 @@
+import argparse
+from . import cmd_version, cmd_init
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Owl - IMDL Deep Learning Training Framework CLI",
+        prog="owl"
+    )
+
+    subparsers = parser.add_subparsers(dest="command", required=True, help="可用命令")
+
+    # ==========================================
+    # 子命令: init (初始化)
+    # ==========================================
+    parser_init = subparsers.add_parser(
+        name="init",
+        help="初始化项目配置模板"
+    )
+    # 绑定处理函数
+    parser_init.set_defaults(func=cmd_init.func)
+
+    # ==========================================
+    # 子命令: version (版本)
+    # ==========================================
+    parser_version = subparsers.add_parser(
+        name="version",
+        help="查看版本号")
+    parser_version.set_defaults(func=cmd_version.func)
+
+    # ==========================================
+    # 解析参数并执行对应的函数
+    # ==========================================
+    args = parser.parse_args()
+
+    if hasattr(args, 'func'):
+        args.func(args)
+    else:
+        parser.print_help()

owl_imdl-1.0.0/src/owl/cli/templates/finetune.py

@@ -0,0 +1,110 @@
+import copy
+
+import torch
+import torch.nn as nn
+from owl.engine.app import OwlApp
+from owl.engine.state import ExecMode
+from owl.toolkits.data.dataloader import OwlDataLoader
+from owl.toolkits.data.types import DataLoaderConfig
+from owl.toolkits.model.base import OwlModel
+from owl.toolkits.criterion.base import OwlCriterion
+from owl.toolkits.model import MODELS
+from owl.toolkits.criterion import CRITERIA
+from owl.toolkits.data.augment.types import ResizeConfig
+
+
+# ==========================================
+# 模型
+# ==========================================
+@MODELS.register("dummy_model")
+class DummyModel(OwlModel):
+    def __init__(self, in_channels=3):
+        super().__init__()
+        self.conv = nn.Conv2d(in_channels, 1, kernel_size=3, padding=1)
+
+    def forward(self, batch_data, current_epoch=0, current_step=0, **kwargs):
+        x = batch_data["tp_tensor"]  # 篡改图输入: [B, 3, H, W]
+        logits = self.conv(x)         # 输出 Logits: [B, 1, H, W]
+        return {"logits": logits}
+
+
+# ==========================================
+# 损失函数
+# ==========================================
+@CRITERIA.register("dummy_loss")
+class DummyLoss(OwlCriterion):
+    def __init__(self):
+        super().__init__()
+        self.loss_fn = nn.BCEWithLogitsLoss()
+
+    def forward(self, model_outputs, batch_data, current_epoch=0, current_step=0, **kwargs):
+        logits = model_outputs["logits"]
+        gt = batch_data["gt_tensor"]
+        return self.loss_fn(logits, gt)
+
+
+def main():
+    # ==========================================
+    # 数据集配置
+    # ==========================================
+    # 指向你项目中的测试数据集目录 (根据运行位置调整)
+    dataset_paths = ["example","example"]
+    common_aug = [
+        ResizeConfig(height=256, width=256, p=1.0)
+    ]
+
+    # DataLoader 基础参数字典
+    base_dl_config = DataLoaderConfig(
+        batch_size=2,
+        num_workers=0,
+        shuffle=False,
+        pin_memory=False,
+        persistent_workers=False,
+        drop_last=False,
+    )
+
+    # 训练集 Loader
+    train_dl_config = copy.deepcopy(base_dl_config)
+    train_dl_config["shuffle"] = True
+    train_loader = OwlDataLoader(
+        dataset_paths=dataset_paths,
+        dataloader_config=train_dl_config,
+        aug_configs=common_aug
+    )
+
+    # 验证集 Loader (关闭打乱)
+    val_dl_config =copy.deepcopy(base_dl_config)
+    val_dl_config["shuffle"] = False
+    val_loader = OwlDataLoader(
+        dataset_paths=dataset_paths,
+        dataloader_config=val_dl_config,
+        aug_configs=common_aug
+    )
+
+    # ==========================================
+    # 启动 Owl Engine
+    # ==========================================
+    app = OwlApp()
+    # 微调需要添加权重，同时设置finetune=true
+    p = ""
+    app.launch(
+        mode=ExecMode.TRAIN,  # 训练模式
+        max_epochs=10,
+        ckpt_autosave=False,   # 自动保存
+        checkpoint_path=p,
+        finetune=True,
+        device="cuda" if torch.cuda.is_available() else "cpu",
+        # 挂载组件
+        model_name="dummy_model",
+        model_cfg={"in_channels": 3},
+        criterion_name="dummy_loss",
+        criterion_cfg={},
+
+        # 数据集
+        owl_train_loader=train_loader,
+        owl_val_loaders=val_loader,
+    )
+
+
+if __name__ == "__main__":
+    main()

owl_imdl-1.0.0/src/owl/cli/templates/train.py

@@ -0,0 +1,108 @@
+import copy
+
+import torch
+import torch.nn as nn
+from owl.engine.app import OwlApp
+from owl.engine.state import ExecMode
+from owl.toolkits.data.dataloader import OwlDataLoader
+from owl.toolkits.data.types import DataLoaderConfig
+from owl.toolkits.model.base import OwlModel
+from owl.toolkits.criterion.base import OwlCriterion
+from owl.toolkits.model import MODELS
+from owl.toolkits.criterion import CRITERIA
+from owl.toolkits.data.augment.types import ResizeConfig
+
+
+# ==========================================
+# 模型
+# ==========================================
+@MODELS.register("dummy_model")
+class DummyModel(OwlModel):
+    def __init__(self, in_channels=3):
+        super().__init__()
+        self.conv = nn.Conv2d(in_channels, 1, kernel_size=3, padding=1)
+
+    def forward(self, batch_data, current_epoch=0, current_step=0, **kwargs):
+        x = batch_data["tp_tensor"]  # 篡改图输入: [B, 3, H, W]
+        logits = self.conv(x)         # 输出 Logits: [B, 1, H, W]
+        return {"logits": logits}
+
+
+# ==========================================
+# 损失函数
+# ==========================================
+@CRITERIA.register("dummy_loss")
+class DummyLoss(OwlCriterion):
+    def __init__(self):
+        super().__init__()
+        self.loss_fn = nn.BCEWithLogitsLoss()
+
+    def forward(self, model_outputs, batch_data, current_epoch=0, current_step=0, **kwargs):
+        logits = model_outputs["logits"]
+        gt = batch_data["gt_tensor"]
+        return self.loss_fn(logits, gt)
+
+
+def main():
+    # ==========================================
+    # 数据集配置
+    # ==========================================
+    # 指向你项目中的测试数据集目录 (根据运行位置调整)
+    dataset_paths = ["example","example"]
+    common_aug = [
+        ResizeConfig(height=256, width=256, p=1.0)
+    ]
+
+    # DataLoader 基础参数字典
+    base_dl_config = DataLoaderConfig(
+        batch_size=2,
+        num_workers=0,
+        shuffle=False,
+        pin_memory=False,
+        persistent_workers=False,
+        drop_last=False,
+    )
+
+    # 训练集 Loader
+    train_dl_config = copy.deepcopy(base_dl_config)
+    train_dl_config["shuffle"] = True
+    train_loader = OwlDataLoader(
+        dataset_paths=dataset_paths,
+        dataloader_config=train_dl_config,
+        aug_configs=common_aug
+    )
+
+    # 验证集 Loader (关闭打乱)
+    val_dl_config =copy.deepcopy(base_dl_config)
+    val_dl_config["shuffle"] = False
+    val_loader = OwlDataLoader(
+        dataset_paths=dataset_paths,
+        dataloader_config=val_dl_config,
+        aug_configs=common_aug
+    )
+
+    # ==========================================
+    # 启动 Owl Engine
+    # ==========================================
+    app = OwlApp()
+
+    app.launch(
+        mode=ExecMode.TRAIN,  # 训练模式
+        max_epochs=10,
+        ckpt_autosave=True,   # 自动保存
+        device="cuda" if torch.cuda.is_available() else "cpu",
+
+        # 挂载组件
+        model_name="dummy_model",
+        model_cfg={"in_channels": 3},
+        criterion_name="dummy_loss",
+        criterion_cfg={},
+
+        # 数据集
+        owl_train_loader=train_loader,
+        owl_val_loaders=val_loader,
+    )
+
+
+if __name__ == "__main__":
+    main()

owl_imdl-1.0.0/src/owl/cli/templates/val_metric.py

@@ -0,0 +1,80 @@
+import copy
+import pathlib
+
+import torch
+import torch.nn as nn
+from owl.engine.app import OwlApp
+from owl.engine.state import ExecMode
+from owl.toolkits.data.dataloader import OwlDataLoader
+from owl.toolkits.data.types import DataLoaderConfig
+from owl.toolkits.model.base import OwlModel
+from owl.toolkits.criterion.base import OwlCriterion
+from owl.toolkits.model import MODELS
+from owl.toolkits.criterion import CRITERIA
+from owl.toolkits.data.augment.types import ResizeConfig
+
+
+# ==========================================
+# 模型
+# ==========================================
+@MODELS.register("dummy_model")
+class DummyModel(OwlModel):
+    def __init__(self, in_channels=3):
+        super().__init__()
+        self.conv = nn.Conv2d(in_channels, 1, kernel_size=3, padding=1)
+
+    def forward(self, batch_data, current_epoch=0, current_step=0, **kwargs):
+        x = batch_data["tp_tensor"]  # 篡改图输入: [B, 3, H, W]
+        logits = self.conv(x)         # 输出 Logits: [B, 1, H, W]
+        return {"logits": logits}
+
+def main():
+    # ==========================================
+    # 数据集配置
+    # ==========================================
+    # 指向你项目中的测试数据集目录 (根据运行位置调整)
+    dataset_paths = ["example", "example"]
+    common_aug = [
+        ResizeConfig(height=256, width=256, p=1.0)
+    ]
+
+    # DataLoader 基础参数字典
+    base_dl_config = DataLoaderConfig(
+        batch_size=2,
+        num_workers=0,
+        shuffle=False,
+        pin_memory=False,
+        persistent_workers=False,
+        drop_last=False,
+    )
+
+    # 验证集 Loader (关闭打乱)
+    val_dl_config =copy.deepcopy(base_dl_config)
+    val_dl_config["shuffle"] = False
+    val_loader = OwlDataLoader(
+        dataset_paths=dataset_paths,
+        dataloader_config=val_dl_config,
+        aug_configs=common_aug
+    )
+
+    # ==========================================
+    # 启动 Owl Engine
+    # ==========================================
+    app = OwlApp()
+    # 权重
+    p = r""
+    app.launch(
+        mode=ExecMode.VALIDATE,  # 测试模型
+        checkpoint_path=p,
+        device="cuda" if torch.cuda.is_available() else "cpu",
+        # 挂载组件
+        model_name="dummy_model",
+        model_cfg={"in_channels": 3},
+
+        # 数据集
+        owl_val_loaders=val_loader,
+    )
+
+
+if __name__ == "__main__":
+    main()

owl_imdl-1.0.0/src/owl/engine/__init__.py

@@ -0,0 +1,32 @@
+import importlib
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from . import app
+    from . import engine
+    from . import pipeline
+    from . import state
+
+_delayed_imports = {
+    "app": ".app",
+    "engine": ".engine",
+    "pipline": ".pipeline",
+    "state": ".state",
+}
+
+def __getattr__(name:str):
+    if name in _delayed_imports:
+        module =  importlib.import_module(_delayed_imports[name], package=__package__)
+        # 缓存
+        globals()[name] = module
+        return module
+
+    raise AttributeError(f"module 'core' has no attribute '{name}'")
+
+
+__all__ = [
+    "app",
+    "engine",
+    "pipeline",
+    "state",
+]