dataforge-labs commited on
Commit
950eaee
·
verified ·
1 Parent(s): abba3a4

Use descriptive dataset table names and update loading examples

Browse files
Files changed (1) hide show
  1. README.md +30 -8
README.md CHANGED
@@ -13,6 +13,16 @@ task_categories:
13
  - time-series-forecasting
14
  size_categories:
15
  - 100K<n<1M
 
 
 
 
 
 
 
 
 
 
16
  ---
17
 
18
  # L2 sequencer preconfirmation observations
@@ -23,7 +33,7 @@ Periodic observations of unsafe and safe heads on selected OP Stack networks, wi
23
 
24
  | Table | Record |
25
  |---|---|
26
- | `e14_l2_preconf` | A heartbeat with head and check statistics, or a detected violation |
27
 
28
  ## Using the data
29
 
@@ -47,20 +57,32 @@ Data is stored as Parquet files under `dataset/YYYY/MM/`, with partitions for co
47
 
48
  ### Load a table
49
 
 
 
50
  ```python
51
- from huggingface_hub import snapshot_download
52
- import pandas as pd, glob
53
 
54
- path = snapshot_download("dataforge-labs/l2-preconfirmation-reliability", repo_type="dataset",
55
- allow_patterns="e14_l2_preconf/**")
56
- df = pd.concat(map(pd.read_parquet,
57
- glob.glob(f"{path}/e14_l2_preconf/**/*.parquet", recursive=True)))
58
  ```
59
 
60
  ## Coverage
61
 
62
- `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.
63
 
64
  ## License and contact
65
 
66
  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.
 
 
 
 
 
 
 
 
 
 
 
 
 
13
  - time-series-forecasting
14
  size_categories:
15
  - 100K<n<1M
16
+ configs:
17
+ - config_name: l2_preconfirmation_checks
18
+ data_files:
19
+ - split: train
20
+ path: e14_l2_preconf/**/*.parquet
21
+ default: true
22
+ - config_name: collection_runs
23
+ data_files:
24
+ - split: train
25
+ path: e0_run_manifest/**/*.parquet
26
  ---
27
 
28
  # L2 sequencer preconfirmation observations
 
33
 
34
  | Table | Record |
35
  |---|---|
36
+ | `l2_preconfirmation_checks` | A heartbeat with head and check statistics, or a detected violation |
37
 
38
  ## Using the data
39
 
 
57
 
58
  ### Load a table
59
 
60
+ 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.
61
+
62
  ```python
63
+ from datasets import load_dataset
 
64
 
65
+ data = load_dataset("dataforge-labs/l2-preconfirmation-reliability",
66
+ "l2_preconfirmation_checks", split="train")
67
+ df = data.to_pandas()
 
68
  ```
69
 
70
  ## Coverage
71
 
72
+ `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.
73
 
74
  ## License and contact
75
 
76
  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.
77
+
78
+ <details>
79
+ <summary>File paths and compatibility</summary>
80
+
81
+ 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.
82
+
83
+ | Table name | Storage directory |
84
+ |---|---|
85
+ | `l2_preconfirmation_checks` | `e14_l2_preconf/` |
86
+ | `collection_runs` | `e0_run_manifest/` |
87
+
88
+ </details>