NL-Augmenter 🦎 → 🐍

NL-Augmenter是一项旨在为处理自然语言的数据集添加转换的协作努力。这些转换以多种方式增强文本数据集，包括：随机化名称和数字、改变风格/语法、改写、基于知识库的改写...以及您贡献的任何创新增强方法。我们邀请您通过GitHub拉取请求向该框架提交转换。

<b>论文已被NEJLT 2023接受，点击此处查看。</b>

框架组织者可通过nl-augmenter@googlegroups.com联系。

Colab笔记本
安装
如何创建转换？
如何创建过滤器？
动机
接受提交的审核标准
一些转换创意

Colab笔记本

<a href="https://colab.research.google.com/github/GEM-benchmark/NL-Augmenter/blob/main/notebooks/Write_a_sample_transformation.ipynb" target="_parent"><img src="https://yellow-cdn.veclightyear.com/ab5030c0/d0d4e168-48ea-4054-bd9a-2a2531eb65d2.svg" alt="在Colab中打开"/></a> 要快速查看转换和过滤器的实际效果，请运行我们的colab笔记本。

一些转换创意

如果您需要灵感来实现转换，请查看https://github.com/GEM-benchmark/NL-Augmenter/issues/75，其中讨论了一些想法和先前的论文。到目前为止，贡献主要集中在形态变化、字符级变化和随机噪声上。最佳的新拉取请求将与这些现有贡献不同。

安装

要求

Python 3.7

说明

# 创建新转换时，将此替换为您的分叉仓库（见下文）
git clone https://github.com/GEM-benchmark/NL-Augmenter.git
cd NL-Augmenter
python setup.py sdist
pip install -e .
pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-3.0.0/en_core_web_sm-3.0.0.tar.gz

如何创建转换？

设置

首先，在GitHub上分叉仓库！:fork_and_knife: <a href="https://docs.github.com/en/github/getting-started-with-github/fork-a-repo">

您的分叉将有自己的位置，我们将其称为PATH_TO_YOUR_FORK。接下来，克隆分叉的仓库并为您的转换创建一个分支，这里我们将其称为my_awesome_transformation：

git clone $PATH_TO_YOUR_FORK
cd NL-Augmenter
git checkout -b my_awesome_transformation

我们将基于现有示例创建我们的转换。通过复制现有转换来创建新的转换目录。您可以根据要创建的转换任务从其他转换目录中选择复制。首先查看一些现有的拉取请求和已合并的转换，以避免重复工作或创建与之前太相似的转换。

cd nlaugmenter/transformations/
cp -r butter_fingers_perturbation my_awesome_transformation
cd my_awesome_transformation

创建转换

在文件transformation.py中，将类ButterFingersPerturbation重命名为MyAwesomeTransformation，并从interfaces/文件夹中选择一个接口。查看这里的完整选项列表。
现在在实现generate方法时发挥您所有的创造力。如果您打算使用外部库，请将它们及其版本号添加到requirements.txt中。
更新my_awesome_transformation/README.md以描述您的转换。

测试和评估（可选）

完成后，在文件test.json中至少添加5个示例对作为测试用例，这样就不会有人无意中破坏您的代码。

转换准备就绪后，对其进行测试：

pytest -s --t=my_awesome_transformation

如果您想评估您的转换对常见的🤗HuggingFace模型的影响，我们建议您查看评估

代码风格 为了标准化代码，我们使用black代码格式化工具，它将在提交前运行。要使用预提交钩子，请使用pip install pre-commit安装pre-commit（如果您按照上述说明操作，应该已经安装）。然后运行pre-commit install以安装钩子。在未来的提交中，您应该看到black代码格式化工具会在所有已暂存提交的Python文件上运行。

提交

一旦测试通过且您对转换结果满意，请提交审核。

首先，提交并推送您的更改：

git add transformations/my_awesome_transformation/*
git commit -m "Added my_awesome_transformation"
git push --set-upstream origin my_awesome_transformation

最后，提交一个拉取请求。最后的git push命令会打印出一个URL，可以将其复制到浏览器中以发起拉取请求。或者，您也可以从GitHub网站上进行操作。 <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request">

:sparkles: 恭喜，您已经向NL-Augmenter提交了一个转换！:sparkles:

如何创建过滤器？

我们也接受创建过滤器的拉取请求，这些过滤器用于识别数据集中有趣的子集。添加新过滤器的过程与上述过程相同。所有过滤器实现都需要实现.filter而不是.generate，并且需要放置在filters文件夹中。就像转换可以转换文本示例一样，过滤器可以识别示例是否遵循某种文本模式！唯一的区别是，转换返回相同输入格式的另一个示例，而过滤器只返回True或False！有关逐步说明，请按照这些步骤操作。

BIG-Bench :chair:

如果您对NL-Augmenter感兴趣，您可能也会对BIG-bench大规模协作语言模型基准测试感兴趣。

最具创意的实现 🏆

在所有拉取请求合并后，将选出3个最具创意的实现，并在此README页面和NL-Augmenter网页上展示。

论文

@misc{dhole2021nlaugmenter,
  title={NL-Augmenter: A Framework for Task-Sensitive Natural Language Augmentation},
  author={Kaustubh D. Dhole and Varun Gangal and Sebastian Gehrmann and Aadesh Gupta and Zhenhao Li and Saad Mahamood and Abinaya Mahendiran and Simon Mille and Ashish Srivastava and Samson Tan and Tongshuang Wu and Jascha Sohl-Dickstein and Jinho D. Choi and Eduard Hovy and Ondrej Dusek and Sebastian Ruder and Sajant Anand and Nagender Aneja and Rabin Banjade and Lisa Barthe and Hanna Behnke and Ian Berlot-Attwell and Connor Boyle and Caroline Brun and Marco Antonio Sobrevilla Cabezudo and Samuel Cahyawijaya and Emile Chapuis and Wanxiang Che and Mukund Choudhary and Christian Clauss and Pierre Colombo and Filip Cornell and Gautier Dagan and Mayukh Das and Tanay Dixit and Thomas Dopierre and Paul-Alexis Dray and Suchitra Dubey and Tatiana Ekeinhor and Marco Di Giovanni and Rishabh Gupta and Rishabh Gupta and Louanes Hamla and Sang Han and Fabrice Harel-Canada and Antoine Honore and Ishan Jindal and Przemyslaw K. Joniak and Denis Kleyko and Venelin Kovatchev and Kalpesh Krishna and Ashutosh Kumar and Stefan Langer and Seungjae Ryan Lee and Corey James Levinson and Hualou Liang and Kaizhao Liang and Zhexiong Liu and Andrey Lukyanenko and Vukosi Marivate and Gerard de Melo and Simon Meoni and Maxime Meyer and Afnan Mir and Nafise Sadat Moosavi and Niklas Muennighoff and Timothy Sum Hon Mun and Kenton Murray and Marcin Namysl and Maria Obedkova and Priti Oli and Nivranshu Pasricha and Jan Pfister and Richard Plant and Vinay Prabhu and Vasile Pais and Libo Qin and Shahab Raji and Pawan Kumar Rajpoot and Vikas Raunak and Roy Rinberg and Nicolas Roberts and Juan Diego Rodriguez and Claude Roux and Vasconcellos P. H. S. and Ananya B. Sai and Robin M. Schmidt and Thomas Scialom and Tshephisho Sefara and Saqib N. Shamsi and Xudong Shen and Haoyue Shi and Yiwen Shi and Anna Shvets and Nick Siegel and Damien Sileo and Jamie Simon and Chandan Singh and Roman Sitelew and Priyank Soni and Taylor Sorensen and William Soto and Aman Srivastava and KV Aditya Srivatsa and Tony Sun and Mukund Varma T and A Tabassum and Fiona Anting Tan and Ryan Teehan and Mo Tiwari and Marie Tolkiehn and Athena Wang and Zijian Wang and Gloria Wang and Zijie J. Wang and Fuxuan Wei and Bryan Wilie and Genta Indra Winata and Xinyi Wu and Witold Wydmański and Tianbao Xie and Usama Yaseen and M. Yee and Jing Zhang and Yue Zhang},
  journal={Northern European Journal of Language Technology},
  volume={9},
  number={1},
  year={2023}
}