Update README.md with sources & keys

Updated list of data source and keys along with some extra description of dataset in general.

README.md

@@ -6,96 +6,82 @@ language:
 - en
 size_categories:
 - 10K<n<100K
-pretty_name: ARD
+pretty_name: alignment-research-dataset
 ---
 # AI Alignment Research Dataset
-This dataset is based on [alignment-research-dataset](https://github.com/moirage/alignment-research-dataset).
 
-For more information about the dataset, have a look at the [paper](https://arxiv.org/abs/2206.02841) or [LessWrong](https://www.lesswrong.com/posts/FgjcHiWvADgsocE34/a-descriptive-not-prescriptive-overview-of-current-ai) post.
-
-It is currently maintained and kept up-to-date by volunteers at StampyAI / AI Safety Info.
+The AI Alignment Research Dataset is a collection of documents related to AI Alignment and Safety from various books, research papers, and alignment related blog posts. This is a work in progress. Components are still undergoing a cleaning process to be updated more regularly.
 
 ## Sources
 
-The important thing here is that not all of the dataset entries contain all the same keys.
-
-They all have the keys: id, source, title, text, and url
-
-Other keys are available depending on the source document.
-
-1. `source`: indicates the data sources:
-
-- agentmodels
-- aiimpacts.org
-- aipulse.org
-- aisafety.camp
-- arbital
-- arxiv_papers
-- audio_transcripts
-- carado.moe
-- cold.takes
-- deepmind.blog
-- distill
-- eaforum
-- **gdocs**
-- **gdrive_ebooks**
-- generative.ink
-- gwern_blog
-- intelligence.org
-- jsteinhardt
-- lesswrong
-- **markdown.ebooks**
-- nonarxiv_papers
-- qualiacomputing.com
-- **reports**
-- stampy
-- vkrakovna
-- waitbutwhy
-- yudkowsky.net
-
-2. `alignment_text`: This is label specific to the arXiv papers. We added papers to the dataset using Allen AI's SPECTER model and included all the papers that got a confidence score of over 75%. However, since we could not verify with certainty that those papers where about alignment, we've decided to create the `alignment_text` key with the value `"pos"` when we manually labeled it as an alignment text and `"unlabeled"` when we have not labeled it yet. Additionally, we've only included the `text` for the `"pos"` entries, not the `"unlabeled"` entries.
+The following list of sources may change and items may be renamed:
+
+- [agentmodels](https://agentmodels.org/)
+- [aiimpacts.org](https://aiimpacts.org/)
+- [aisafety.camp](https://aisafety.camp/)
+- [arbital](https://arbital.com/)
+- arxiv_papers - alignment research papers from [arxiv](https://arxiv.org/)
+- audio_transcripts - transcripts from interviews with various researchers and other audio recordings
+- [carado.moe](https://carado.moe/)
+- [cold.takes](https://www.cold-takes.com/)
+- [deepmind.blog](https://deepmindsafetyresearch.medium.com/)
+- [distill](https://distill.pub/)
+- [eaforum](https://forum.effectivealtruism.org/) - selected posts
+- gdocs
+- gdrive_ebooks - books include [Superintelligence](https://www.goodreads.com/book/show/20527133-superintelligence), [Human Compatible](https://www.goodreads.com/book/show/44767248-human-compatible), [Life 3.0](https://www.goodreads.com/book/show/34272565-life-3-0), [The Precipice](https://www.goodreads.com/book/show/50485582-the-precipice), and others
+- [generative.ink](https://generative.ink/posts/)
+- [gwern_blog](https://gwern.net/)
+- [intelligence.org](https://intelligence.org/) - MIRI
+- [jsteinhardt.wordpress.com](https://jsteinhardt.wordpress.com/)
+- [lesswrong](https://www.lesswrong.com/) - selected posts
+- markdown.ebooks
+- nonarxiv_papers - other alignment research papers
+- [qualiacomputing.com](https://qualiacomputing.com/)
+- reports
+- [stampy](https://aisafety.info/)
+- [vkrakovna.wordpress.com](https://vkrakovna.wordpress.com)
+- [waitbutwhy](https://waitbutwhy.com/)
+- [yudkowsky.net](https://www.yudkowsky.net/)
+
+## Keys
+
+Not all of the entries contain the same keys, but they all have the following:
+
+- id - unique identifier
+- source - based on the data source listed in the previous section
+- title - title of document
+- text - full text of document content
+- url - some values may be `'n/a'`, still being updated
+- date_published - some `'n/a'`
+
+The values of the keys are still being cleaned up for consistency. Additional keys are available depending on the source document.
 
 ## Usage
 
 Execute the following code to download and parse the files:
-```
+
+```python
 from datasets import load_dataset
 data = load_dataset('StampyAI/alignment-research-dataset')
 ```
 
 To only get the data for a specific source, pass it in as the second argument, e.g.:
 
-```
+```python
 from datasets import load_dataset
 data = load_dataset('StampyAI/alignment-research-dataset', 'lesswrong')
 ```
 
-The various sources have different keys - the resulting data object will have all keys that make sense, with `None** as the value of keys that aren't in a given source. For example, assuming there are the following sources with the appropriate features:
-
-##### source1
-+ id
-+ name
-+ description
-+ author
-
-##### source2
-+ id
-+ name
-+ url
-+ text
-
-Then the resulting data object with have 6 columns, i.e. `id`, `name`, `description`, `author`, `url` and `text`, where rows from `source1` will have `None` in the `url` and `text` columns, and the `source2` rows will have `None` in their `description` and `author` columns.
-
-## Limitations and bias
+## Limitations and Bias
 
-LessWrong posts have overweighted content on x-risk doom so beware of training or finetuning generative LLMs on the dataset.
+LessWrong posts have overweighted content on doom and existential risk, so please beware in training or finetuning generative language models on the dataset.
 
 ## Contributing
 
-Join us at [StampyAI](https://coda.io/d/AI-Safety-Info_dfau7sl2hmG/Get-involved_susRF#_lufSr).
+The scraper to generate this dataset is open-sourced on [GitHub](https://github.com/StampyAI/alignment-research-dataset) and currently maintained by volunteers at StampyAI / AI Safety Info. [Learn more](https://coda.io/d/AI-Safety-Info_dfau7sl2hmG/Get-involved_susRF#_lufSr) or join us on [Discord](https://discord.gg/vjFSCDyMCy).
 
 ## Citing the Dataset
 
-Please use the following citation when using our dataset:
+For more information, here is the [paper](https://arxiv.org/abs/2206.02841) and [LessWrong](https://www.lesswrong.com/posts/FgjcHiWvADgsocE34/a-descriptive-not-prescriptive-overview-of-current-ai) post. Please use the following citation when using the dataset:
 
 Kirchner, J. H., Smith, L., Thibodeau, J., McDonnell, K., and Reynolds, L. "Understanding AI alignment research: A Systematic Analysis." arXiv preprint arXiv:2022.4338861 (2022).