我有一个保存的情感分析模型,还有相关的代码和数据。我试图创建一个包含这些代码功能并使用此训练模型的库。我不明白如何将模型和依赖于它的功能整合进去。
有谁能具体指导我如何做吗?
编辑:我选择了使用pickle的方法(见下面的回答)
回答:
如果你想正确维护这样一个库,你需要了解三件事:
- 如何构建一个包
- 如何版本化一个包
- 如何分发一个包
有几种方法可以做到这一点,目前最用户友好的可能是poetry
,所以我将用它作为例子。如果你想用这篇文章作为教程,你需要安装它。
为了有一个非常基本的项目框架来工作,我假设你有类似这样的东西:
modelpersister├───modelpersister│ ├───model.pkl│ ├───__init__.py│ ├───model_definition.py│ ├───train.py│ └───analyze.py└───pyproject.toml
model.pkl
:你将与包一起发布的模型文件__init__.py
:空的,需要存在以使这个文件夹成为一个Python模块model_definition.py
:包含定义你模型的类和功能train.py
:接受数据来训练你的模型,并用结果覆盖当前的model.pkl
文件,大致如下:
import picklefrom pathlib import Pathfrom modelpersister.model_definition import SentimentAnalyzer# 给定新数据覆盖当前模型def train(data): model = SentimentAnalyzer.train(data) with open(Path(__file__).parent / "model.pkl") as model_file: pickle.dump(model, model_file)
analyze.py
:接受数据点以根据当前的model.pkl
进行分析,大致如下:
import pickleimport importlib.resourcesfrom modelpersister.model_definition import MyModel# 作为包资源加载当前模型(小但重要的细节)with importlib.resources.path("modelpersister", "model.pkl") as model_file: model: MyModel = pickle.load(model_file)# 在此文件中提供有意义的分析def estimate(data_point): return model.estimate(data_point)
pyproject.toml
:poetry需要的元数据文件,以便打包此代码,大致如下:
[tool.poetry]name = "modelpersister"version = "0.1.0"description = "发布一个情感分析模型。"authors = ["Mishaal <[email protected]>"]license = "MIT" # 就许可证而言,这是一个不错的默认选择[tool.poetry.dependencies]python = "^3.8"sklearn = "^0.23" # 或者你用于模型定义的任何ML库[tool.poetry.dev-dependencies][build-system]requires = ["poetry>=0.12"]build-backend = "poetry.masonry.api"
假设所有这些文件都填充了有意义的代码,并且希望使用比modelpersister
更好的项目名称,你的工作流程大致如下:
- 在
model_definition.py
中更新你的功能,用train.py
在更好的数据上训练你的模型,或者在analysis.py
中添加新功能,直到你觉得你的模型现在明显比以前更好 - 运行
poetry version minor
来更新包版本 - 运行
poetry build
来构建你的代码和模型,生成源代码分发和wheel文件,你可以根据需要进行一些最终测试 - 运行
poetry publish
来分发你的包 – 默认情况下发布到全球Python包索引,但你也可以设置一个私有的PyPI实例,并告诉poetry
使用它,或者手动上传到其他地方