Rewrite dataset card to document new subset/split structure

README.md

@@ -82,97 +82,121 @@ configs:
   - split: records
     path: tiles/names/*.jsonl.gz
 ---
+# OpenAlex Dataset
 
-# OpenAlex Graph Index & Tile Repository
+A complete mirror of the [OpenAlex](https://openalex.org/) scholarly knowledge graph, plus a pre-built graph index and tile repository for client-side visualization.
 
-A pre-built static index and tile repository derived from the [OpenAlex](https://openalex.org/) scholarly knowledge graph. Designed for efficient client-side graph exploration and visualization.
+## Subsets
 
-## What is this?
+### Snapshot Records (full OpenAlex data)
 
-This repository contains a **processed, indexed, and tiled** version of the OpenAlex snapshot, optimized for:
+| Config | Split | Records | Description |
+|--------|-------|---------|-------------|
+| **`complete`** | `records` | ~583M | All entity types combined |
+| **`works`** (default) | `records` | ~449M | Scholarly works — papers, articles, books, datasets |
+| **`authors`** | `records` | ~108M | Author profiles with affiliations and metrics |
+| **`institutions`** | `records` | ~103K | Universities, research institutes, hospitals |
+| **`sources`** | `records` | ~255K | Journals, repositories, conferences |
+| **`topics`** | `records` | ~4.5K | Research topics (auto-classified) |
+| **`subfields`** | `records` | 252 | Academic subfields |
+| **`fields`** | `records` | 26 | Academic fields |
+| **`domains`** | `records` | 4 | Top-level domains |
+| **`concepts`** | `records` | ~65K | Subject concepts (legacy, replaced by topics) |
+| **`funders`** | `records` | ~32K | Funding organizations |
+| **`publishers`** | `records` | ~11K | Publishing companies |
 
-- **Static HTTP serving** — all files are pre-sharded binary or compressed JSONL, ready to serve from any CDN or file host
-- **Client-side graph visualization** — spatial indices, LOD levels, and edge tiles enable progressive loading of a 500M+ node graph
-- **Entity lookup** — compact ID mappings, name indices, and search indices for fast entity resolution
+Each record is the full OpenAlex JSON matching the [REST API schema](https://docs.openalex.org/api-entities). Fields vary by entity type — see [OpenAlex docs](https://docs.openalex.org/) for details.
 
-This repository includes both the **raw OpenAlex snapshot** (under `snapshot/`) and a **processed graph index and tile set** (under `index/`, `layout/`, `tiles/`) derived from it. The upstream snapshot is also available directly from [OpenAlex on S3](https://docs.openalex.org/download-all-data/openalex-snapshot).
+Source files: gzip-compressed JSON Lines from the [OpenAlex S3 snapshot](https://docs.openalex.org/download-all-data/openalex-snapshot) (January 2026), date-partitioned under `snapshot/<entity>/YYYY-MM-DD/`.
 
-## About OpenAlex
+### Graph Index (compact IDs)
 
-[OpenAlex](https://openalex.org/) is a free, open catalogue of the global research system — scholarly works, authors, institutions, journals, and the connections between them. It is maintained by [OurResearch](https://ourresearch.org/) and available under a [CC0](https://creativecommons.org/publicdomain/zero/1.0/) public domain license.
+| Config | Split | Records | Schema | Description |
+|--------|-------|---------|--------|-------------|
+| **`index`** | `works` | ~449M | `{id, n}` | Compact integer ID + title |
+| | `authors` | ~108M | `{id, n}` | Compact integer ID + name |
+| | `institutions` | ~103K | `{id, n}` | Compact integer ID + name |
+| | `sources` | ~255K | `{id, n}` | Compact integer ID + name |
+| | `topics` | ~4.5K | `{id, n}` | Compact integer ID + name |
+| | `subfields` | 252 | `{id, n}` | Compact integer ID + name |
+| | `fields` | 26 | `{id, n}` | Compact integer ID + name |
+| | `domains` | 4 | `{id, n}` | Compact integer ID + name |
+| | `concepts` | ~65K | `{id, n}` | Compact integer ID + name |
+| | `funders` | ~32K | `{id, n}` | Compact integer ID + name |
+| | `publishers` | ~11K | `{id, n}` | Compact integer ID + name |
 
-The `snapshot/` directory in this repository is a mirror of the [OpenAlex S3 snapshot](https://docs.openalex.org/download-all-data/openalex-snapshot) ([AWS Open Data Registry](https://registry.opendata.aws/openalex/)). Records are gzip-compressed JSON Lines matching the [REST API schema](https://docs.openalex.org/api-entities), partitioned by date. The upstream snapshot is updated approximately monthly.
+Pipeline-generated compact IDs (0-indexed integers) mapped from OpenAlex IDs. Used internally by the graph visualization and tile system.
 
-### Citation
+### Utility Configs
 
-If you use this data, please cite OpenAlex:
+| Config | Split | Schema | Description |
+|--------|-------|--------|-------------|
+| **`search`** | `records` | `{w, ids}` | Inverted word index — maps lowercased tokens to compact entity IDs |
+| **`names`** | `records` | `{id, name}` | Display names keyed by compact ID, sharded for tile serving |
 
-> Priem, J., Piwowar, H., & Orr, R. (2022). OpenAlex: A fully-open index of scholarly works, authors, venues, institutions, and concepts. *ArXiv*. [https://arxiv.org/abs/2205.01833](https://arxiv.org/abs/2205.01833)
+## Quick Start
 
-See also: [OpenAlex documentation](https://docs.openalex.org/) · [API](https://api.openalex.org/) · [GitHub](https://github.com/ourresearch/openalex-snapshot)
+```python
+from datasets import load_dataset
 
-## Dataset Viewer
+# Load full OpenAlex works records
+works = load_dataset("Mearman/OpenAlex", "works", split="records")
 
-Entity types are available as two sets of configs:
+# Stream the complete dataset (all entity types, ~434 GB compressed)
+ds = load_dataset("Mearman/OpenAlex", "complete", split="records", streaming=True)
 
-- **`works`**, **`authors`**, **`concepts`**, etc. — Compact entity index built by the pipeline
-- **`snapshot-works`**, **`snapshot-authors`**, **`snapshot-concepts`**, etc. — Full OpenAlex API records from the raw S3 snapshot
+# Load a single small entity type
+topics = load_dataset("Mearman/OpenAlex", "topics", split="records")
 
-### Index configs schema
+# Load the compact graph index for authors
+authors_index = load_dataset("Mearman/OpenAlex", "index", split="authors")
 
-| Column | Type | Description |
-|--------|------|-------------|
-| `id` | `int64` | Compact integer ID (internal, not the OpenAlex ID) |
-| `n` | `string` | Display name (author name, work title, etc.) |
+# Search index
+search = load_dataset("Mearman/OpenAlex", "search", split="records")
+```
 
-### Snapshot configs schema
+### Download specific directories
 
-Full OpenAlex JSON records matching the [REST API schema](https://docs.openalex.org/api-entities). Fields vary by entity type — see [OpenAlex docs](https://docs.openalex.org/) for details.
+```python
+from huggingface_hub import snapshot_download
 
-### Additional configs
+# Download just the raw snapshot for one entity type
+snapshot_download(
+    "Mearman/OpenAlex",
+    repo_type="dataset",
+    allow_patterns="snapshot/topics/**",
+    local_dir="./openalex",
+)
 
-**`names`** — Tile display name shards:
+# Download tiles for 2D visualization
+snapshot_download(
+    "Mearman/OpenAlex",
+    repo_type="dataset",
+    allow_patterns=["tiles/manifest.json", "tiles/nodes/*", "tiles/coords/2d/*", "tiles/spatial/2d/*"],
+    local_dir="./openalex",
+)
+```
 
-| Column | Type | Description |
-|--------|------|-------------|
-| `id` | `int64` | Compact integer ID |
-| `name` | `string` | Display name |
+## About OpenAlex
 
-**`search`** — Inverted word index:
+[OpenAlex](https://openalex.org/) is a free, open catalogue of the global research system — scholarly works, authors, institutions, journals, and the connections between them. It is maintained by [OurResearch](https://ourresearch.org/) and available under a [CC0](https://creativecommons.org/publicdomain/zero/1.0/) public domain license.
 
-| Column | Type | Description |
-|--------|------|-------------|
-| `w` | `string` | Search word (lowercased token) |
-| `ids` | `list[int64]` | Compact IDs of entities containing this word |
+The `snapshot/` directory in this repository is a mirror of the [OpenAlex S3 snapshot](https://docs.openalex.org/download-all-data/openalex-snapshot) ([AWS Open Data Registry](https://registry.opendata.aws/openalex/)). The upstream snapshot is updated approximately monthly.
 
-Binary files (mappings, coordinates, spatial indices, edge tiles) are not viewable — see [Repository Structure](#repository-structure) below.
+### Citation
 
-## Coverage
+If you use this data, please cite OpenAlex:
 
-Derived from the OpenAlex snapshot (January 2026). Approximate entity counts:
+> Priem, J., Piwowar, H., & Orr, R. (2022). OpenAlex: A fully-open index of scholarly works, authors, venues, institutions, and concepts. *ArXiv*. [https://arxiv.org/abs/2205.01833](https://arxiv.org/abs/2205.01833)
 
-| Entity | Count | Config |
-|--------|-------|--------|
-| Works | ~449M | `works` |
-| Authors | ~108M | `authors` |
-| Sources | 255,250 | `sources` |
-| Institutions | 102,709 | `institutions` |
-| Concepts | 65,026 | `concepts` |
-| Funders | 32,437 | `funders` |
-| Publishers | 10,703 | `publishers` |
-| Topics | 4,516 | `topics` |
-| Subfields | 252 | `subfields` |
-| Fields | 26 | `fields` |
-| Domains | 4 | `domains` |
+See also: [OpenAlex documentation](https://docs.openalex.org/) · [API](https://api.openalex.org/) · [GitHub](https://github.com/ourresearch/openalex-snapshot)
 
 ## Repository Structure
 
 ```
 snapshot/               # Raw OpenAlex snapshot (gzipped JSONL, date-partitioned)
 ├── works/              # ~449M scholarly works (~750 GB compressed)
-│   ├── manifest
-│   └── YYYY-MM-DD/
-│       └── part_NNNN.jsonl.gz
+│   └── YYYY-MM-DD/part_NNNN.jsonl.gz
 ├── authors/            # ~108M author profiles (~64 GB compressed)
 ├── institutions/       # 103K institutions
 ├── sources/            # 255K journals/repositories
@@ -186,23 +210,16 @@ snapshot/               # Raw OpenAlex snapshot (gzipped JSONL, date-partitioned
 
 index/
 ├── entities/          # Small entity types (JSONL.gz: {id, n})
-│   ├── concepts.jsonl.gz
-│   ├── institutions.jsonl.gz
-│   ├── sources.jsonl.gz
-│   └── ... (9 files)
 ├── mappings/          # Binary ID mappings (OpenAlex ID → compact ID)
-│   ├── works.map.gz
-│   ├── authors.map.gz
-│   └── ... (5 files)
-├── authors/           # Author records (104 shards, JSONL.gz: {id, n})
-├── works/             # Work records (1,098 shards, JSONL.gz: {id, n})
+├── authors/           # Author index (104 shards, JSONL.gz)
+├── works/             # Work index (1,098 shards, JSONL.gz)
 ├── edges/             # Citation + collaboration edges (adjacency lists)
 ├── adj/               # Compressed adjacency shards
 └── search/            # Inverted word index for entity search
 
 layout/
-├── coords-2d.bin      # 2D force-directed layout coordinates (float32)
-├── coords-3d.bin      # 3D force-directed layout coordinates (float32)
+├── coords-2d.bin      # 2D force-directed layout coordinates
+├── coords-3d.bin      # 3D force-directed layout coordinates
 ├── layout-2d.json     # Layout metadata
 ├── layout-3d.json
 └── density-2d.png     # 4K density visualization
@@ -220,70 +237,6 @@ tiles/
 └── adj/               # Symlinked from index/adj
 ```
 
-## File Formats
-
-| Directory | Format | Description |
-|-----------|--------|-------------|
-| `index/entities/` | JSONL.gz | `{"id": <compact_id>, "n": "<display_name>"}` |
-| `index/authors/` | JSONL.gz | `{"id": <compact_id>, "n": "<display_name>"}` |
-| `index/works/` | JSONL.gz | `{"id": <compact_id>, "n": "<title>"}` |
-| `index/mappings/` | Binary.gz | Sorted arrays of 8-byte integers (OpenAlex ID → compact ID) |
-| `index/edges/` | Binary.gz | Adjacency lists (source → target compact IDs) |
-| `tiles/nodes/` | Binary | Fixed-width entity metadata records |
-| `tiles/coords/` | Binary | `float32[n × dim]` coordinate arrays |
-| `tiles/spatial/` | Binary | Z-order spatial index (compact ID lists per tile) |
-| `layout/coords-*.bin` | Binary | 32-byte header + `float32[n × dim]` |
-
-## Usage
-
-These files are designed to be served statically over HTTP and consumed by a JavaScript client (e.g., [BibGraph](https://github.com/Mearman/BibGraph)). They are **not** intended for direct use via `datasets.load_dataset()`, though the JSONL entity indices can be loaded that way.
-
-### Load via datasets library
-
-```python
-from datasets import load_dataset
-
-# Load compact entity index
-authors = load_dataset("Mearman/OpenAlex", "authors", split="index")
-works = load_dataset("Mearman/OpenAlex", "works", split="index")
-
-# Load full OpenAlex snapshot records
-works_full = load_dataset("Mearman/OpenAlex", "snapshot-works", split="train")
-topics_full = load_dataset("Mearman/OpenAlex", "snapshot-topics", split="train")
-
-# Load search index
-search = load_dataset("Mearman/OpenAlex", "search", split="train")
-```
-
-### Download specific directories
-
-```python
-from huggingface_hub import snapshot_download
-
-# Download just the entity index
-snapshot_download(
-    "Mearman/OpenAlex",
-    repo_type="dataset",
-    allow_patterns="index/entities/*",
-    local_dir="./openalex",
-)
-
-# Download tiles for 2D visualization
-snapshot_download(
-    "Mearman/OpenAlex",
-    repo_type="dataset",
-    allow_patterns=["tiles/manifest.json", "tiles/nodes/*", "tiles/coords/2d/*", "tiles/spatial/2d/*"],
-    local_dir="./openalex",
-)
-```
-
-### Serve locally
-
-```bash
-huggingface-cli download Mearman/OpenAlex --repo-type dataset --local-dir ./openalex
-cd openalex && python3 -m http.server 8080
-```
-
 ## Pipeline
 
 Built using the OpenAlex Pipeline on [Supercomputing Wales](https://www.supercomputing.wales/) (Falcon cluster, 192-core AMD Genoa nodes) as part of PhD research at [Bangor University](https://www.bangor.ac.uk/):
@@ -300,4 +253,4 @@ The underlying OpenAlex data is [CC0 (public domain)](https://creativecommons.or
 
 ## Status
 
-🚧 **In progress** — Raw snapshot and index (entities, mappings, authors, works) uploaded. Edges, search, layout, and tiles will be added as pipeline jobs complete.
+🚧 **In progress** — Raw snapshot and index uploaded. Layout and tiles will be added as pipeline jobs complete.