Update README.md

README.md

@@ -9,31 +9,83 @@ tags:
 # The GraphTide Real-World Dynamic Graph Datasets
 
 GraphTide is a collection of large-scale, real-world dynamic graph
-datasets with authentic temporal information. It is intended for
-evaluating streaming graph algorithms, dynamic graph systems, and
+datasets with authentic temporal information. It supports experimental
+evaluation of streaming graph algorithms, dynamic graph systems, and
 temporal graph analysis.
 
-Source code, I/O tools, validation utilities, and documentation are
-available in the
-[GraphTide GitHub repository](https://github.com/wheatman/GraphTide).
+Source code, I/O and validation tools, and documentation are available
+in the [GraphTide GitHub repository](https://github.com/wheatman/GraphTide).
 
 ## Graph Types
 
-GraphTide contains two types of dynamic graphs:
-
-- **Signal graphs** record timestamped interactions between vertices,
-  such as transactions, comments, commits, or flights.
+- **Signal graphs** record timestamped interactions, such as
+  transactions, comments, commits, and trips.
 - **Update graphs** record explicit edge insertions and deletions,
   allowing the graph state to be reconstructed over time.
 
-## Repository Layout
+Files are organized as:
 
 ```text
 signal_graphs/   Timestamped edge-event streams
 update_graphs/   Explicit edge insertion/deletion streams
 ```
 
-Each graph is distributed as an individual `.bin` file.
+## Datasets
+
+All currently released graphs are unweighted. `Unique Edges` denotes
+the number of distinct endpoint pairs, while `Events` denotes the
+number of temporal signals or updates.
+
+### Signal Graphs
+
+| Dataset | Domain | Vertices | Unique Edges | Events | Timestamps | Unit | Directed |
+|:---|:---|---:|---:|---:|---:|:---|:---:|
+| [ia-online-ads-criteo](signal_graphs/ia-online-ads-criteo.bin) | Advertisement | 15,336,555 | 15,170,743 | 15,995,634 | 6,456,934 | seconds | No |
+| [soc-bitcoin](signal_graphs/soc-bitcoin.bin) | Blockchain | 24,575,382 | 86,063,840 | 122,948,162 | 19,444,110 | seconds | No |
+| [btc_stream_unweighted](signal_graphs/btc_stream_unweighted.bin) | Blockchain | 30,532,588 | 114,720,659 | 179,563,152 | 358,055 | seconds | No |
+| [ethereum](signal_graphs/ethereum.bin) | Blockchain | 78,945,641 | 236,100,055 | 781,489,512 | 10,200,000 | seconds | Yes |
+| [organization](signal_graphs/org.bin) | Collaboration | 23,309,109 | 38,081,253 | 192,051,799 | 27 | year | No |
+| [venue](signal_graphs/ven.bin) | Collaboration | 64,482,050 | 64,405,068 | 64,698,700 | 27 | year | No |
+| [publication](signal_graphs/pub.bin) | Collaboration | 144,435,257 | 375,925,058 | 378,459,524 | 27 | year | No |
+| [coauthor](signal_graphs/coa.bin) | Collaboration | 31,547,264 | 656,908,420 | 3,032,478,219 | 27 | year | No |
+| [reference](signal_graphs/ref.bin) | Collaboration | 71,129,632 | 1,138,706,757 | 1,138,706,757 | 27 | year | No |
+| [semantic-scholar](signal_graphs/semantic_scholar_sorted.bin) | Collaboration | 125,738,070 | 2,587,951,493 | 2,587,951,493 | 229 | year | Yes |
+| [rec-amazon-ratings](signal_graphs/rec-amazon-ratings.bin) | Recommendation | 2,146,057 | 5,743,258 | 5,838,041 | 3,329 | seconds | No |
+| [rec-amz-Sports-and-Outdoors](signal_graphs/rec-amz-Sports-and-Outdoors.bin) | Recommendation | 2,469,419 | 3,268,695 | 3,268,695 | 4,786 | seconds | No |
+| [rec-amz-Cell-Phones-and-Acc](signal_graphs/rec-amz-Cell-Phones-and-Acc.bin) | Recommendation | 2,580,723 | 3,447,249 | 3,447,249 | 4,724 | seconds | No |
+| [rec-amz-CDs-and-Vinyl](signal_graphs/rec-amz-CDs-and-Vinyl.bin) | Recommendation | 2,064,957 | 3,749,004 | 3,749,004 | 6,041 | seconds | No |
+| [rec-amz-Home-and-Kitchen](signal_graphs/rec-amz-Home-and-Kitchen.bin) | Recommendation | 2,921,853 | 4,253,926 | 4,253,926 | 5,202 | seconds | No |
+| [rec-amz-Movies-and-TV](signal_graphs/rec-amz-Movies-and-TV.bin) | Recommendation | 2,289,561 | 4,607,047 | 4,607,047 | 6,004 | seconds | No |
+| [rec-amz-Clothing-Shoes-Jewelry](signal_graphs/rec-amz-Clothing-Shoes-Jewelry.bin) | Recommendation | 4,253,272 | 5,748,920 | 5,748,920 | 4,209 | seconds | No |
+| [rec-amz-Electronics](signal_graphs/rec-amz-Electronics.bin) | Recommendation | 4,677,698 | 7,824,482 | 7,824,482 | 5,489 | seconds | No |
+| [rec-amz-Books](signal_graphs/rec-amz-Books.bin) | Recommendation | 10,356,390 | 22,507,155 | 22,507,155 | 6,296 | seconds | No |
+| [copresence-Thiers13](signal_graphs/copresence-Thiers13.bin) | Social | 328 | 43,496 | 18,613,039 | 8,938 | seconds | No |
+| [soc-youtube-growth](signal_graphs/soc-youtube-growth.bin) | Social | 3,223,589 | 9,376,594 | 12,223,774 | 203 | seconds | No |
+| [sx-stackoverflow](signal_graphs/sx-stackoverflow.bin) | Social | 2,584,164 | 28,183,518 | 47,903,266 | 41,484,769 | seconds | No |
+| [soc-flickr-growth](signal_graphs/soc-flickr-growth.bin) | Social | 2,302,925 | 33,140,017 | 33,140,017 | 134 | seconds | No |
+| [bluesky](signal_graphs/bluesky.bin) | Social | 1,873,159 | 52,417,090 | 250,624,500 | 528,924 | seconds | No |
+| [reddit](signal_graphs/reddit.bin) | Social | 74,000,011 | 746,954,361 | 8,989,320,299 | 168,851,154 | seconds | No |
+| [llvm](signal_graphs/llvm.bin) | Software | 243,737 | 1,019,582 | 2,453,587 | 526,032 | seconds | No |
+| [linux](signal_graphs/linux.bin) | Software | 193,269 | 1,078,218 | 2,838,279 | 1,192,006 | seconds | No |
+| [nyc_taxi_yellow](signal_graphs/nyc_yellow_taxi.bin) | Transportation | 265 | 63,692 | 1,371,194,911 | 346,991,031 | seconds | Yes |
+| [flight_opensky](signal_graphs/flight_opensky.bin) | Transportation | 18,257 | 2,380,394 | 62,582,273 | 45,835,674 | seconds | Yes |
+
+An additional `ia-online-ads-criteo-attrs.bin` variant is also
+available in `signal_graphs/`.
+
+### Update Graphs
+
+| Dataset | Domain | Vertices | Unique Edges | Events | Timestamps | Unit | Directed |
+|:---|:---|---:|---:|---:|---:|:---|:---:|
+| [wikipedia](update_graphs/wikipedia.bin) | Web | 62,489,082 | 401,854,218 | 1,294,550,620 | 183,259,984 | seconds | No |
+| [central-america](update_graphs/central-america.bin) | Road | 4,454,638 | 6,468,206 | 10,661,854 | 1,354,927 | seconds | Yes |
+| [australia-oceania](update_graphs/australia-oceania.bin) | Road | 8,232,884 | 13,204,266 | 20,619,707 | 2,577,810 | seconds | Yes |
+| [south-america](update_graphs/south-america.bin) | Road | 26,944,705 | 43,659,791 | 71,807,857 | 6,686,033 | seconds | Yes |
+| [africa](update_graphs/africa.bin) | Road | 43,817,014 | 65,355,044 | 95,425,505 | 8,085,311 | seconds | Yes |
+| [north-america](update_graphs/north-america.bin) | Road | 112,771,288 | 170,000,577 | 258,236,950 | 29,048,546 | seconds | Yes |
+| [asia](update_graphs/asia.bin) | Road | 124,486,147 | 187,177,810 | 280,092,215 | 24,095,945 | seconds | Yes |
+| [europe](update_graphs/europe.bin) | Road | 169,942,207 | 267,341,689 | 441,068,613 | 57,207,306 | seconds | Yes |
+| [planet](update_graphs/planet.bin) | Road | 485,492,757 | 745,319,813 | 1,165,712,593 | 117,089,898 | seconds | Yes |
 
 ## Download
 
@@ -63,115 +115,71 @@ hf download DynamicGraphsProvider/GraphTide \
 The complete collection is large, so downloading individual files is
 recommended.
 
-## Reading the Data
+## Reading and Validation
 
-Install the GraphTide Python tools:
+Install the GraphTide tools:
 
 ```bash
 git clone https://github.com/wheatman/GraphTide.git GraphTide-code
 python -m pip install -e ./GraphTide-code
 ```
 
-Inspect a graph header:
+Read a header or load a graph:
 
 ```python
-from pybinding import read_header
-
-header = read_header(
-    "GraphTide-data/signal_graphs/soc-youtube-growth.bin"
-)
-print(header)
-```
+from pybinding import read_header, read_bin
 
-Load a graph into a NumPy structured array:
-
-```python
-from pybinding import read_bin
+path = "GraphTide-data/signal_graphs/soc-youtube-growth.bin"
 
-header, data = read_bin(
-    "GraphTide-data/signal_graphs/soc-youtube-growth.bin"
-)
+header = read_header(path)
+header, data = read_bin(path)
 ```
 
 Large datasets should be processed with the streaming C++ I/O
 interface rather than loaded completely into memory.
 
-## Binary Format
-
-Each file begins with a 32-byte little-endian header containing:
+Validate a binary graph:
 
-```text
-num_vertices
-num_unique_edges
-total_updates
-signal
-vertex_id_type
-timestamp_type
-directed
-weight_type
+```bash
+cd GraphTide-code
+python -m pybinding.validate /path/to/dataset.bin
 ```
 
-The header is followed by tightly packed records containing:
+For an update graph, the optional stateful check also validates the
+insertion/deletion sequence:
 
-```text
-src, dst, [timestamp], [weight], [info]
+```bash
+python -m pybinding.validate /path/to/dataset.bin \
+  --check-update-sequence
 ```
 
-Optional fields are determined by the header. For update graphs:
+## Binary Format
+
+Each file contains a 32-byte little-endian header followed by tightly
+packed records:
 
 ```text
-info = 0   insertion
-info = 1   deletion
+src, dst, [timestamp], [weight], [info]
 ```
 
-Graph type, direction, weight support, and field widths may differ
-across datasets.
+The header specifies the graph type, direction, data types, number of
+vertices, unique edges, and temporal records. For update graphs,
+`info=0` denotes insertion and `info=1` denotes deletion.
 
 See the complete
 [binary format specification](https://github.com/wheatman/GraphTide/blob/main/IO/README.md).
 
-## Validation
-
-Validate a binary graph with:
-
-```bash
-cd GraphTide-code
-python -m pybinding.validate /path/to/dataset.bin
-```
-
-For an update graph, the optional stateful check verifies the
-insertion/deletion sequence:
-
-```bash
-python -m pybinding.validate /path/to/dataset.bin \
-  --check-update-sequence
-```
-
 ## Contributing a Dataset
 
-GraphTide welcomes community-contributed real-world dynamic graph
-datasets. Providing the original parser is encouraged but not
-required.
+Providing the original parser is encouraged but not required.
 
 Before uploading a large file, open a
 [New dataset proposal](https://github.com/wheatman/GraphTide/issues/new?template=new-dataset.yml)
-describing:
-
-- the source, citation, and license;
-- signal/update and directed/undirected properties;
-- vertex and edge-event semantics;
-- timestamp unit;
-- cleaning decisions; and
-- approximate dataset size.
+describing the source, license, graph semantics, timestamps, cleaning
+decisions, and approximate size.
 
-After the proposal is approved:
-
-1. Convert the data to the GraphTide binary format.
-2. Run the validator.
-3. Upload the `.bin` file to this repository as a pull request.
-4. Link the Hugging Face pull request from the GitHub proposal.
-
-For a signal graph:
+After approval, validate the graph and upload it through a Hugging Face
+pull request:
 
 ```bash
 hf auth login
@@ -183,16 +191,11 @@ hf upload DynamicGraphsProvider/GraphTide \
   --commit-message "Add DATASET_ID dynamic graph"
 ```
 
-Use `update_graphs/DATASET_ID.bin` for an update graph.
+Use `update_graphs/DATASET_ID.bin` for an update graph, and link the
+Hugging Face pull request from the original GitHub proposal.
 
 See the complete
 [contribution guidelines](https://github.com/wheatman/GraphTide/blob/main/CONTRIBUTING.md).
 
-## Maintenance
-
-Accepted datasets are maintained as versioned Hugging Face revisions.
-Corrections or refreshed snapshots should be submitted through a new
-proposal and pull request.
-
-For questions or dataset proposals, use the
+For questions, use the
 [GraphTide issue tracker](https://github.com/wheatman/GraphTide/issues).