PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.2.0

PyPI

aclpubcheck

# ACL pubcheck ACL pubcheck is a Python tool that automatically detects font errors, author formatting errors, margin violations, outdated citations as well as many other common formatting errors in papers that are using the LaTeX sty file associated with ACL venues. The script can be used to check your papers before you submit to a conference. (We highly recommend running ACL pubcheck on your papers *pre-submission*—a well formatted paper helps keep the reviewers focused on the scientific content.) However, its main purpose is to ensure your accepted paper is properly formatted, i.e., it follows the venue's style guidelines. The script is used by the publication chairs at most ACL eve

Published10 Oct 2022
Direct dependencies9
Transitive dependenciesNot calculated

README

Version 0.2.0 documentation

ACL pubcheck

ACL pubcheck is a Python tool that automatically detects font errors, author formatting errors, margin violations, outdated citations as well as many other common formatting errors in papers that are using the LaTeX sty file associated with ACL venues. The script can be used to check your papers before you submit to a conference. (We highly recommend running ACL pubcheck on your papers pre-submission—a well formatted paper helps keep the reviewers focused on the scientific content.) However, its main purpose is to ensure your accepted paper is properly formatted, i.e., it follows the venue's style guidelines. The script is used by the publication chairs at most ACL events to check for formatting issues. Indeed, running this script yourself and fixing errors before uploading the camera-ready version of your paper will often save you a personalized email from the publication chairs.

You can install the package by cloning the repo

  1. git clone git@github.com:acl-org/aclpubcheck.git or git clone https://github.com/acl-org/aclpubcheck.git
  2. cd aclpubcheck
  3. pip install -e .

You can run the script on a paper as follows python3 aclpubcheck/formatchecker.py --paper_type PAPER_TYPE PAPER_NAME.pdf where PAPER_TYPE is taken from the set {long,short,other}. You should choose either long or short depending on the type of paper you have accepted.

If you find that ACL pubcheck gives you a margin error due to a figure that runs into the margin, you can often fix the problem by applying the adjustbox package. Additionally, if the margin error is caused by an equation, then it may help to break the equation over two lines.

Note: Additional info can be found in the PDF document aclpubcheck_additional_info.pdf included in this package.

Online Version: If you are having trouble with installing and using the Python toolkit directly, you can use a CodaLab version online https://colab.research.google.com/drive/1Sq6ilmrFUQpUFMkV71U8-Wf0madW-Uer?usp=sharing.

Updating the names in citations

Description

Our toolkit now automatically checks your citations and will leave a warning if you have used incorrect names or author list. Please have a look here on why it is important to use updated citations.

Demo version of PDF name checking is available here.

How it's done

The bibilography from your PDF file is extracted using Scholarcy API. Each bib entry in this bib file is updated by pulling information from ACL anthology, DBLP and arXiv; by using fuzzy match of the titles. After updating the bibs, the author names are compared and mismatches in author names are warned.

Procedure

Functionality

The functions are present in aclpubcheck/name_check.py. The class PDFNameCheck is used in formatchecker.py.

Caveats

Some of the warnings generated for citations may be spurious and inaccurate, due to parsing and indexing errors. We encourage you to double check the citations and update them depending on the latest source. If you believe that your citation is updated and correct, then please ignore those warnings. You can fix your bib files using the toolkit like rebiber.

Screenshots

This is how the warnings appear for the outdated names. You would be directed to a URL where you can correct the citations. We are not showing the name changes as it might out the deadnames in the warnings.

Screenshot

Development

  • Install conda/miniconda/mamba
  • Install Python Poetry
  • Run conda create -n acl python=3.9
  • Run poetry install

Publishing

  • Run poetry build then poetry publish

Credits

The original version of ACL pubcheck was written by Yichao Zhou, Iz Beltagy, Steven Bethard, Ryan Cotterell and Tanmoy Chakraborty in their role as publications chairs of NAACL 2021. The tool was improved by Ryan Cotterell and Danilo Croce in their role as publication chairs of ACL 2022 and NAACL 2022. Pranav A added the name checking functions to this toolkit.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 9

Native requirements
9 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
Unidecode
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
Unidecode (>=1.3.6,<2.0.0)runtime
pandas
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
pandas (>=1.5.0,<2.0.0)runtime
pdfplumber
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
pdfplumber (>=0.7.5,<0.8.0)runtime
pybtex
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
pybtex (>=0.24.0,<0.25.0)runtime
pylatexenc
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
pylatexenc (>=2.10,<3.0)runtime
rebiber
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
rebiber (>=1.1.3,<2.0.0)runtime
termcolor
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
termcolor (>=2.0.1,<3.0.0)runtime
tqdm
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
tqdm (>=4.64.1,<5.0.0)runtime
tsv
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8,<4.0",
  "evaluation": "NOT_EVALUATED"
}
tsv (>=1.2,<2.0)runtime

Distribution files

2 collected
aclpubcheck-0.2.0-py3-none-any.whl

bdist_wheel · 17.51 KB · Python py3

Source file
aclpubcheck-0.2.0.tar.gz

sdist · 17.54 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 18:16 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:608a9956fd1eea876ca4797910b32e31fe09dd32c24a2a5259b5b84bd149eff8

Other collected versions

View all collected versions →