opyrator

3.1k 166 简单 3 次阅读 1周前MIT插件开发框架

AI 解读由 AI 自动生成，仅供参考

Opyrator 能让你快速将普通的 Python 函数变成具备 Web API 和交互式网页界面的微服务，无需手动编写后端或前端代码。它特别适合数据科学家、机器学习工程师和 Python 开发者，帮助他们轻松把模型或算法封装成可部署、可共享的服务，省去繁琐的工程化步骤。只需定义好输入输出的数据结构（使用 Pydantic 模型），Opyrator 就会自动生成基于 FastAPI 的 RESTful API 和基于 Streamlit 的可视化界面，并支持一键打包为可执行文件或 Docker 镜像。整个过程基于 OpenAPI、JSON Schema 和 Python 类型提示等开放标准，既规范又易用。目前 Opyrator 仍处于 Alpha 阶段，推荐用于实验性项目或快速原型开发。

使用场景

某电商公司的数据科学团队开发了一个商品评论情感分析模型，需要快速将其提供给产品和客服团队试用，并为后续集成到内部系统做准备。

没有 opyrator 时

团队需手动编写 FastAPI 应用代码来暴露 HTTP 接口，处理请求解析、错误响应和文档生成，耗时且易出错。
为了让非技术同事试用，还需额外开发一个简易 Web 界面，通常依赖 Flask 或 Streamlit，增加维护成本。
每次模型逻辑更新后，前后端代码都要同步调整，沟通和测试成本高。
部署时需单独配置 Dockerfile 和依赖环境，流程繁琐，难以快速分享给其他团队。
缺乏标准化输入输出结构，容易因参数格式不一致导致调用失败。

使用 opyrator 后

只需将原有预测函数按 Pydantic 模型定义输入输出，一行命令即可自动生成带 OpenAPI 文档的 Web API。
通过 opyrator launch-ui 自动启动交互式 Web 界面，产品和客服人员可直接在浏览器中输入评论并查看情感结果。
模型逻辑与服务层完全解耦，算法工程师只需专注核心函数，无需关心接口或前端实现。
支持一键导出为可执行文件或 Docker 镜像，方便跨团队分发和部署到测试环境。
基于类型提示和 JSON Schema 自动生成校验逻辑，确保输入输出规范统一，减少集成错误。

opyrator 将原本数天的工程化工作压缩到几分钟，让数据科学家能真正“写完即用、改完即测”。

运行环境要求

操作系统

Linux
macOS
Windows

GPU

未说明

内存

未说明

依赖

notes工具处于 Alpha 版本，仅建议用于实验用途。函数需使用 Pydantic 模型定义输入和输出，并通过类型提示指定。部分示例可能有额外依赖，需安装对应 requirements.txt 中的包。

python3.6+

fastapi

streamlit

pydantic

快速开始

Opyrator

将你的 Python 函数快速转换为具备 Web API、交互式 GUI 等功能的微服务。

入门指南 • 功能特性 • 示例 • 支持 • 报告 Bug • 贡献 • 更新日志

将你的 Python 函数瞬间转变为生产就绪（production-ready）的微服务。通过 HTTP API 或交互式 UI 部署并访问你的服务。无缝导出服务为可移植、可共享、可执行的文件或 Docker 镜像。Opyrator 基于开放标准构建——OpenAPI、JSON Schema 和 Python 类型提示（type hints），并由 FastAPI、Streamlit 和 Pydantic 提供支持。它消除了将 Python 代码产品化和共享过程中的所有繁琐工作——只要你能将功能封装成一个 Python 函数即可。

^{Alpha 版本：仅建议用于实验性用途。}

在我们的在线 playground 中尝试并探索各种示例。

亮点功能

🪄 几秒钟内将函数转变为生产就绪的服务。
🔌 基于 FastAPI 自动生成 HTTP API。
🌅 基于 Streamlit 自动生成 Web UI。
📦 保存并分享为自包含的可执行文件或 Docker 镜像。
🧩 复用预定义组件，并与现有 Opyrator 组合使用。
📈 即刻部署并扩展以用于生产环境。

入门指南

安装

要求：Python 3.6+.

pip install opyrator

使用方法

一个简单的 Opyrator 兼容函数可能如下所示：

from pydantic import BaseModel

class Input(BaseModel):
    message: str

class Output(BaseModel):
    message: str

def hello_world(input: Input) -> Output:
    """返回输入数据中的 `message` 字段。"""
    return Output(message=input.message)

💡 Opyrator 兼容函数必须具有一个 input 参数，并且其返回值需基于 Pydantic 模型。输入和输出模型通过类型提示（type hints）指定。

将此代码复制到一个文件中，例如 my_opyrator.py
从命令行启动 UI 服务器：
```
opyrator launch-ui my_opyrator:hello_world
```
输出中会有一行显示你的 Web 应用在本地机器上的服务地址。
从命令行启动 HTTP API 服务器：
```
opyrator launch-api my_opyrator:hello_world
```
输出中会有一行显示你的 Web 服务在本地机器上的服务地址。
更多用法信息请参阅功能特性部分，或从我们的示例中获取灵感。

示例

👉 在我们的在线 playground 中尝试并探索这些示例

以下示例集合展示了 Opyrator 如何支持各种不同的任务和使用场景。所有这些示例都打包在一个演示 playground 中，你也可以通过 Docker 在自己的机器上部署：

docker run -p 8080:8080 mltooling/opyrator-playground:latest

文本生成

在本地运行此演示（点击展开...）

要在本地机器上运行该演示，只需执行以下命令：

git clone https://github.com/ml-tooling/opyrator
cd ./opyrator/examples/generate_text/
pip install -r requirements.txt
opyrator launch-ui app:generate_text --port 8051

在浏览器中访问 http://localhost:8051 即可使用该演示的 UI。若要启动 HTTP API 服务器，请将 launch-ui 替换为 launch-api。

问答系统（Question Answering）