README_zh.md

AdaSeq: An All-in-One Library for Developing State-of-the-Art Sequence Understanding Models

English | 简体中文

简介

AdaSeq (Alibaba Damo Academy Sequence Understanding Toolkit) 是一个基于ModelScope的一站式序列理解开源工具箱，旨在提高开发者和研究者们的开发和创新效率，助力前沿论文工作落地。

🌟 特性：

• 算法丰富：

  AdaSeq提供了序列理解任务相关的大量前沿模型、训练方法和上下游工具。

• 性能强劲：

  我们旨在开发性能最好的模型，在序列理解任务上胜出过其他开源框架。

• 简单易用：

  只需一行命令，即可进行训练。

• 扩展性强：

  用户可以自由注册模块组件，并通过组合不同的模块组件，便捷地构建自定义的检测模型。

⚠️注意： 这个项目仍在高速开发阶段，部分接口可能会发生改变。

📢 最新进展

• 2022-03: [SemEval 2023] 我们的U-RaNER模型赢得了SemEval 2023多语言复杂实体识别比赛 9个赛道的冠军！源代码将会很快开源！
• 2022-12: [EMNLP 2022] 实现检索增强多模态实体理解MoRE模型
• 2022-11: [EMNLP 2022] 实现超细粒度实体分类NPCRF模型
• 2022-11: [EMNLP 2022] 无监督边界感知预训练模型模型BABERT释出，实验复现

⚡ 快速体验

可以在ModelScope上快速体验我们的模型： [英文NER] [中文NER] [中文分词]

更多的任务、更多的语种、更多的领域：见全部已发布的模型卡片 Modelcards

🛠️ 模型库

支持的模型：

• Transformer-based CRF
• Partial CRF
• Retrieval Augmented NER
• Biaffine NER
• Global-Pointer
• Multi-label Entity Typing
• ...

💾 数据集

我们整理了很多序列理解相关任务的数据集：Datasets

📦 安装AdaSeq

AdaSeq项目基于 Python version >= 3.7 和 PyTorch version >= 1.8.

• pip安装：

pip install adaseq

• 源码安装：

git clone https://github.com/modelscope/adaseq.git
cd adaseq
pip install -r requirements.txt -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html

验证安装

为了验证AdaSeq是否安装成功，我们提供了一个demo配置文件用于训练模型（该文件需联网环境自动下载）。

adaseq train -c demo.yaml

运行过程中，你会看到不断刷新的训练日志；运行结束后，测试集评测结果将会被显示 test: {"precision": xxx, "recall": xxx, "f1": xxx}，同时在当前目录下，会生成experiments/toy_msra/，记录所有实验结果和保存的模型。

📖 教程文档

• 快速开始
• 基础教程
  • 了解配置文件
  • 自定义数据集
  • [TODO] 常用架构和模块化设计
• 最佳实践
  • 在自定义数据上训练模型
  • 超参数优化
  • 训练加速
  • 模型推理
  • 模型发布到 ModelScope
  • 复现论文实验结果
  • [TODO] 实现自定义模型
  • [TODO] 使用AdaLA进行推理
• FAQ

👫 开源社区

钉钉扫一扫，加入官方技术交流群。欢迎各位业界同好一起交流技术心得。

AdaSeq序列理解技术交流群

📝 贡献指南

我们感谢所有为了改进AdaSeq而做的贡献，也欢迎社区用户积极参与到本项目中来。请参考 CONTRIBUTING.md 来了解参与项目贡献的相关指引。

📄 开源许可证

本项目采用 Apache 2.0 License 开源许可证.