Skip to content

softconf2aclpub: read author ORCIDs from .orc side files#215

Open
mjpost wants to merge 1 commit into
mainfrom
orcid-side-files
Open

softconf2aclpub: read author ORCIDs from .orc side files#215
mjpost wants to merge 1 commit into
mainfrom
orcid-side-files

Conversation

@mjpost

@mjpost mjpost commented Jun 28, 2026

Copy link
Copy Markdown
Collaborator

What

When converting from ACLPUB format, softconf2aclpub.py now reads the
ACLPUB .orc ORCID side files and attaches each author's ORCID to the
generated papers.yml.

This mirrors the .orc side-loading the ACL Anthology does in
bin/ingest.py.
Converting from ACLPUB format isn't necessary (the Anthology can ingest
ACLPUB directly), but some people do it anyway, and previously the
converted papers.yml dropped author ORCIDs.

.orc format

ACLPUB writes one .orc file next to each paper's .bib, with one entry
per author (1-based index, matching the paper's author order):

Author{1}{Orcid}:0000-0002-9659-1532
Author{2}{Orcid}:
Author{3}{Orcid}:0000-0001-2345-6789

Behavior

  • ORCIDs are attached to authors by 1-based index; entries with an empty
    value are skipped.
  • The value lands in the lowercase orcid author field (the same field
    the program-committee export and downstream ingestion already use).
  • Side files are looked up per paper (by Submission ID) under, in order:
    cdrom/bib/, bib/, attachments/, and ..
  • Fully backwards compatible: a no-op when no .orc file is present, so
    existing scrape-only workflows are unaffected.

Note for reviewers

The side-file lookup directories / key (Submission ID) are a best-effort
default; happy to adjust the search path or matching key to whatever
location your build places the .orc files in.

When converting from ACLPUB format, read the sibling .orc side file for
each paper and attach ORCIDs to authors by 1-based index, mirroring the
.orc side-loading in the ACL Anthology's bin/ingest.py. ORCIDs land in
the lowercase 'orcid' author field expected downstream. No-op when no
.orc file is present, so existing workflows are unaffected.
@crux82

crux82 commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Thanks, this looks useful and the no-op behavior when no .orc file is present seems safe.

Before approving, I’d like to clarify two things:

  1. Is orcid already the canonical author field used by the OpenReview conversion path as well, or would this make Softconf behave differently from OpenReview?

  2. Is the expected .orc side-file location/name documented anywhere? The code searches cdrom/bib/, bib/, attachments/, and . using the Submission ID. If this is not already documented, could we add a short note to the README or the softconf/ documentation?

The code itself looks reasonable to me, but I think the expected input layout should be documented so users know how to make use of it.

@mjpost

mjpost commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator Author
  1. orcid is the openreview author field already used by aclpub2. This brings the Softconf/ACLPUB conversion into line with that practice.
  2. The .orc side file is just Rich Gerber adding that for us. I'll add a note about documentation and push it up, soon.

@mjpost

mjpost commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator Author

Actually, looking at this code in more detail, it doesn't work the way I expected. I assumed that the conversion happened offline after downloading full, completed proceedings from ACLPUB, but that does not appear to be the case.

@crux82

crux82 commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Thanks, that makes sense. I’m wondering whether we should avoid making .orc side files part of the normal aclpub2 workflow, though.

For aclpub2, it seems cleaner to have papers.yml be the single canonical source of paper metadata, including author ORCIDs via the existing authors[].orcid field. The .orc files sound like a legacy ACLPUB/Anthology side-file mechanism. If we support them directly in softconf2aclpub.py, we may end up with two parallel sources of truth that can diverge.

Would it make more sense to treat .orc files only as an import/conversion aid, i.e. merge their contents into papers.yml, and then have the rest of aclpub2 rely only on papers.yml? If the .orc files are not normally present when softconf2aclpub.py runs, perhaps this should be a separate explicit conversion step rather than part of the default Softconf conversion path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants