UnionML 项目教程

UnionML 项目教程

unionml UnionML: the easiest way to build and deploy machine learning microservices 项目地址: https://gitcode.com/gh_mirrors/un/unionml

1. 项目的目录结构及介绍

UnionML 项目的目录结构如下：

unionml/
├── Makefile
├── README.md
├── pyproject.toml
├── requirements-ci.txt
├── requirements-dev.txt
├── requirements-docs.txt
├── requirements.txt
├── setup.cfg
├── setup.py
├── yarn.lock
└── unionml/
    ├── __init__.py
    ├── services/
    │   ├── __init__.py
    │   ├── bentoml.py
    │   └── infer_output_io_descriptor.py
    ├── exceptions/
    │   ├── __init__.py
    │   └── ModelArtifactNotFound.py
    └── ...

目录结构介绍

• Makefile: 用于定义项目的构建和测试命令。
• README.md: 项目的介绍文档，包含项目的基本信息和使用说明。
• pyproject.toml: 定义项目的构建系统和依赖管理。
• requirements-ci.txt: 用于持续集成的依赖包列表。
• requirements-dev.txt: 用于开发环境的依赖包列表。
• requirements-docs.txt: 用于文档构建的依赖包列表。
• requirements.txt: 项目的基本依赖包列表。
• setup.cfg: 项目的配置文件，定义了安装和打包的配置。
• setup.py: 用于安装项目的脚本。
• yarn.lock: 用于前端资源管理的锁定文件。
• unionml/: 项目的主要代码目录，包含核心功能和子模块。
  • services/: 包含与服务相关的代码，如 bentoml.py 和 infer_output_io_descriptor.py。
  • exceptions/: 包含自定义异常类，如 ModelArtifactNotFound.py。

2. 项目的启动文件介绍

UnionML 项目的启动文件通常是 main.py 或 app.py，具体取决于项目的结构。以下是一个典型的启动文件示例：

# main.py
from unionml import UnionMLApp
from unionml.services import bentoml

app = UnionMLApp()

@app.reader
def reader():
    # 读取数据的逻辑
    pass

@app.trainer
def trainer():
    # 模型训练的逻辑
    pass

@app.predictor
def predictor():
    # 模型预测的逻辑
    pass

if __name__ == "__main__":
    app.run()

启动文件介绍

• UnionMLApp: 这是 UnionML 的核心类，用于定义和运行机器学习微服务。
• reader: 用于定义数据读取的逻辑。
• trainer: 用于定义模型训练的逻辑。
• predictor: 用于定义模型预测的逻辑。
• app.run(): 启动 UnionML 应用。

3. 项目的配置文件介绍

UnionML 项目的配置文件主要包括 setup.cfg 和 pyproject.toml。

setup.cfg

[metadata]
name = unionml
version = 0.1.0
description = The easiest way to build and deploy machine learning microservices
author = Union.ai
author_email = info@union.ai
url = https://github.com/unionai-oss/unionml
license = Apache-2.0

[options]
packages = find:
install_requires =
    requests
    scikit-learn
    flytekit

[options.entry_points]
console_scripts =
    unionml = unionml.cli:main

pyproject.toml

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "unionml"
version = "0.1.0"
description = "The easiest way to build and deploy machine learning microservices"
authors = [
    { name="Union.ai", email="info@union.ai" }
]
dependencies = [
    "requests",
    "scikit-learn",
    "flytekit"
]

配置文件介绍

• setup.cfg: 定义了项目的元数据、依赖包和入口点。
  • metadata: 包含项目的名称、版本、描述、作者和许可证信息。
  • options: 定义了包的查找方式和安装依赖。
  • options.entry_points: 定义了命令行工具的入口点。
• pyproject.toml: 定义了项目的构建系统和依赖管理。
  • build-system: 定义了构建系统的要求和后端。
  • project: 包含项目的名称、版本、描述、作者和依赖。

通过以上内容，您可以了解 UnionML 项目的目录结构、启动文件和配置文件的基本信息。

unionml UnionML: the easiest way to build and deploy machine learning microservices 项目地址: https://gitcode.com/gh_mirrors/un/unionml