m2cgen

m2cgen（模型转代码生成器）—— 是一个轻量级库，提供了一种简便的方法，将训练好的统计模型转换为原生代码（Python、C、Java、Go、JavaScript、Visual Basic、C#、PowerShell、R、PHP、Dart、Haskell、Ruby、F#、Rust、Elixir）。

• 安装
• 开发
• 支持的语言
• 支持的模型
• 分类输出
• 使用方法
• 命令行界面
• 常见问题解答

安装

支持的 Python 版本为 >= 3.7。

pip install m2cgen

开发

在提交 PR 之前，请确保以下命令成功运行：

make pre-pr

或者，您也可以运行 Docker 版本的相同命令：

make docker-build docker-pre-pr

支持的语言

• C
• C#
• Dart
• F#
• Go
• Haskell
• Java
• JavaScript
• PHP
• PowerShell
• Python
• R
• Ruby
• Rust
• Visual Basic（与 VBA 兼容）
• Elixir

支持的模型

	分类	回归
线性	scikit-learn LogisticRegression LogisticRegressionCV PassiveAggressiveClassifier Perceptron RidgeClassifier RidgeClassifierCV SGDClassifier lightning AdaGradClassifier CDClassifier FistaClassifier SAGAClassifier SAGClassifier SDCAClassifier SGDClassifier	scikit-learn ARDRegression BayesianRidge ElasticNet ElasticNetCV GammaRegressor HuberRegressor Lars LarsCV Lasso LassoCV LassoLars LassoLarsCV LassoLarsIC LinearRegression OrthogonalMatchingPursuit OrthogonalMatchingPursuitCV PassiveAggressiveRegressor PoissonRegressor RANSACRegressor（仅支持回归估计器作为基估计器） Ridge RidgeCV SGDRegressor TheilSenRegressor TweedieRegressor StatsModels 广义最小二乘法（GLS） 带有自回归误差的广义最小二乘法（GLSAR） 广义线性模型（GLM） 普通最小二乘法（OLS） [高斯]过程回归，采用最大似然估计法（ProcessMLE） 分位数回归（QuantReg） 加权最小二乘法（WLS） lightning AdaGradRegressor CDRegressor FistaRegressor SAGARegressor SAGRegressor SDCARegressor SGDRegressor
SVM	scikit-learn LinearSVC NuSVC OneClassSVM SVC lightning KernelSVC LinearSVC	scikit-learn LinearSVR NuSVR SVR lightning LinearSVR
树模型	DecisionTreeClassifier ExtraTreeClassifier	DecisionTreeRegressor ExtraTreeRegressor
随机森林	ExtraTreesClassifier LGBMClassifier（仅限 rf booster） RandomForestClassifier XGBRFClassifier	ExtraTreesRegressor LGBMRegressor（仅限 rf booster） RandomForestRegressor XGBRFRegressor
提升算法	LGBMClassifier（仅限 gbdt/dart/goss booster） XGBClassifier（仅限 gbtree（包括提升森林）/gblinear booster）	LGBMRegressor（仅限 gbdt/dart/goss booster） XGBRegressor（仅限 gbtree（包括提升森林）/gblinear booster）

您可以在此处找到 CI 测试保证兼容的软件包版本：requirements-test.txt。其他版本也可能受支持，但未经测试。

分类输出

线性 / 线性 SVM / 核 SVM

二分类

标量值；样本到第二类超平面的有符号距离。

多分类

向量值；样本到每个类别的超平面的有符号距离。

注释

输出与 LinearClassifierMixin.decision_function 的输出一致。

SVM

异常检测

标量值；样本到分离超平面的有符号距离：对于内点为正，对于异常点为负。

二分类

标量值；样本到第二类超平面的有符号距离。

多分类

向量值；每对类别的一对一得分，形状为 (n_samples, n_classes * (n_classes-1) / 2)。

注释

当 decision_function_shape 设置为 ovo 时，输出与 BaseSVC.decision_function 的输出一致。

树模型 / 随机森林 / 提升算法

二分类

向量值；各类别的概率。

多分类

向量值；各类别的概率。

注释

输出与 DecisionTreeClassifier / ExtraTreeClassifier / ExtraTreesClassifier / RandomForestClassifier / XGBRFClassifier / XGBClassifier / LGBMClassifier 的 predict_proba 方法的输出一致。

使用方法

以下是一个简单的示例，展示如何将用 Python 环境训练的线性模型转换为 Java 代码：

from sklearn.datasets import load_diabetes
from sklearn import linear_model
import m2cgen as m2c

X, y = load_diabetes(return_X_y=True)

estimator = linear_model.LinearRegression()
estimator.fit(X, y)

code = m2c.export_to_java(estimator)

生成的 Java 代码如下：

public class Model {
    public static double score(double[] input) {
        return ((((((((((152.1334841628965) + ((input[0]) * (-10.012197817470472))) + ((input[1]) * (-239.81908936565458))) + ((input[2]) * (519.8397867901342))) + ((input[3]) * (324.39042768937657))) + ((input[4]) * (-792.1841616283054))) + ((input[5]) * (476.74583782366153))) + ((input[6]) * (101.04457032134408))) + ((input[7]) * (177.06417623225025))) + ((input[8]) * (751.2793210873945))) + ((input[9]) * (67.62538639104406));
    }
}

您可以在 这里 找到更多不同模型和语言的生成代码示例。

命令行界面

m2cgen 可以作为命令行工具使用，通过序列化模型对象（pickle 格式）生成代码：

$ m2cgen <pickle_file> --language <language> [--indent <indent>] [--function_name <function_name>]
         [--class_name <class_name>] [--module_name <module_name>] [--package_name <package_name>]
         [--namespace <namespace>] [--recursion-limit <recursion_limit>]

请注意，反序列化序列化模型对象时，其类必须在可导入模块的顶层定义，且需位于反序列化环境中。

也支持管道输入：

$ cat <pickle_file> | m2cgen --language <language>

常见问题解答

问：生成过程中出现 RecursionError: maximum recursion depth exceeded 错误。

答：如果此错误发生在生成集成模型代码时，可以尝试减少该模型中训练的估计器数量。或者，您也可以通过 sys.setrecursionlimit(<new_depth>) 提高递归深度限制。

问：从序列化模型对象转译模型时，出现 ImportError: No module named <module_name_here> 错误。

答：此错误表明 pickle 协议无法反序列化模型对象。要成功反序列化序列化模型对象，其类必须在可导入模块的顶层定义，并且需要在反序列化环境中可用。因此，安装提供模型类定义的包通常可以解决此问题。

问：由 m2cgen 生成的代码对于某些输入与原始 Python 模型的结果存在差异。

答：一些模型在其原生 Python 库中会强制要求输入数据在预测阶段必须是特定类型。目前，m2cgen 仅支持 float64（double）数据类型。您可以尝试手动将输入数据转换为其他类型，然后再次检查结果。此外，由于目标语言中浮点数运算的具体实现方式不同，也可能导致一些细微的差异。

m2cgen 快速上手指南

m2cgen (Model 2 Code Generator) 是一个轻量级库，能够将训练好的统计模型（如 scikit-learn、Lightning、StatsModels 等）直接转换为多种编程语言的原生代码（包括 Python, C, Java, Go, JavaScript, C#, Rust 等）。这使得模型可以脱离 Python 环境，在嵌入式设备、移动端或高性能后端中直接运行。

环境准备

• 操作系统：支持 Windows, macOS, Linux。
• Python 版本：需要 Python 3.7 或更高版本。
• 前置依赖：
  • 已安装并配置好 Python 环境。
  • 已安装用于训练模型的库（如 scikit-learn, lightning, xgboost, lightgbm 等），并确保模型已完成训练。

安装步骤

推荐使用国内镜像源加速安装（以清华源为例）：

pip install m2cgen -i https://pypi.tuna.tsinghua.edu.cn/simple

或者使用官方源安装：

pip install m2cgen

基本使用

以下示例展示如何将一个 scikit-learn 的线性回归模型转换为 Java 代码。

1. 训练模型并生成代码

在 Python 环境中执行以下脚本：

from sklearn.datasets import load_diabetes
from sklearn import linear_model
import m2cgen as m2c

# 1. 加载数据并训练模型
X, y = load_diabetes(return_X_y=True)
estimator = linear_model.LinearRegression()
estimator.fit(X, y)

# 2. 将模型导出为 Java 代码
code = m2c.export_to_java(estimator)

# 3. 打印或保存生成的代码
print(code)
# 若需保存文件:
# with open("Model.java", "w") as f:
#     f.write(code)

2. 查看生成结果

运行上述脚本后，m2cgen 会输出纯 Java 代码，不包含任何外部依赖。示例如下：

public class Model {
    public static double score(double[] input) {
        return ((((((((((152.1334841628965) + ((input[0]) * (-10.012197817470472))) + ((input[1]) * (-239.81908936565458))) + ((input[2]) * (519.8397867901342))) + ((input[3]) * (324.39042768937657))) + ((input[4]) * (-792.1841616283054))) + ((input[5]) * (476.74583782366153))) + ((input[6]) * (101.04457032134408))) + ((input[7]) * (177.06417623225025))) + ((input[8]) * (751.2793210873945))) + ((input[9]) * (67.62538639104406));
    }
}

3. 支持的语言与模型

• 支持语言：C, C#, Dart, F#, Go, Haskell, Java, JavaScript, PHP, PowerShell, Python, R, Ruby, Rust, Visual Basic, Elixir。

• 常用转换函数：

  • m2c.export_to_python(model)
  • m2c.export_to_c(model)
  • m2c.export_to_go(model)
  • m2c.export_to_javascript(model)
  • (其他语言同理，遵循 export_to_<language> 命名规则)

• 支持模型：涵盖线性模型（Linear/Logistic Regression）、SVM、决策树、随机森林以及提升树（XGBoost, LightGBM 等）的分类与回归任务。