Use descriptive dataset table names and update loading examples

README.md

@@ -14,6 +14,28 @@ task_categories:
   - time-series-forecasting
 size_categories:
   - 1M<n<10M
+configs:
+- config_name: bitcoin_transaction_lifecycle
+  data_files:
+  - split: train
+    path: e8_btc_mempool_lifecycle/**/*.parquet
+  default: true
+- config_name: bitcoin_mempool_comparison
+  data_files:
+  - split: train
+    path: e9_btc_mempool_divergence/**/*.parquet
+- config_name: litecoin_transaction_lifecycle
+  data_files:
+  - split: train
+    path: e11_ltc_mempool_lifecycle/**/*.parquet
+- config_name: bitcoin_block_composition
+  data_files:
+  - split: train
+    path: e8_btc_block_composition/**/*.parquet
+- config_name: collection_runs
+  data_files:
+  - split: train
+    path: e0_run_manifest/**/*.parquet
 ---
 
 # Bitcoin and Litecoin mempool lifecycle
@@ -24,10 +46,10 @@ Transaction observations covering first sight, time spent pending, confirmation
 
 | Table | Record |
 |---|---|
-| `e8_btc_mempool_lifecycle` | A Bitcoin transaction's observed lifecycle, fee information and outcome |
-| `e9_btc_mempool_divergence` | A provider's pending-set size and overlap with other views |
-| `e11_ltc_mempool_lifecycle` | A Litecoin transaction lifecycle observation |
-| `e8_btc_block_composition` | A block's previously observed and newly seen transaction counts |
+| `bitcoin_transaction_lifecycle` | A Bitcoin transaction's observed lifecycle, fee information and outcome |
+| `bitcoin_mempool_comparison` | A provider's pending-set size and overlap with other views |
+| `litecoin_transaction_lifecycle` | A Litecoin transaction lifecycle observation |
+| `bitcoin_block_composition` | A block's previously observed and newly seen transaction counts |
 
 ## Observation coverage
 
@@ -55,20 +77,35 @@ Data is stored as Parquet files under `dataset/YYYY/MM/`, with partitions for co
 
 ### Load a table
 
+Install `datasets` and `pandas` to run this example. The `train` split contains all observations in the selected table; it is not a predefined modelling split.
+
 ```python
-from huggingface_hub import snapshot_download
-import pandas as pd, glob
+from datasets import load_dataset
 
-path = snapshot_download("dataforge-labs/bitcoin-mempool-lifecycle", repo_type="dataset",
-                         allow_patterns="e8_btc_mempool_lifecycle/**")
-df = pd.concat(map(pd.read_parquet,
-                   glob.glob(f"{path}/e8_btc_mempool_lifecycle/**/*.parquet", recursive=True)))
+data = load_dataset("dataforge-labs/bitcoin-mempool-lifecycle",
+                    "bitcoin_transaction_lifecycle", split="train")
+df = data.to_pandas()
 ```
 
 ## Coverage
 
-`e0_run_manifest` records collection windows, poll counts and failures. It is published in full and may cover dates beyond the fixed data sample. Collection gaps are not interpolated. Use the manifest together with table timestamps and error fields to assess coverage.
+`collection_runs` records collection windows, poll counts and failures. It is published in full and may cover dates beyond the fixed data sample. Collection gaps are not interpolated. Use this table together with measurement timestamps and error fields to assess coverage.
 
 ## License and contact
 
 The public sample is published under ODC-BY. Attribute it to "DataForge (dataforge-labs)". For questions about the data or access to additional history, open a discussion in this repository.
+
+<details>
+<summary>File paths and compatibility</summary>
+
+The table names above are Hugging Face dataset configurations. Each configuration reads the original Parquet files, whose paths remain unchanged for existing downloads and scripts. No records are copied, moved or renamed.
+
+| Table name | Storage directory |
+|---|---|
+| `bitcoin_transaction_lifecycle` | `e8_btc_mempool_lifecycle/` |
+| `bitcoin_mempool_comparison` | `e9_btc_mempool_divergence/` |
+| `litecoin_transaction_lifecycle` | `e11_ltc_mempool_lifecycle/` |
+| `bitcoin_block_composition` | `e8_btc_block_composition/` |
+| `collection_runs` | `e0_run_manifest/` |
+
+</details>