面向用户的系统,用于无痛管理、存储、共享、组织和部署机器学习模型。
Maisie的Python项目详细描述
Maisie (stable) | |
Maisie (development) | |
Maisie Sphinx Theme | |
Documentation | |
PyPI | |
DockerHub |
1 Features
存档、存储、管理和组织机器学习模型是否能够高效地完成,并将重点放在用户体验上?当然,梅西就是这么做的。
梅西是一个友好、易于使用的助手,包括:
- 用react编写的web应用程序
- 用python、flask编写的后端api
- 用python编写并托管在pypi上的客户端应用程序/包
它与您喜爱的工具无缝集成,并为您提供所有重要数据,如:
- 所有经过培训的模型的git修订版,以及有关源分支的信息
- 可搜索、可筛选的超参数、参数和度量
- 单个标识数据集名称,以及可选的描述
- 永久URL,便于共享和下载存储模型
2 Installing
您可以从PyPI
$ pip install Maisie
在您的培训环境中使用它相当简单:
importmaisiefromsklearn.externalsimportjoblib# Define your model heremodel.fit(X,y)model_filename="example_model.pkl"joblib.dump(model,model_filename)# Define your metrics, fetch parameters and hyperparametersmodels=maisie.Models()models.upload(name="My first uploaded model",filename=model_filename,dataset_name="Singly Identifying Dataset Name",metrics={"accuracy":accuracy},hyperparameters=hyperparameters,parameters=parameters,)
3 Deploying
3.1 Using docker-compose
此存储库提供一个预先配置的docker-compose.yml文件,其中包含合理的默认选项。
在启动容器之前,应该使用包含的.env.sample创建一个本地.env文件。
要启动所有服务,请运行:
$ docker-compose up
要停止服务,可以按ctrl+c/ctrl+d。如果使用docker-compose up -d在后台启动服务,正确的方法是:
$ docker-compose stop
你可以通过clicking here了解更多关于docker compose的信息。
3.2 Fetching individual images
一旦新的稳定版本可用,前端和后端图像都将自动发布到Docker Hub。
链接
作为参考,您可以查看使用本地配置的.env文件将所有容器部署到指定主机的sample Ansible playbook。
4 Contributing
4.1 Getting started
- 从develop分支克隆存储库
$ git clone -b develop git@github.com:nokia-wroclaw/innovativeproject-ml-models-management.git
- 安装pre-commit
- 在项目的根目录中安装所有必需的githooks:
$ pre-commit install
- 要启动本地开发所需的所有服务,请运行:
$ docker-compose up
- 你们都准备好了!
4.2 Fixing existing issues
- 从open issues或create a new one中选择一个
- 创建名为issue-[number]-[short description]的新分支,该分支派生自develop分支,例如
$ git checkout -b issue-42-project-removal-permissions develop
- 确保您的实现修复了实际问题并经过了良好的测试。
4.3 Implementing new features
在实现新功能时,应该首先创建一个名为feature-[short description]的新分支,该分支派生自develop分支,例如
$ git checkout -b feature-new-user-profile develop
4.4 Commiting the changes
要运行所有测试并检查是否满足所有必需的预提交GitHook,请运行
$ pre-commit run --all-files
您的提交消息应该用简单的英语(如果可能)简要总结更改。要了解如何编写正确的提交消息,请查看this article。
准备好后,创建一个新的pull请求,与设置为基分支的develop分支进行比较。
5 Documentation
对于最新的稳定版本,可以在docs.maisie.dev上看到文档。