Update README.md

README.md

@@ -14,136 +14,96 @@ size_categories:
 
 # Fiction 1B
 
-More than 1B words of narrative fiction sourced from Project Gutenberg, AO3, and Internet Archive
+More than 1B words of narrative fiction sourced from [Project Gutenberg](https://www.gutenberg.org/), [AO3](https://archiveofourown.org/), and [Internet Archive](https://archive.org/).
 
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
+This contains the text of roughly 20,000 works of narrative fiction from the above sources.
+From the original full texts, a [genre classifier](https://huggingface.co/classla/xlm-roberta-base-multilingual-text-genre-classifier) was applied at the paragraph level to remove license text, metadata, and other content suspected not to be narrative prose.
 
+#### Misc
 
+- **Curated by:** Shawn Rushefsky - [🤗](https://huggingface.co/shawnrushefsky) | [github](https://github.com/shawnrushefsky)
+- **Funded by:** [Salad Technologies](https://salad.com)
+- **Language(s) (NLP):** English
+- **License:** MIT
 
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
+### Dataset Sources
 
-### Dataset Sources [optional]
+More information about specific source documents can be found in `doc_index.csv`
 
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- Project Gutenberg: 76.4%
+- Archive of our Own (AO3): 22.2%
+- Internet Archive: 1.4%
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
+The dataset is intended to be used for training language models on the syntactic patterns of narrative fiction.
 
 ### Direct Use
 
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
+- Fill-Mask training
+- Text Generation training
+- Research
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+- Applications outside of fiction
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
+`data.zip` contains a CSV file where each row contains the source, a document ID, paragraph index, approximately 500 words of text, and a word count for that section.
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
+While much of this content is already present in extremely large web-scaped datasets, there is a scarcity of more approachable medium-sized datasets that focus specifically on narrative fiction.
+Datasets such as [FineWeb](https://huggingface.co/datasets/HuggingFaceFW/fineweb) with trillions of tokens are not practical for the average developer to work with.
 
 ### Source Data
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
 #### Data Collection and Processing
 
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+**Project Gutenberg**
 
-[More Information Needed]
-
-#### Who are the source data producers?
+Project Gutenberg hosts a [catalog CSV](https://www.gutenberg.org/cache/epub/feeds/pg_catalog.csv) that includes metadata such as title, author, and subjects.
+I filtered based on the presence of fiction-related keywords in the Subjects column, and used a python script to bulk download texts.
 
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+```python
+fiction_keywords = [
+    'fiction', 'novel', 'stories', 'tale', 'adventure',
+    'mystery', 'romance', 'fantasy', 'horror', 'detective',
+    'science fiction', 'historical fiction', 'western',
+    'thriller', 'suspense'
+]
+```
 
-[More Information Needed]
+**AO3**
 
-### Annotations [optional]
+For AO3, I used the [ao3-api](https://pypi.org/project/ao3-api/) python package to gradually paginate through the archive, filtering to English language work with at least 15,000 words but fewer than 500,000, sorted by “Kudos”, a measure of user favor.
 
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+**Internet Archive**
 
-#### Annotation process
+For Internet Archive, I used their search endpoint, and a significant amount of keyword filtering.
+Ultimately I did not get much content from this source due to licensing restrictions.
 
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
+#### Who are the source data producers?
 
-[More Information Needed]
+Professional and amateur writers of long-form narrative fiction in the English language over the last few hundred years.
 
 #### Personal and Sensitive Information
 
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
+This dataset contains only works of fiction.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+The source text comes from a diverse set of english-language narrative fiction spanning hundreds of years of authorship, and may include subject matter and phrasing that offend.
+The age of much of the material from Project Gutenberg is such that white men from before the civil rights movement are vastly disproportionately represented as authors.
+Additionally, contemporary commercial fiction is nearly all but excluded due to licensing restrictions.
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Dataset Card Authors [optional]
-
-[More Information Needed]
-
-## Dataset Card Contact
-
-[More Information Needed]
+Use at your own risk.