Some modifications in the conference_details.yml for the publication in ACL anthology

crux82 commented 2 years ago

@zhzhang: for the publication in the ACL anthology, the conference_details.yml file should contain the following fields:

editors: the list of the volume editors (i.e., the Program Chairs in the main conference and the Workshop Organizers in the workshop). It should be a list of entities with name/family name/middle name as the authors of the papers.
the address of the conference: it should be a string

@mjpost: is it correct? are we missing anything?

mjpost commented 2 years ago

If you're referring to this example, I think a few details are still missing. Please see my notes here on this Wiki page for more information about what I think is missing.

crux82 commented 2 years ago

What do you think about this for a conference like ACL (that is composed of several volumes)?

name: The 60th Annual Meeting of the Association for Computational Linguistics
volume: Proceedings of the Conference, Vol. 1 (Long Papers)
abbreviation: ACL2022
start_date: 2022-05-22
end_date: 2020-05-22
isbn: XXX-X-XXXXXX-XX-X
addresse: Dublin
editors:
  - first_name: Smaranda
    last_name: Muresan
  - first_name: Preslav
    last_name: Nakov
  - first_name: Aline
    last_name: Villavicencio
publisher: Association for Computational Linguistics

The above schema is the same for all the volumes, except the field volume:

Proceedings of the Conference (Volume 1: Long Papers)
Proceedings of the Conference (Volume 2: Short Papers)
Proceedings of the Conference: Student Research Workshop
Proceedings of the Conference: System Demonstrations
Proceedings of the Conference: Tutorial Abstracts

Is it correct?

Thank you

mjpost commented 2 years ago

Hi @crux82, no this is not correct. Please see the notes here about ingestion: Register your meeting.

“Proceedings of the Conference” is too vague, and does not match volume titles from prior years. See for example the volume titles here.
“abbreviation” is wrong, it should not include the year. The field should be named “venue-id” to avoid confusion, because this is a common mistake

crux82 commented 2 years ago

Sorry @mjpost

Regarding the Volume... I thought it was the same from: https://aclanthology.org/2021.acl-long.0.pdf

Why is it wrong?

mjpost commented 2 years ago

They have put the wrong title in the document. The title is “Proceedings of the 59th Annual Meeting of the Association for Computational Linguistics and the 11th International Joint Conference on Natural Language Processing (Volume 1: Long Papers)”.

mjpost commented 2 years ago

(Best to read the titles from the metadata: https://aclanthology.org/volumes/2021.acl-long/)

crux82 commented 2 years ago

Ok, let us see if I understood. In the following examples, I duplicated some info.

The field title will be used for the metadata you require
The fields event and volume will be used for the front matter.

@ryancotterell @zhzhang @marcopoli : do you agree?

title: Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)
event: The 60th Annual Meeting of the Association for Computational Linguistics
volume: Proceedings of the Conference (Volume 1: Long Papers)
abbreviation: ACL
start_date: 2022-05-22
end_date: 2022-05-27
isbn: XXX-X-XXXXXX-XX-X
address: Dublin
editors:
  - first_name: Smaranda
    last_name: Muresan
  - first_name: Preslav
    last_name: Nakov
  - first_name: Aline
    last_name: Villavicencio
publisher: Association for Computational Linguistics

and for a workshop

title: Proceedings of the 2nd Workshop on Human Evaluation of NLP Systems (HumEval 2021)
event: The 2nd Workshop on Human Evaluation of NLP Systems
volume: Proceedings of the Workshop
abbreviation: HumEval
start_date: 2022-05-27
end_date: 2022-05-27
iisbn: XXX-X-XXXXXX-XX-X
address: Dublin
editors:
  - first_name: Belz
    last_name: Anya
  - first_name: Popović
    last_name: Maja
  - first_name: Reiter
    last_name: Ehud
  - first_name: Shimorina
    last_name: Anastasia
publisher: Association for Computational Linguistics

crux82 commented 2 years ago

@mjpost : sorry to bother you. Can you confirm the above examples?

mjpost commented 2 years ago

I still think this is confusing. To the user, what is the difference between title, event, and volume? Also, abbreviation suggests something the organizers can just pick. Is title the name of the event (e.g., The 5th annual meeting of the…) or the volume of papers published at that event (in which case it is usually “Proceedings of the 5th annual). I would suggest more explicit key names, e.g., event-name.

It would help to know what these fields are used for in other areas.

The Anthology needs these fields. I suggest these names (old → new) to help with clarity.

volume → booktitle: The title of the proceedings volume (often called the “book”)
abbreviation → anthology-venue-id: Each venue has a page under its ID, e.g., https://aclanthology.org/venues/acl. This field is also used to name the papers and create the Anthology IDs, so it needs to be correct.

Incidentally, I would also rename address to location. Historically this is supposed to be used for the publisher’s address, but people use it to record where the conference was held.

crux82 commented 2 years ago

@mjpost

Thanks!

I see your point. OK, let's try again

title: Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)
event_name: The 60th Annual Meeting of the Association for Computational Linguistics
book_title: Proceedings of the Conference (Volume 1: Long Papers)
anthology_venue_id: ACL
start_date: 2022-05-22
end_date: 2022-05-27
isbn: XXX-X-XXXXXX-XX-X
location: Dublin, Ireland
editors:
  - first_name: Smaranda
    last_name: Muresan
  - first_name: Preslav
    last_name: Nakov
  - first_name: Aline
    last_name: Villavicencio
publisher: Association for Computational Linguistics

and for a workshop

title: Proceedings of the 2nd Workshop on Human Evaluation of NLP Systems (HumEval 2021)
event_name: The 2nd Workshop on Human Evaluation of NLP Systems
book_title: Proceedings of the Workshop
anthology_venue_id: HumEval
start_date: 2022-05-27
end_date: 2022-05-27
isbn: XXX-X-XXXXXX-XX-X
location: Dublin, Ireland
editors:
  - first_name: Belz
    last_name: Anya
  - first_name: Popović
    last_name: Maja
  - first_name: Reiter
    last_name: Ehud
  - first_name: Shimorina
    last_name: Anastasia
publisher: Association for Computational Linguistics

mjpost commented 2 years ago

What is the difference between “title” and “book_title”? As a user I don’t think I understand. I think there should be just one.

Also, “Proceedings of the workshop” is not a title. That is a mistake that was in one of the PDFs. It is too generic.

I suggest you just have “event_name” and “book_title”.

See for example the <meta> block here. We only use the booktitle.

crux82 commented 2 years ago

@mjpost

I totally agree this is redundant, but the above yml file is also used to generate the frontmatter of the proceedings. From a practical perspective, I need two additional fields (two mere strings) to generate the content for these covers:

https://aclanthology.org/2021.acl-long.0.pdf https://aclanthology.org/2021.acl-short.0.pdf https://aclanthology.org/2021.acl-demo.0.pdf

or for workshops

https://aclanthology.org/2021.dialdoc-1.0.pdf https://aclanthology.org/2021.ecnlp-1.0.pdf

Or you suggest drastically changing the frontmatter, removing from the PDF The 60th Annual Meeting of the Association for Computational Linguistics and Proceedings of the Conference (Volume 1: Long Papers) and just putting Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)

I also like the idea that "less is more"

mjpost commented 2 years ago

Yes, I am suggesting you change the frontmatter to be consistent with prior years.

You should have two names: “event-name”, which is something like “60th annual meeting of the…”, and “book-title”, which is typically “Proceedings of the {event-title}” but which may vary and so should be a separate field.

The subtitle you are using, “Proceedings of the Conference” is a stylistic approach used on the covers, where the cover is something like “{event name} (vertical whitespace) Proceedings of the Conference”. But in the metadata, we use the complete book title, which is “Proceedings of the {event-name}”.

If you want the subtitle configurable, I would give it a very specific name, something like “cover-subtitle”.

crux82 commented 2 years ago

OK @mjpost . Hope this is the last time I bother you :-)

If you confirm the format of the conference volumes and (more critical) the workshop proceedings... I would like to ask @zhzhang to update the software.

book_title will be used by AclAnthology (so it can be ignored) event_name is the actual field name cover_subtitle is the actual field volume

book_title: Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)
event_name: The 60th Annual Meeting of the Association for Computational Linguistics
cover_subtitle: Proceedings of the Conference (Volume 1: Long Papers)
anthology_venue_id: ACL
start_date: 2022-05-22
end_date: 2022-05-27
isbn: XXX-X-XXXXXX-XX-X
location: Dublin, Ireland
editors:
  - first_name: Smaranda
    last_name: Muresan
  - first_name: Preslav
    last_name: Nakov
  - first_name: Aline
    last_name: Villavicencio
publisher: Association for Computational Linguistics

and for a workshop

book_title: Proceedings of the 2nd Workshop on Human Evaluation of NLP Systems (HumEval 2021)
event_name: The 2nd Workshop on Human Evaluation of NLP Systems
cover_subtitle: Proceedings of the Workshop
anthology_venue_id: HumEval
start_date: 2022-05-27
end_date: 2022-05-27
isbn: XXX-X-XXXXXX-XX-X
location: Dublin, Ireland
editors:
  - first_name: Belz
    last_name: Anya
  - first_name: Popović
    last_name: Maja
  - first_name: Reiter
    last_name: Ehud
  - first_name: Shimorina
    last_name: Anastasia
publisher: Association for Computational Linguistics

mjpost commented 2 years ago

Please don’t worry about bothering me! This is hard work and you’re in the thick of it. Thanks for including me in the discussion; I hope it eases things down the line.

What you proposed looks great. I think the field names are clear. If there is documentation, I would be happy to help augment it.

crux82 commented 2 years ago

@mjpost We have a draft of the guide (especially for Workshop organizers) that we are closing with Elena. @ElenaCabrio can you add Matt to the actual repository? I would also ask you to update the guide with the above format and communicate it to the organizers that already started using aclpub2

rycolab / aclpub2

Some modifications in the conference_details.yml for the publication in ACL anthology #33