Make dataset README self-contained
Browse files
README.md
CHANGED
|
@@ -20,38 +20,38 @@ configs:
|
|
| 20 |
|
| 21 |
# Subreddits Directory
|
| 22 |
|
| 23 |
-
A
|
| 24 |
|
| 25 |
-
The dataset contains **395,018 rows and 12 columns** of subreddit names, descriptions, member counts, and other community metadata.
|
| 26 |
|
| 27 |
-
**
|
| 28 |
|
| 29 |
## Data and preservation
|
| 30 |
|
| 31 |
-
The single file `data/train-00000-of-00001.parquet` uses Zstandard compression and is 183,178,103 bytes (approximately 183 MB). The `train` split contains the entire
|
| 32 |
|
| 33 |
All original column names, parsed cell values, row order, and column order are preserved. No rows were filtered, deduplicated, added, or reordered. No descriptions were rewritten, combined, trimmed, or filled in. Existing rules and other auxiliary columns are retained.
|
| 34 |
|
| 35 |
Every column is stored as a **string**, including counts, booleans, and timestamps. This deliberately avoids changing numeric spellings, boolean spellings, or timestamp representations during CSV type inference. Empty CSV cells remain empty strings, not nulls. CSV quoting and delimiters are serialization details and are replaced by Parquet encoding.
|
| 36 |
|
| 37 |
-
The conversion was verified by
|
| 38 |
|
| 39 |
## Columns
|
| 40 |
|
| 41 |
| Column | Meaning | Empty cells |
|
| 42 |
|---|---|---:|
|
| 43 |
-
| `title` | Subreddit title
|
| 44 |
-
| `description` | Longer subreddit description/sidebar text
|
| 45 |
-
| `display_name` | Subreddit display name
|
| 46 |
-
| `created_utc` | Community creation-time value in
|
| 47 |
-
| `over18` |
|
| 48 |
-
| `url` |
|
| 49 |
-
| `subscribers` | Subscriber/member count at
|
| 50 |
-
| `public_description` | Short public subreddit description
|
| 51 |
-
| `subreddit` | Subreddit name
|
| 52 |
-
| `retrieved_on` |
|
| 53 |
-
| `rules_markdown` |
|
| 54 |
-
| `descp` | Auxiliary description field
|
| 55 |
|
| 56 |
## Load with Hugging Face Datasets
|
| 57 |
|
|
@@ -74,21 +74,20 @@ row = next(iter(dataset))
|
|
| 74 |
|
| 75 |
Consumers can explicitly parse numeric or date columns for their own analysis. No such coercion is applied to the published data.
|
| 76 |
|
| 77 |
-
##
|
| 78 |
|
| 79 |
-
|
| 80 |
|
| 81 |
```bash
|
| 82 |
-
|
| 83 |
-
python convert.py source/subreddits_with_details.csv output
|
| 84 |
```
|
| 85 |
|
| 86 |
-
The
|
| 87 |
|
| 88 |
-
##
|
| 89 |
|
| 90 |
-
|
| 91 |
|
| 92 |
-
|
| 93 |
|
| 94 |
-
Descriptions and rules are user-generated text and may contain offensive or adult content.
|
|
|
|
| 20 |
|
| 21 |
# Subreddits Directory
|
| 22 |
|
| 23 |
+
A directory of Reddit communities published by SemVec in Parquet format.
|
| 24 |
|
| 25 |
+
The dataset contains **395,018 rows and 12 columns** of subreddit names, descriptions, member counts, and other community metadata. This Parquet edition was prepared on October 17, 2026.
|
| 26 |
|
| 27 |
+
**This dataset contains historical metadata.** The publication date of this repository is not the collection date. Names, descriptions, member counts, rules, availability, and other values reflect previously collected records. Where available, `retrieved_on` provides a record's retrieval timestamp. This is not a verified directory of every currently existing subreddit.
|
| 28 |
|
| 29 |
## Data and preservation
|
| 30 |
|
| 31 |
+
The single file `data/train-00000-of-00001.parquet` uses Zstandard compression and is 183,178,103 bytes (approximately 183 MB). The `train` split contains the entire table; it is a loading convention, not an assignment of this data to model training or a train/test partition.
|
| 32 |
|
| 33 |
All original column names, parsed cell values, row order, and column order are preserved. No rows were filtered, deduplicated, added, or reordered. No descriptions were rewritten, combined, trimmed, or filled in. Existing rules and other auxiliary columns are retained.
|
| 34 |
|
| 35 |
Every column is stored as a **string**, including counts, booleans, and timestamps. This deliberately avoids changing numeric spellings, boolean spellings, or timestamp representations during CSV type inference. Empty CSV cells remain empty strings, not nulls. CSV quoting and delimiters are serialization details and are replaced by Parquet encoding.
|
| 36 |
|
| 37 |
+
The conversion was verified by comparing **every cell of every row** with the original records. `conversion-manifest.json` records the validation result, file SHA-256 checksums, schema, and empty-string counts. The Parquet file contains the complete published table and can be used independently.
|
| 38 |
|
| 39 |
## Columns
|
| 40 |
|
| 41 |
| Column | Meaning | Empty cells |
|
| 42 |
|---|---|---:|
|
| 43 |
+
| `title` | Subreddit title. | 18 |
|
| 44 |
+
| `description` | Longer subreddit description/sidebar text. | 161,178 |
|
| 45 |
+
| `display_name` | Subreddit display name. | 1 |
|
| 46 |
+
| `created_utc` | Community creation-time value in its original representation. | 0 |
|
| 47 |
+
| `over18` | Adult-content/NSFW flag, retained as text. | 0 |
|
| 48 |
+
| `url` | Community URL or relative Reddit path. | 0 |
|
| 49 |
+
| `subscribers` | Subscriber/member count at collection time, retained as text. | 0 |
|
| 50 |
+
| `public_description` | Short public subreddit description. | 54,126 |
|
| 51 |
+
| `subreddit` | Subreddit name. | 0 |
|
| 52 |
+
| `retrieved_on` | Retrieval-time value, when provided; retained verbatim. | 259,611 |
|
| 53 |
+
| `rules_markdown` | Community rules in Markdown, when provided. | 259,611 |
|
| 54 |
+
| `descp` | Auxiliary description field. Its original construction is undocumented; it is preserved without reinterpretation. | 0 |
|
| 55 |
|
| 56 |
## Load with Hugging Face Datasets
|
| 57 |
|
|
|
|
| 74 |
|
| 75 |
Consumers can explicitly parse numeric or date columns for their own analysis. No such coercion is applied to the published data.
|
| 76 |
|
| 77 |
+
## Download the Parquet file
|
| 78 |
|
| 79 |
+
Download directly from this repository with the Hugging Face CLI:
|
| 80 |
|
| 81 |
```bash
|
| 82 |
+
hf download semvec/subreddits-directory data/train-00000-of-00001.parquet --repo-type dataset --local-dir subreddits-directory
|
|
|
|
| 83 |
```
|
| 84 |
|
| 85 |
+
The repository also includes `convert.py`, the CSV-to-Parquet conversion and validation script used to prepare this edition. It is not needed to load or download the dataset.
|
| 86 |
|
| 87 |
+
## Usage terms and limitations
|
| 88 |
|
| 89 |
+
The full original collection methodology is not documented. Community flags and metadata have not been independently validated, and completeness is not guaranteed.
|
| 90 |
|
| 91 |
+
The dataset retains the **`reddit-api`** license designation; see [Reddit's Data API Terms](https://redditinc.com/policies/data-api-terms). It is not relicensed under an open-source or Creative Commons license. Public availability of this repository does not grant additional rights to the underlying content.
|
| 92 |
|
| 93 |
+
Descriptions and rules are user-generated text and may contain offensive or adult content. Missing fields, duplicate records, and any original inconsistencies are preserved.
|