dataforge-labs commited on
Commit
a727128
·
verified ·
1 Parent(s): 781012a

Use descriptive dataset table names and update loading examples

Browse files
Files changed (1) hide show
  1. README.md +36 -9
README.md CHANGED
@@ -14,6 +14,20 @@ task_categories:
14
  - time-series-forecasting
15
  size_categories:
16
  - 1M<n<10M
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  ---
18
 
19
  # Solana DEX quotes and routing
@@ -24,8 +38,8 @@ Jupiter swap quotes at fixed SOL input sizes, with the route legs returned for e
24
 
25
  | Table | Record |
26
  |---|---|
27
- | `e24_solana_quotes` | A pair and input amount, with quoted output, price impact, value and route-leg count |
28
- | `e24_solana_routes` | A leg of the chosen route, including venue, amounts and allocation |
29
 
30
  ## Using the data
31
 
@@ -47,20 +61,33 @@ 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/solana-dex-execution", repo_type="dataset",
55
- allow_patterns="e24_solana_quotes/**")
56
- df = pd.concat(map(pd.read_parquet,
57
- glob.glob(f"{path}/e24_solana_quotes/**/*.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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  - time-series-forecasting
15
  size_categories:
16
  - 1M<n<10M
17
+ configs:
18
+ - config_name: solana_swap_quotes
19
+ data_files:
20
+ - split: train
21
+ path: e24_solana_quotes/**/*.parquet
22
+ default: true
23
+ - config_name: solana_swap_routes
24
+ data_files:
25
+ - split: train
26
+ path: e24_solana_routes/**/*.parquet
27
+ - config_name: collection_runs
28
+ data_files:
29
+ - split: train
30
+ path: e0_run_manifest/**/*.parquet
31
  ---
32
 
33
  # Solana DEX quotes and routing
 
38
 
39
  | Table | Record |
40
  |---|---|
41
+ | `solana_swap_quotes` | A pair and input amount, with quoted output, price impact, value and route-leg count |
42
+ | `solana_swap_routes` | A leg of the chosen route, including venue, amounts and allocation |
43
 
44
  ## Using the data
45
 
 
61
 
62
  ### Load a table
63
 
64
+ 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.
65
+
66
  ```python
67
+ from datasets import load_dataset
 
68
 
69
+ data = load_dataset("dataforge-labs/solana-dex-execution",
70
+ "solana_swap_quotes", split="train")
71
+ df = data.to_pandas()
 
72
  ```
73
 
74
  ## Coverage
75
 
76
+ `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.
77
 
78
  ## License and contact
79
 
80
  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.
81
+
82
+ <details>
83
+ <summary>File paths and compatibility</summary>
84
+
85
+ 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.
86
+
87
+ | Table name | Storage directory |
88
+ |---|---|
89
+ | `solana_swap_quotes` | `e24_solana_quotes/` |
90
+ | `solana_swap_routes` | `e24_solana_routes/` |
91
+ | `collection_runs` | `e0_run_manifest/` |
92
+
93
+ </details>