collections.paper¶
Paper ¶
A paper entry.
Required Attributes:
| Name | Type | Description |
|---|---|---|
id |
str
|
The ID of this paper (e.g. "1" or "42"). |
parent |
Volume
|
The Volume object that this paper belongs to. |
bibkey |
str
|
Bibliography key, e.g. for BibTeX. Must be unique across all papers in the Anthology. |
title |
MarkupText
|
The title of the paper. |
List Attributes:
| Name | Type | Description |
|---|---|---|
attachments |
dict[str, AttachmentReference]
|
File attachments of this paper. The dictionary key specifies the type of attachment (e.g., "software"). |
authors |
list[NameSpecification]
|
Names of authors associated with this paper; can be empty. |
awards |
list[str]
|
Names of awards this has paper has received; can be empty. |
editors |
list[NameSpecification]
|
Names of editors associated with this paper; can be empty. |
errata |
list[PaperErratum]
|
Errata for this paper; can be empty. |
revisions |
list[PaperRevision]
|
Revisions for this paper; can be empty. |
videos |
list[VideoReference]
|
Zero or more references to video recordings belonging to this paper. |
Optional Attributes:
| Name | Type | Description |
|---|---|---|
abstract |
Optional[MarkupText]
|
The full abstract. |
deletion |
Optional[PaperDeletionNotice]
|
A notice of the paper's retraction or removal, if applicable. |
doi |
Optional[str]
|
The DOI for the paper. |
ingest_date |
Optional[str]
|
The date of ingestion. |
language |
Optional[str]
|
The language this paper is (mainly) written in. When given, this should be a ISO 639-2 code (e.g. "eng"), though occasionally IETF is used (e.g. "pt-BR"). |
note |
Optional[str]
|
A note attached to this paper. Used very sparingly. |
pages |
Optional[str]
|
Page numbers of this paper within its volume. |
paperswithcode |
Optional[PapersWithCodeReference]
|
Links to code implementations and datasets as provided by Papers with Code. |
pdf |
Optional[PDFReference]
|
A reference to the paper's PDF. |
address
property
¶
address
The publisher's address for this paper. Inherited from the parent Volume.
full_id
property
¶
full_id
The full anthology ID of this paper (e.g. "L06-1042" or "2022.emnlp-main.1").
full_id_tuple
property
¶
full_id_tuple
The full anthology ID of this paper, as a tuple (e.g. ("L06", "1", "42")).
is_deleted
property
¶
is_deleted
Returns True if this paper was retracted or removed from the Anthology.
is_frontmatter
property
¶
is_frontmatter
Returns True if this paper represents a volume's frontmatter.
venue_ids
property
¶
venue_ids
List of venue IDs associated with this paper. Inherited from the parent Volume.
from_frontmatter_xml
classmethod
¶
from_frontmatter_xml(parent, paper)
Instantiates a new paper from a <frontmatter> block in the XML.
from_xml
classmethod
¶
from_xml(parent, paper)
Instantiates a new paper from its <paper> block in the XML.
This function can also be called with a <frontmatter> block, in which case it will just defer to self.from_frontmatter_xml.
get_editors ¶
get_editors()
Returns:
| Type | Description |
|---|---|
list[NameSpecification]
|
|
get_events ¶
get_events()
get_ingest_date ¶
get_ingest_date()
Returns:
| Type | Description |
|---|---|
date
|
The date when this paper was added to the Anthology. Inherits from its parent volume. If not set, will return constants.UNKNOWN_INGEST_DATE instead. |
to_bibtex ¶
to_bibtex(with_abstract=False)
PaperDeletionNotice ¶
A notice about a paper's deletion (i.e., retraction or removal) from the Anthology.
from_xml
classmethod
¶
from_xml(element)
Instantiates a deletion notice from its <removed> or <retracted> block in the XML.
PaperDeletionType ¶
Bases: Enum
Type of deletion of a paper.
REMOVED
class-attribute
instance-attribute
¶
REMOVED = 'removed'
Paper was removed. A removal occurs in rare circumstances where serious ethical or legal issues arise, such as plagiarism.
RETRACTED
class-attribute
instance-attribute
¶
RETRACTED = 'retracted'
Paper was retracted. A retraction occurs when serious, unrecoverable errors are discovered, which drastically affect the findings of the original work.