Update README.md

README.md

@@ -1,44 +1,198 @@
 ---
 license: mit
+tags:
+  - graph
+  - dynamic-graph
+  - temporal-graph
 ---
 
 # The GraphTide Real-World Dynamic Graph Datasets
 
-GraphTide is a collection of large dynamic graph datasets in a compact binary
-format for streaming graph algorithms, dynamic graph benchmarks, and temporal
-graph analysis.
+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
+temporal graph analysis.
 
-Download the source code from [`wheatman/GraphTide`](https://github.com/wheatman/GraphTide).
-It contains the binary IO spec, Python readers/converters, source parsers, and C++ analysis code.
+Source code, I/O tools, validation utilities, 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.
+- **Update graphs** record explicit edge insertions and deletions,
+  allowing the graph state to be reconstructed over time.
+
+## Repository Layout
 
-## Layout
 ```text
-signal_graphs/   insert-only temporal edge streams
-update_graphs/   explicit edge insert/delete streams
+signal_graphs/   Timestamped edge-event streams
+update_graphs/   Explicit edge insertion/deletion streams
 ```
 
+Each graph is distributed as an individual `.bin` file.
+
 ## Download
-The full dataset is large, so download only the files you need when possible.
+
+Install the Hugging Face tools:
+
 ```bash
-pip install -U huggingface_hub
-huggingface-cli download DynamicGraphsProvider/GraphTide \
+pip install -U huggingface_hub hf_xet
+```
+
+Download one dataset:
+
+```bash
+hf download DynamicGraphsProvider/GraphTide \
   signal_graphs/soc-youtube-growth.bin \
-  --repo-type dataset --local-dir GraphTide
+  --repo-type dataset \
+  --local-dir GraphTide-data
 ```
-To clone everything:
+
+Download the complete collection:
+
 ```bash
-git lfs install
-git clone https://huggingface.co/datasets/DynamicGraphsProvider/GraphTide
+hf download DynamicGraphsProvider/GraphTide \
+  --repo-type dataset \
+  --local-dir GraphTide-data
 ```
 
+The complete collection is large, so downloading individual files is
+recommended.
+
+## Reading the Data
+
+Install the GraphTide Python tools:
+
+```bash
+git clone https://github.com/wheatman/GraphTide.git GraphTide-code
+python -m pip install -e ./GraphTide-code
+```
+
+Inspect a graph header:
+
+```python
+from pybinding import read_header
+
+header = read_header(
+    "GraphTide-data/signal_graphs/soc-youtube-growth.bin"
+)
+print(header)
+```
+
+Load a graph into a NumPy structured array:
+
+```python
+from pybinding import read_bin
+
+header, data = read_bin(
+    "GraphTide-data/signal_graphs/soc-youtube-growth.bin"
+)
+```
+
+Large datasets should be processed with the streaming C++ I/O
+interface rather than loaded completely into memory.
+
 ## Binary Format
-Each file starts with a 32-byte little-endian header: three `uint64` values
-(`num_vertices`, `num_unique_edges`, `total_updates`), five `uint8` values
-(`signal`, `vertex_id_type`, `timestamp_type`, `directed`, `weight_type`), and
-three padding bytes.
-Rows contain `src`, `dst`, optional `timestamp`, optional `weight`, and for
-update graphs an `info` byte. The shipped files are directed, unweighted, and use
-`UINT32` vertex IDs and `UINT32` timestamps.
 
-See https://github.com/wheatman/GraphTide/blob/main/IO/README.md for details.
+Each file begins with a 32-byte little-endian header containing:
+
+```text
+num_vertices
+num_unique_edges
+total_updates
+signal
+vertex_id_type
+timestamp_type
+directed
+weight_type
+```
+
+The header is followed by tightly packed records containing:
+
+```text
+src, dst, [timestamp], [weight], [info]
+```
+
+Optional fields are determined by the header. For update graphs:
+
+```text
+info = 0   insertion
+info = 1   deletion
+```
+
+Graph type, direction, weight support, and field widths may differ
+across datasets.
+
+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.
+
+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.
+
+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:
+
+```bash
+hf auth login
+
+hf upload DynamicGraphsProvider/GraphTide \
+  /path/to/dataset.bin signal_graphs/DATASET_ID.bin \
+  --repo-type dataset \
+  --create-pr \
+  --commit-message "Add DATASET_ID dynamic graph"
+```
+
+Use `update_graphs/DATASET_ID.bin` for an update graph.
+
+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
+[GraphTide issue tracker](https://github.com/wheatman/GraphTide/issues).