Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,69 @@
+---
+configs:
+- config_name: en
+  data_files:
+  - split: words
+    path: data/en/words.parquet
+- config_name: en-basic
+  data_files:
+  - split: words
+    path: data/en-basic/words.parquet
+license: other
+task_categories:
+- text-classification
+- token-classification
+pretty_name: NLTK Word Lists
+---
+
+# NLTK Word Lists
+
+English word lists from [NLTK](https://www.nltk.org/).
+
+| Config | Description |
+|---|---|
+| `en` | Full English word list (~235K words) |
+| `en-basic` | Basic English vocabulary (850 core words) |
+
+Each config is a separate HF dataset. Each row is one word.
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("nltk-data-hub/words", "en")
+words = ds["words"]["word"]
+
+ds_basic = load_dataset("nltk-data-hub/words", "en-basic")
+basic = ds_basic["words"]["word"]
+```
+
+## Schema
+
+| Column | Type | Description |
+|---|---|---|
+| `word` | `string` | The word |
+
+## Configs
+
+| Config | Count |
+|---|---|
+| en | 235,886 |
+| en-basic | 850 |
+
+## Source
+
+Originally distributed as part of `nltk.download('words')`.
+Converted to Parquet for use with the HuggingFace `datasets` library.
+
+## Citation
+
+```bibtex
+@book{nltk,
+  author    = {Bird, Steven and Klein, Ewan and Loper, Edward},
+  title     = {Natural Language Processing with Python},
+  publisher = {O'Reilly Media},
+  year      = {2009},
+  url       = {https://www.nltk.org/}
+}
+```