Upload README.md with huggingface_hub

README.md

@@ -79,23 +79,72 @@ license: cc-by-sa-4.0
   <img src="assets/bookcoref.png" width="700">
 </div>
 <!-- Aggiungi nome degli autori, ACL 2025, link  -->
-This repository contains the <span style="font-variant: small-caps;">BookCoref</span> dataset, introduced in the paper "<span style="font-variant: small-caps;">BookCoref</span>: Coreference Resolution at Book Scale" by [Martinelli et al., 2025]().
-
+This data repository contains the <span style="font-variant: small-caps;">BookCoref</span> dataset, introduced in the paper "<span style="font-variant: small-caps;">BookCoref</span>: Coreference Resolution at Book Scale" by <a href="https://arxiv.org/"> Martinelli et al. (2025)</a>, presented at the <a href="https://2025.aclweb.org/">ACL 2025</a> conference.
 
 We release both the manually-annotated `test` split (<span style="font-variant: small-caps;">BookCoref</span><sub>gold</sub>) and the pipeline-generated `train` and `validation` splits (<span style="font-variant: small-caps;">BookCoref</span><sub>silver</sub>).
-In order to enable the replication of our results, we also release the splitted version of each split, available by adding the suffix `_splitted` to each split name.
-As specified in the paper, this version is obtained through chunking the text into contiguous windows of 1500 tokens, retaining the coreference clusters of each window.
+In order to enable the replication of our results, we also release the splitted version of each split as a separate configuration.
+<!-- As specified in the paper, this version is obtained through chunking the text into contiguous windows of 1500 tokens, retaining the coreference clusters of each window. -->
+
+## ⚠️ Project Gutenberg license disclaimer
+
+<span style="font-variant: small-caps;">BookCoref</span> is based on books from Project Gutenberg, which are publicly available under the [Project Gutenberg License](https://www.gutenberg.org/policy/license.html).
+This license holds for users located in the United States, where the books are in the public domain.
+
+We do not distribute the original text of the books, rather our dataset consists of a script that downloads and preprocesses the books from an archived verion of Project Gutenberg through the [Wayback Machine](https://web.archive.org/).
+Users are responsible for checking the copyright status of each book in their country.
 
 ## 📚 Quickstart
 
-Simply load the dataset through Huggingface's `datasets` library:
+To use the <span style="font-variant: small-caps;">BookCoref</span> dataset, you need to install the following Python packages in your environment:
+
+```bash
+pip install "datasets<=3.6.0" deepdiff spacy nltk
+```
+
+You can then load each configuration through Huggingface's `datasets` library:
 
 ```python
 from datasets import load_dataset
 
 bookcoref = load_dataset("sapienzanlp/bookcoref")
+bookcoref_splitted = load_dataset("sapienzanlp/bookcoref", name="splitted")
 ```
 
+These commands will download and preprocess the books, add the coreference annotations, and return a `DatasetDict` according to the requested configuration.
+```python
+>>> bookcoref
+DatasetDict({
+    train: Dataset({
+        features: ['doc_key', 'gutenberg_key', 'sentences', 'clusters', 'characters'],
+        num_rows: 45
+    })
+    validation: Dataset({
+        features: ['doc_key', 'gutenberg_key', 'sentences', 'clusters', 'characters'],
+        num_rows: 5
+    })
+    test: Dataset({
+        features: ['doc_key', 'gutenberg_key', 'sentences', 'clusters', 'characters'],
+        num_rows: 3
+    })
+})
+>>> bookcoref_splitted
+DatasetDict({
+    train: Dataset({
+        features: ['doc_key', 'gutenberg_key', 'sentences', 'clusters', 'characters'],
+        num_rows: 7544
+    })
+    validation: Dataset({
+        features: ['doc_key', 'gutenberg_key', 'sentences', 'clusters', 'characters'],
+        num_rows: 398
+    })
+    test: Dataset({
+        features: ['doc_key', 'gutenberg_key', 'sentences', 'clusters', 'characters'],
+        num_rows: 152
+    })
+})
+``` 
+
+
 ## ℹ️ Data format
 
 <span style="font-variant: small-caps;">BookCoref</span> is a collection of annotated books. 
@@ -103,23 +152,25 @@ Each item contains the annotations of one book following the structure of OntoNo
 
 ```python
 {
-  doc_id: "pride_and_prejudice_142", # (str) i.e., id of document 
-  sentences: [["Pride", "and", "Prejudice", "."], ["Begin", ...], ...], # list[list[str]] i.e., list of word-tokenized sentences
-  clusters: [[[0,0], [3,5]], [[4,9]...], ...], # list[list[list[int]]] i.e., list of clusters' mention offsets
+  doc_id: "pride_and_prejudice_1342", # (str) i.e., ID of the document 
+  gutenberg_key: "1342", # (str) i.e., key of the book in Project Gutenberg
+  sentences: [["CHAPTER", "I."], ["It", "is", "a", "truth", "universally", "acknowledged", ...], ...], # list[list[str]] i.e., list of word-tokenized sentences
+  clusters: [[[79,80], [81,82], ...], [[2727,2728]...], ...], # list[list[list[int]]] i.e., list of clusters' mention offsets
   characters: [
     {
-      name: "Mr.Bennet", 
-      cluster: [[0,0], ...],
+      name: "Mr Bennet", 
+      cluster: [[79,80], ...],
     },
     {
       name: "Mr. Darcy",
-      cluster: [[5,7], ...],
+      cluster: [[2727,2728], [2729,2730], ...],
     }
-  ] # list[character], list of characters objects with name and his mentions offsets, i,e., dict(name: str, cluster: list[list[int]])
+  ] # list[character], list of characters objects consisting of name and mentions offsets, i,e., dict[name: str, cluster: list[list[int]]]
 }
 ```
 <!-- Add description of fields in example, maybe OntoNotes format is not enough -->
-We also include information on character names, which is not exploited in traditional coreference settings, but can be useful in future works.
+We also include character names, which are not exploited in traditional coreference settings but could inspire future directions in Coreference Resolution.
+
 
 ## 📊 Dataset statistics
 
@@ -130,6 +181,7 @@ We also include information on character names, which is not exploited in tradit
   <img src="https://cdn-uploads.huggingface.co/production/uploads/64f85270ceabf1e6fc524bb8/DgYU_2yKlZuwDTV-duGWh.png" width=1000/>
 </div>
 
+
 ## 🖋️ Cite this work
 
 This work has been published at ACL 2025 (main conference). If you use any artifact of this dataset, please consider citing our paper as follows:
@@ -152,4 +204,5 @@ This work has been published at ACL 2025 (main conference). If you use any artif
 
 ## ©️ License information
 
-All the annotations provided by this repository are licensed under the [Creative Commons Attribution Share Alike 4.0](https://creativecommons.org/licenses/by-nc/4.0/) license. The tokenized text of books is a modification of books from Project Gutenberg, following [their license](https://www.gutenberg.org/policy/license.html).
+All the annotations provided by this repository are licensed under the [Creative Commons Attribution Share Alike 4.0](https://creativecommons.org/licenses/by-nc/4.0/) license. 
+<!-- The tokenized text of books is a modification of books from Project Gutenberg, following [their license](https://www.gutenberg.org/policy/license.html). -->