ACL pubcheck
ACL pubcheck 是一个 Python 工具,可以自动检测使用与 ACL 会议相关的 LaTeX 样式文件的论文中的字体错误、作者格式错误、页边距违规、过时引用以及许多其他常见的格式错误。在提交会议论文之前,可以使用该脚本检查您的论文。(我们强烈建议在提交前对您的论文运行 ACL pubcheck—格式良好的论文有助于审稿人专注于科学内容。)然而,它的主要目的是确保您的已接受论文格式正确,即遵循会议的样式指南。该脚本被大多数 ACL 活动的出版主席用来检查格式问题。实际上,在上传论文终稿版本之前自行运行此脚本并修复错误,通常可以避免收到出版主席的个人邮件。
安装
使用 ACL pubcheck 最简单的方法是通过 pip 直接从 GitHub 仓库安装(不同于 pypi):
pip3 install git+https://github.com/acl-org/aclpubcheck
或者,您可以直接从源代码安装并在本地构建:
# 使用 ssh 克隆
git clone git@github.com:acl-org/aclpubcheck.git
# 或使用 http
git clone https://github.com/acl-org/aclpubcheck.git
cd aclpubcheck/
# 本地安装
pip install -e .
使用方法
安装完成后,您可以将其应用于 PDF 文件:
# 脚本执行
aclpubcheck --paper_type PAPER_TYPE path/to/paper.pdf
# 模块执行(如果脚本执行不起作用)
python3 -m aclpubcheck --paper_type PAPER_TYPE path/to/paper.pdf
将 PAPER_TYPE
替换为 (1) long
,(2) short
,(3) demo
之一,具体取决于您接受的论文类型。然后,将 path/to/paper.pdf
更改为您论文的路径。例如:
# -p 是 --paper_type 的简写
python3 -m aclpubcheck --p long example/2023.acl-tutorials.1.pdf
如果您发现 ACL pubcheck 由于图片超出页边距而给出页边距错误,您通常可以通过应用 adjustbox 包 来解决这个问题。此外,如果页边距错误是由方程引起的,那么将方程分成两行可能会有所帮助。
ACL pubcheck 旨在用于论文的终稿版本,而不是审稿版本(例如匿名、带行号的提交版本)。在带行号的版本上运行 ACL pubcheck 会导致一系列与页边距中的数字相关的虚假错误。
注意:更多信息可以在本包中包含的 PDF 文档 aclpubcheck_additional_info.pdf
中找到。
在线版本
如果您在直接安装和使用 Python 工具包时遇到困难,您可以使用:
- 一个Colab 版本,您可以直接上传并运行 aclpubcheck,无需本地安装(感谢 Danilo Croce)。
- 一个 Hugging Face Space,地址为 https://huggingface.co/spaces/teelinsan/aclpubcheck(感谢 Andrea Santilli)。关于这个版本的更多信息可以在 https://github.com/teelinsan/aclpubcheck-gui 找到。
更新引用中的名字
描述
我们的工具包现在会自动检查您的引用,如果您使用了不正确的名字或作者列表,会留下警告。请查看这里了解为什么使用更新后的引用很重要。
PDF 名字检查的演示版本可在这里获得。
实现方式
使用 Scholarcy API 从您的 PDF 文件中提取参考文献。通过从 ACL anthology、DBLP 和 arXiv 获取信息,使用标题的模糊匹配来更新这个参考文献文件中的每个条目。更新参考文献后,比较作者姓名,并对作者姓名的不匹配发出警告。
功能
这些功能存在于 aclpubcheck/name_check.py
中。PDFNameCheck
类在 formatchecker.py
中使用。
注意事项
由于解析和索引错误,为引用生成的一些警告可能是虚假和不准确的。我们鼓励您仔细检查引用并根据最新来源进行更新。如果您认为您的引用是最新和正确的,请忽略这些警告。您可以使用像 rebiber 这样的工具包来修复您的参考文献文件。
截图
这是过时名字的警告出现的方式。您会被引导到一个 URL,在那里可以更正引用。我们不显示名字变更,因为警告中可能会暴露旧名。
致谢
ACL pubcheck 的原始版本由 Yichao Zhou、Iz Beltagy、Steven Bethard、Ryan Cotterell 和 Tanmoy Chakraborty 在担任 NAACL 2021 出版主席时编写。该工具由 Ryan Cotterell 和 Danilo Croce 在担任 ACL 2022 和 NAACL 2022 出版主席时进行了改进。Pranav A 为该工具包添加了名字检查功能。
维护
该工具主要由 Ryan Cotterell 和 Danilo Croce 维护。欢迎更多志愿者参与!