Update README.md

README.md

@@ -1,38 +1,179 @@
----
-license: cc-by-nc-sa-4.0
-dataset_info:
-- config_name: clean
-  features:
-  - name: author
-    dtype: string
-  - name: title
-    dtype: string
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 69171271
-    num_examples: 100
-  download_size: 41547114
-  dataset_size: 69171271
-- config_name: raw
-  features:
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 71154713
-    num_examples: 100
-  download_size: 43843958
-  dataset_size: 71154713
-configs:
-- config_name: clean
-  data_files:
-  - split: train
-    path: clean/train-*
-- config_name: raw
-  data_files:
-  - split: train
-    path: raw/train-*
-  default: true
----
+---
+license: cc-by-nc-sa-4.0
+dataset_info:
+- config_name: clean
+  features:
+  - name: author
+    dtype: string
+  - name: title
+    dtype: string
+  - name: text
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 69171271
+    num_examples: 100
+  download_size: 41547114
+  dataset_size: 69171271
+- config_name: raw
+  features:
+  - name: text
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 71154713
+    num_examples: 100
+  download_size: 43843958
+  dataset_size: 71154713
+configs:
+- config_name: clean
+  data_files:
+  - split: train
+    path: clean/train-*
+- config_name: raw
+  data_files:
+  - split: train
+    path: raw/train-*
+  default: true
+---
+
+
+<div align="center">
+
+![Gacha Logo](./assets/gacha_logo.png)
+
+# Gacha: Gutenberg Corpus for Evaluating Chunking Algorithms
+</div>
+
+
+Gacha is a corpus of 100 texts from Project Gutenberg, collected for the purpose of evaluating chunking algorithms.
+
+It's heavily inspired by the work of [LumberChunker](https://arxiv.org/abs/2406.17526).
+
+<details> <!-- markdownlint-disable-line MD033 -->
+<summary>Books in the Corpus</summary> <!-- markdownlint-disable-line MD033 -->
+
+The corpus contains 100 english texts from Project Gutenberg.
+
+| Author | Year | Title |
+|--------|------|-------|
+| Mark Twain | 2004 | The Adventures of Huckleberry Finn |
+| Lewis Carroll | 2008 | Alice's Adventures in Wonderland |
+| L. Tolstoy | 2010 | Anna Karenina |
+| L. M. Montgomery | 2021 | Anne of Green Gables |
+| Jules Verne | 1994 | Around the World in Eighty Days |
+| Charles Dickens | 2006 | A Christmas Carol |
+| Mark Twain | 2004 | A Connecticut Yankee in King Arthur's Court |
+| W. H. Hudson | 2005 | A Crystal Age |
+| Walter Scott | 2006 | A Legend of Montrose |
+| James Joyce | 2003 | A Portrait of the Artist as a Young Man |
+| E. M. Forster | 2001 | A Room with a View |
+| Arthur Conan Doyle | 1995 | A Study in Scarlet |
+| Charles Dickens | 1994 | A Tale of Two Cities |
+| F. W. Nietzsche | 2003 | Beyond Good and Evil |
+| Joseph Sheridan Le Fanu | 2003 | Carmilla |
+| E. C. Gaskell | 2018 | Cranford |
+| Fyodor Dostoyevsky | 2006 | Crime and Punishment |
+| H. R. Garis | 2005 | Daddy Takes Us to the Garden |
+| Charles Dickens | 1996 | David Copperfield |
+| Bram Stoker | 1995 | Dracula |
+| James Joyce | 2003 | Dubliners |
+| Jane Austen | 1994 | Emma |
+| M. W. Shelly | 2012 | Frankenstein |
+| Charles Dickens | 1998 | Great Expectations |
+| Grimm Brothers | 2004 | Grimm's Fairy Stories |
+| Jonathan Swift | 1997 | Gulliver's Travels |
+| Joseph Conrad | 2006 | Heart of Darkness |
+| H. A. Jacobs | 2004 | Incidents in the Life of a Slave Girl |
+| Charlotte Bronte | 1998 | Jane Eyre |
+| Victor Hugo | 2008 | Les Miserables |
+| L. M. Alcott | 1996 | Little Women |
+| Alexandre Dumas | 1995 | Louise de la Vallière |
+| Gustave Flaubert | 2006 | Madame Bovary |
+| Marcus Aurelius | 2017 | Meditations |
+| George Eliot | 1994 | Middlemarch |
+| Herman Melville | 1991 | Moby Dick |
+| Richard Wagner | 2004 | My Life - Volume 1 |
+| Richard Wagner | 2004 | My Life - Volume 2 |
+| Frederick Douglass | 2006 | Narrative of the Life of Frederick Douglass |
+| Charles Dickens | 1996 | Oliver Twist |
+| Jane Austen | 1994 | Persuasion |
+| J. M. Barrie | 2008 | Peter Pan |
+| Jane Austen | 1994 | Pride and Prejudice |
+| Max Brand | 2006 | Riders of the Silences |
+| John Locke | 2005 | Second Treatise of Government |
+| Jane Austen | 1994 | Sense and Sensibility |
+| Alexandre Dumas | 2001 | Ten Years Later |
+| T. Smollett | 2004 | The Adventures of Ferdinand Count Fathom |
+| T. Smollett | 2004 | The Adventures of Roderick Random |
+| Arthur C. Doyle | 1999 | The Adventures of Sherlock Holmes |
+| Mark Twain | 2004 | The Adventures of Tom Sawyer |
+| Alexadre Dumas | 1997 | The Black Tulip |
+| Arthur Quiller-Couch | 2006 | The Blue Pavilions |
+| Fyodor Dostoyevsky | 2006 | The Brothers Karamazov |
+| Jack London | 2008 | The Call of the Wild |
+| St. Augustine | 2002 | The Confessions of St. Augustine |
+| Alexandre Dumas | 1998 | The Count of Monte Cristo |
+| Elizabeth Von Arnim | 2003 | The Enchanted April |
+| Maurice Leblanc | 2004 | The Extraordinary Adventures of Arsène Lupin, Gentleman-Burglar |
+| Fyodor Dostoyevsky | 2000 | The Gambler |
+| F. S. Fitzgerald | 2004 | The Great Gatsby |
+| Arthur C. Doyle | 2002 | The Hound of the Baskervilles |
+| Robert W. Chambers | 2005 | The King in Yellow |
+| Daniel Defoe | 1996 | The Life and Adventures of Robinson Crusoe |
+| Alexandre Dumas | 1995 | The Man in the Iron Mask |
+| Agatha Christie | 2022 | The Murder of Roger Ackroyd |
+| Agatha Christie | 2019 | The Murder of the Links|
+| Homer | 1999 | The Odyssey |
+| Oscar Wilde | 1994 | The Picture of Dorian Gray |
+| Niccolo Machiavelli | 2006 | The Prince |
+| Mark Twain | 2004 | The Prince and the Pauper |
+| Bertrand Russell | 2004 | The Problems of Philosophy |
+| Khalil Gibran | 2002 | The Prophet |
+| Jose Rizal | 2004 | The Reign of Greed |
+| Plato | 1998 | The Republic |
+| Anonymous | 2009 | The Romance of Lust |
+| Nathaniel Hawthorne | 2004 | The Scarlet Letter |
+| Arthur C. Doyle | 2000 | The Sign of Four |
+| W. E. B. Du Bois | 1996 | The Souls of Black Folk |
+| R. L. Stevenson | 2008 | The Strange Case of Dr. Jekyll and Mr. Hyde |
+| Ernest Hemingway | 2022 | The Sun Also Rises |
+| Alexandre Dumas | 1998 | The Three Musketeers |
+| H. G. Wells | 2004 | The Time Machine |
+| Franz Kafka | 2005 | The Trial |
+| Henry James | 1995 | The Turn of the Screw |
+| Alexandre Dumas | 2001 | The Vicomte de Bragelonne |
+| H. G. Wells | 2004 | The War of the Worlds |
+| L. F. Baum | 1993 | The Wonderful Wizard of Oz |
+| F. W. Nietzsche | 2003 | Thus Spoke Zarathustra |
+| R. L. Stevenson | 2006 | Treasure Island |
+| Jules Verne | 1994 | Twenty Thousand Leagues under the Sea |
+| Alexandre Dumas | 1998 | Twenty Years After |
+| James Joyce | 2003 | Ulysses | 
+| H. B. Stowe | 2006 | Uncle Tom's Cabin |
+| H. D. Thoreau | 1995 | Walden and On The Duty of Civil Disobedience |
+| Leo Tolstoy | 2001 | War and Peace |
+| Max Brand | 2006 | Way of the Lawless | 
+| Fyodor Dostoyevsky | 2011 | White Nights and Other Stories |
+| A. A. Milne | 2022 | Winnie-the-Pooh |
+| Emily Bronte | 1996 | Wuthering Heights | 
+
+</details>
+
+## Citation
+
+This corpus is heavily inspired by the work of [LumberChunker](https://arxiv.org/abs/2406.17526). If you use this corpus, please cite the following paper:
+
+```bibtex
+@misc{duarte2024lumberchunker,
+      title={LumberChunker: Long-Form Narrative Document Segmentation}, 
+      author={André V. Duarte and João Marques and Miguel Graça and Miguel Freire and Lei Li and Arlindo L. Oliveira},
+      year={2024},
+      eprint={2406.17526},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2406.17526}, 
+}
+```
+
+