3 Star 12 Fork 1

MindSpore Lab / mindformers

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

欢迎来到MindSpore MindFormers

介绍

MindSpore MindFormers套件的目标是构建一个大模型训练、推理、部署的全流程开发套件: 提供业内主流的Transformer类预训练模型和SOTA下游任务应用,涵盖丰富的并行特性。 期望帮助用户轻松的实现大模型训练和创新研发。

MindSpore MindFormers套件基于MindSpore内置的并行技术和组件化设计,具备如下特点:

  • 一行代码实现从单卡到大规模集群训练的无缝切换。
  • 提供灵活易用的个性化并行配置。
  • 能够自动进行拓扑感知,高效地融合数据并行和模型并行策略。
  • 一键启动任意任务的训练、评估、推理流程。
  • 支持用户进行组件化配置任意模块,如优化器、学习策略、网络组装等。
  • 提供Trainer、ModelClass、ConfigClass、pipeline等高阶易用性接口。

如果您对MindSpore MindFormers有任何建议,请通过Gitee或MindSpore与我们联系,我们将及时处理。

目前支持的模型列表如下:

  • BERT
  • GPT
  • OPT
  • T5
  • MAE
  • SimMIM
  • CLIP
  • FILIP
  • Vit
  • Swin

安装

目前仅支持源码编译安装,用户可以执行下述的命令进行包的安装

git clone https://gitee.com/mindspore/mindformers.git
cd mindformers
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
sh build.sh

版本匹配关系

版本对应关系 Mindformer MindSpore
版本号 0.2.0 1.8.1

快速使用

目前该库提供两种方式供用户使用,套件详细设计请阅:MindFormers套件设计

方式一:clone 工程代码

用户可以直接clone整个仓库,按照以下步骤即可运行套件中已支持的任意configs模型任务配置文件,方便用户快速进行使用和开发

  • 准备工作

    • step1:git clone mindformers
    git clone https://gitee.com/mindspore/mindformers.git
    cd mindformers
    • step2: 准备相应任务的数据集,请参考configs目录下各模型的README.md文档准备相应数据集

    • step3:修改配置文件configs/{model_name}/task_config/{model_name}_dataset.yaml中数据集路径

    • step4:如果要使用分布式训练,则需提前生成RANK_TABLE_FILE

    # 不包含8本身,生成0~7卡的hccl json文件
    python mindformers/tools/hccl_tools --device_num [0,8]
  • 常用参数说明

RANK_TABLE_FILE: 由mindformers/tools/hccl_tools.py生成的分布式json文件
CONFIG_PATH: 为configs文件夹下面的{model_name}/run_*.yaml配置文件
DEVICE_ID: 为设备卡,范围为0~7
DEVICE_RANGE: 为单机分布式卡的范围, 如[0,8]为8卡分布式,不包含8本身
RUN_STATUS: 为任务运行状态,支持关键字 train、eval、predict
  • 快速使用方式 1:统一接口启动,根据模型 CONFIG 完成任意模型的单卡训练、评估、推理流程
# 训练启动,run_status支持train、eval、predict三个关键字,以分别完成模型训练、评估、推理功能,默认使用配置文件中的run_status
python run_mindformer.py --config {CONFIG_PATH} --run_status {train/eval/predict}
  • 快速使用方式 2: scripts 脚本启动,根据模型 CONFIG 完成任意模型的单卡/多卡训练、评估、推理流程
# 单卡启动脚本
cd scripts
sh run_standalone.sh CONFIG_PATH DEVICE_ID RUN_STATUS

# 多卡启动脚本
# 8卡分布式运行, DEVICE_RANGE = [0, 8], 不包含8本身
cd scripts
sh run_distribute.sh RANK_TABLE_FILE CONFIG_PATH DEVICE_RANGE RUN_STATUS

方式二:pip 安装使用

用户可以通过pip install mindformers的方式利用Trainer高阶接口执行模型任务的训练、评估、推理功能。

Trainer接口详细设计请阅:Trainer接口使用案例及接口设计说明

  • 准备工作

    • step1: 安装mindformers包
    pip install mindformers
    • step2: 准备相应任务的数据集,请参考configs目录下各模型的README.md文档准备相应数据集
  • 小白体验使用方式:准备数据集,直接开启已有任务的训练、评估、推理流程

from mindformers import Trainer
from mindformers.common.context import init_context
from mindformers.trainer.config_args import ContextConfig

## Step 1 MindSpore 环境初始化
context_config = ContextConfig(device_id=0, device_target='Ascend', mode=0)  # 支持MindSpore context的环境配置
init_context(seed=2022, use_parallel=False, context_config=context_config)  # 进行环境初始化, 单卡设定

## Step 2 输入对应任务的标准数据集路径,自动创建已有任务的训练、评估、推理流程 (需提前准备好对应的数据集)
mim_trainer = Trainer(task_name='masked_image_modeling', # 已集成的任务名
                      model='mae_vit_base_p16', # 已集成的模型名
                      train_dataset="/data/imageNet-1k/train", # 传入标准的训练数据集路径,默认支持ImageNet数据集格式
                      eval_dataset="/data/imageNet-1k/eval") # 传入标准的评估数据集路径,默认支持ImageNet数据集格式
mim_trainer.train() # 开启训练流程
# mim_trainer.eval() # 开启评估流程
# mim_trainer.predict(input_data) # 输入要执行推理的数据,开启推理流程
  • 初阶开发使用方式: 通过config类配置参数完成已有任务的训练、评估、推理流程
from mindformers.trainer import Trainer
from mindformers.common.context import init_context
from mindformers.trainer.config_args import ConfigArguments, \
    OptimizerConfig, DatasetConfig, DataLoaderConfig, RunnerConfig, \
    ContextConfig, LRConfig

## Step 1 MindSpore 环境初始化
context_config = ContextConfig(device_id=1, device_target='Ascend', mode=0)  # 支持MindSpore context的环境配置
init_context(seed=2022, use_parallel=False, context_config=context_config)  # 进行环境初始化, 单卡设定

## Step 2 通过支持的Config类设定支持的超参数
runner_config = RunnerConfig(epochs=10, batch_size=2, image_size=224)  # 自定义运行超参
lr_schedule_config = LRConfig(lr_type='WarmUpLR', learning_rate=0.001, warmup_steps=10)  # 自定义学习策略
optim_config = OptimizerConfig(optim_type='Adam', beta1=0.009, learning_rate=lr_schedule_config) # 自定义优化器策略
train_loader_config = DataLoaderConfig(dataset_dir="/data/imageNet-1k/train")   # 数据加载参数设定, 默认ImageFolderDataset加载方式
eval_loader_config = DataLoaderConfig(dataset_dir="/data/imageNet-1k/eval")
train_dataset_config = DatasetConfig(data_loader=train_loader_config,
                               input_columns=["image"],
                               output_columns=["image"],
                               column_order=["image"],
                               batch_size=2,
                               image_size=224) # 设定训练数据集的输入、输出、bs等超参数
eval_dataset_config = DatasetConfig(data_loader=eval_loader_config,
                                    input_columns=["image"],
                                    output_columns=["image"],
                                    column_order=["image"],
                                    batch_size=2,
                                    image_size=224) # 设定评估数据集的输入、输出、bs等超参数

config = ConfigArguments(output_dir="./output_dir",
                         runner_config=runner_config,
                         train_dataset=train_dataset_config,
                         eval_dataset=eval_dataset_config,
                         optimizer=optim_config) # 统一超参配置接口

## Step 3 通过config配置拉起相应任务的训练、评估、推理功能
mim_trainer = Trainer(task_name='masked_image_modeling', model='mae_vit_base_p16', config=config)
mim_trainer.train() # 开启训练流程
# mim_trainer.eval() # 开启评估流程
# mim_trainer.predict(input_data) # 输入要执行推理的数据,开启推理流程
  • 中阶开发使用方式: 用户通过自定义开发的网络、数据集、优化器等模块完成已有任务的训练、评估、推理流程
import numpy as np

from mindspore.nn import AdamWeightDecay, WarmUpLR
from mindspore.train.callback import LossMonitor, TimeMonitor,\
    CheckpointConfig, ModelCheckpoint
from mindspore.dataset import GeneratorDataset

from mindformers.trainer import Trainer
from mindformers.models import MaeModel
from mindformers.common.context import init_context
from mindformers.trainer.config_args import ConfigArguments, \
    RunnerConfig, ContextConfig


class MyDataLoader:
    """Self-Define DataLoader."""
    def __init__(self):
        self._data = [np.zeros((3, 224, 224), np.float32) for _ in range(64)]

    def __getitem__(self, index):
        return self._data[index]

    def __len__(self):
        return len(self._data)

## Step 1 MindSpore 环境初始化
context_config = ContextConfig(device_id=1, device_target='Ascend', mode=0)
init_context(seed=2022, use_parallel=False, context_config=context_config)

#  Step 2 运行超参配置定义
runner_config = RunnerConfig(epochs=10, batch_size=8, image_size=224, sink_mode=True, per_epoch_size=10)
config = ConfigArguments(output_dir="./output_dir", seed=2022, runner_config=runner_config)

#  Step 3 自定义网络实例
mae_model = MaeModel()

#  Step 4 自定义数据集加载及预处理流程
dataset = GeneratorDataset(source=MyDataLoader(), column_names='image')
dataset = dataset.batch(batch_size=8)

# Step 5 自定义学习策略和优化器
lr_schedule = WarmUpLR(learning_rate=0.001, warmup_steps=100)
optimizer = AdamWeightDecay(beta1=0.009, beta2=0.999,
                            learning_rate=lr_schedule,
                            params=mae_model.trainable_params())

# Step 6 自定义callback函数
loss_cb = LossMonitor(per_print_times=2)
time_cb = TimeMonitor()
ckpt_config = CheckpointConfig(save_checkpoint_steps=10, integrated_save=True)
ckpt_cb = ModelCheckpoint(directory="./output/checkpoint", prefix="my_model", config=ckpt_config)
callbacks = [loss_cb, time_cb, ckpt_cb]

# 通过自定义任意模块完成masked_image_modeling任务的训练、评估、推理流程
mim_trainer = Trainer(task_name='masked_image_modeling',
                      model=mae_model,  # 包含loss计算
                      config=config,
                      optimizers=optimizer,
                      train_dataset=dataset,
                      eval_dataset=dataset,
                      callbacks=callbacks)
mim_trainer.train() # 开启训练流程
# mim_trainer.eval() # 开启评估流程
# mim_trainer.predict(input_data) # 输入要执行推理的数据,开启推理流程
  • 高阶使用方式:高阶类混合使用和组装.....

使用指南

目前提供下述的文档

Benchmark

在此查看每个模型的复现性能基准。

FAQ

  1. 如何迁移HuggingFace权重 ?

请查看如何转换HuggingFace的权重

贡献

欢迎参与社区贡献,详情参考Contributor Wiki

许可证

Apache 2.0许可证

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

MindSpore MindFormers套件的目标是构建一个大模型训练、推理、部署的全流程开发套件 展开 收起
Python 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/mindspore-lab/mindformers.git
git@gitee.com:mindspore-lab/mindformers.git
mindspore-lab
mindformers
mindformers
master

搜索帮助