OpenVINO Training Extensions开发者手册：贡献代码与自定义模型教程

【免费下载链接】training_extensions 项目地址: https://gitcode.com/gh_mirrors/op/openvino_training_extensions

OpenVINO Training Extensions是一个功能强大的开源工具集，旨在帮助开发者高效构建、训练和优化深度学习模型。本手册将为你提供完整的贡献代码指南和自定义模型开发教程，让你轻松参与到这个充满活力的开源项目中。

为什么选择OpenVINO Training Extensions？

OpenVINO Training Extensions提供了一个灵活且高效的框架，支持多种计算机视觉任务，包括分类、检测、分割等。通过贡献代码或自定义模型，你可以：

• 扩展框架功能，支持新的模型架构
• 优化现有算法，提升性能
• 为特定领域定制解决方案
• 与全球开发者社区共同进步

OpenVINO Training Extensions工作流程示意图，展示了从数据准备到模型部署的完整流程

环境准备

在开始贡献代码或开发自定义模型之前，需要准备好开发环境：

1. 克隆项目仓库：

   git clone https://gitcode.com/gh_mirrors/op/openvino_training_extensions
   

2. 按照官方文档安装依赖：

   cd openvino_training_extensions
   pip install -r requirements.txt
   

3. 验证安装是否成功：

   python -m otx.cli --help
   

贡献代码指南

设计变更提案流程

对于可能对产品产生全局影响或涉及重大结构变更的工作，建议遵循设计变更提案流程：

1. 准备提案：明确设计需求，并确保提案与产品使命保持一致。

   设计需求示例，明确提出功能的核心要求

2. 提交提案：将提案文档上传到Teams的"OTX2.0"频道文件库。文档应清晰说明如何满足设计需求：

   设计提案示例，展示如何满足设计需求

3. 请求审核：从Teams UI复制文档链接：

   复制文档链接以便分享给团队成员

4. 在频道中发布审核请求：

   在团队频道中提交审核请求

代码风格规范

• 遵循Google风格的文档字符串，详细说明函数功能、参数和返回值
• 使用一致的命名约定，类名使用CamelCase，函数和变量使用snake_case
• 确保代码通过所有单元测试
• 提交前进行代码格式化和静态分析

自定义模型开发教程

自定义模型基础

要开发自定义模型，需要实现以下核心组件：

1. 模型架构：继承自PyTorch的nn.Module
2. OTX模型包装器：继承自适当的OTX模型基类（如OTXMulticlassClsModel）
3. 数据处理：实现数据输入和输出的自定义逻辑

开发步骤

1. 创建模型类

首先，创建一个包含损失计算的PyTorch模型：

class ResNet50WithLossComputation(nn.Module):
    def __init__(self, num_classes: int) -> None:
        super().__init__()
        self.num_classes = num_classes
        net = resnet50(weights=ResNet50_Weights.IMAGENET1K_V2)
        net.fc = nn.Linear(net.fc.in_features, out_features=self.num_classes)
        self.net = net
        self.softmax = nn.Softmax(dim=-1)
        self.criterion = nn.CrossEntropyLoss()

    def forward(self, images: torch.Tensor, labels: torch.Tensor) -> torch.Tensor:
        logits = self.net(images)
        if self.training:
            return self.criterion(logits, labels)
        return self.softmax(logits)

2. 实现OTX模型包装器

创建继承自OTX模型基类的包装器，实现三个抽象方法：

class OTXResNet50(OTXMulticlassClsModel):
    def __init__(self, num_classes: int) -> None:
        super().__init__(num_classes=num_classes)
        # 初始化均值和标准差
        
    def _create_model(self) -> nn.Module:
        # 创建模型实例
        return ResNet50WithLossComputation(num_classes=self.num_classes)
        
    def _customize_inputs(self, inputs: MulticlassClsBatchDataEntity) -> dict[str, Any]:
        # 处理输入数据
        images = inputs.images.to(dtype=torch.float32)
        images = (images - self.mean) / self.std
        return {"images": images, "labels": torch.cat(inputs.labels, dim=0)}
        
    def _customize_outputs(self, outputs: Any, inputs: MulticlassClsBatchDataEntity) -> MulticlassClsBatchPredEntity | OTXBatchLossEntity:
        # 处理输出数据
        if self.training:
            return {"loss": outputs}
        scores = torch.unbind(outputs, 0)
        return MulticlassClsBatchPredEntity(...)

3. 使用引擎训练模型

利用OTX引擎训练自定义模型：

from otx.engine import Engine

data_dir = "tests/assets/classification_dataset"
otx_model = OTXResNet50(num_classes=2)

engine = Engine(
    data_root=data_dir,
    model=otx_model,
    device="gpu",
    work_dir="otx-workspace",
)

engine.train(max_epochs=10)

模型训练与评估

OTX提供了强大的训练引擎，支持多种优化技术和评估指标。你可以通过修改配置文件或传递参数来自定义训练过程：

OTX CLI命令示例，展示了模型训练和评估的常用命令

测试与文档

编写测试

为确保代码质量，所有新功能都应包含相应的测试：

• 单元测试：测试独立组件的功能
• 集成测试：测试组件之间的交互
• 端到端测试：测试完整的工作流程

测试代码应放在tests/目录下，遵循现有测试的结构和风格。

文档编写

良好的文档对于开源项目至关重要：

• 为新功能添加详细的文档字符串
• 更新用户手册和教程
• 在docs/目录中添加或更新相关文档

提交贡献

完成功能开发和测试后，就可以提交贡献了：

1. 创建一个新的分支，命名格式为feature/your-feature-name
2. 提交代码并推送到远程仓库
3. 创建Pull Request，描述功能内容和实现细节
4. 响应审核意见，进行必要的修改
5. 等待代码合并

结语

通过本手册，你已经了解了如何为OpenVINO Training Extensions贡献代码和开发自定义模型。无论你是想添加新功能、优化现有算法，还是为特定应用场景定制模型，这个强大的框架都能为你提供支持。

加入我们的开发者社区，一起推动计算机视觉技术的发展！如有任何问题，可以查阅官方文档或在项目仓库中提交issue。

OpenVINO Training Extensions架构图，展示了框架的核心组件和交互流程

【免费下载链接】training_extensions 项目地址: https://gitcode.com/gh_mirrors/op/openvino_training_extensions