VGalaxies666 commited on
Commit
dd30b4e
·
verified ·
1 Parent(s): 3aa3a8d

Rewrite dataset card in English

Browse files
Files changed (1) hide show
  1. README.md +82 -47
README.md CHANGED
@@ -2,75 +2,110 @@
2
  license: other
3
  task_categories:
4
  - time-series-forecasting
 
 
 
 
 
 
 
5
  tags:
6
  - time-series
 
 
 
7
  - tsfile
 
 
 
 
 
 
 
8
  pretty_name: walmart (TsFile format)
 
 
 
 
 
9
  ---
10
 
11
- # walmart TsFile 格式
12
 
13
- 本目录是 [`autogluon/fev_datasets`](https://huggingface.co/datasets/autogluon/fev_datasets) **walmart** 子集转换为 [Apache TsFile](https://tsfile.apache.org/) 格式的版本。
14
 
15
- ## 来源与引用
16
 
17
- - **原始来源**:https://www.kaggle.com/competitions/walmart-recruiting-store-sales-forecasting
18
- - **论文/引用**:[[24]](https://www.kaggle.com/competitions/walmart-recruiting-store-sales-forecasting/overview/citation)
19
- - **统一格式合集**:[autogluon/fev_datasets](https://huggingface.co/datasets/autogluon/fev_datasets)
 
 
 
 
 
 
 
20
 
21
- > 本数据由外部来源转换为统一格式后再转为 TsFile。许可与引用以**原始来源**为准,我们不对原始数据主张任何权利。除非另有说明,数据仅供研究用途。
22
 
23
- ## 数据统计
24
 
25
- | 序列数 | 中位长度 | 观测点数 | 动态列 | 静态列 | 文件 |
26
- |---|---|---|---|---|---|
27
  | 2,936 | 143 | 4,609,143 | 11 | 4 | `walmart.tsfile` |
28
 
29
- ## TsFile 存储模型
30
 
31
- - 每条原始序列(`id`)→ 一个 **device**(TAG 维度)。
32
- - 静态协变量列 → 也作 **TAG**(device 元数据):`Store, Dept, Type, Size`。
33
- - 随时间变化的 target / 动态协变量 → **measurement**(FIELD)。
34
- - `timestamp` → `Time`(INT64 毫秒)。
35
- - 表名:walmart。
36
 
37
- ### 列含义
38
 
39
- | 列 | 角色 | TsFile 类型 |
 
 
 
 
 
 
 
 
 
 
40
  |---|---|---|
41
- | `Time` | Time(时间列) | INT64 |
42
- | `id` | TAGdevice 维度) | STRING |
43
- | `Store` | TAGdevice 维度) | DOUBLE |
44
- | `Dept` | TAGdevice 维度) | DOUBLE |
45
- | `Type` | TAGdevice 维度) | STRING |
46
- | `Size` | TAGdevice 维度) | DOUBLE |
47
- | `target` | FIELDmeasurement | FLOAT |
48
- | `IsHoliday` | FIELDmeasurement | FLOAT |
49
- | `Temperature` | FIELDmeasurement | FLOAT |
50
- | `Fuel_Price` | FIELDmeasurement | FLOAT |
51
- | `MarkDown1` | FIELDmeasurement | FLOAT |
52
- | `MarkDown2` | FIELDmeasurement | FLOAT |
53
- | `MarkDown3` | FIELDmeasurement | FLOAT |
54
- | `MarkDown4` | FIELDmeasurement | FLOAT |
55
- | `MarkDown5` | FIELDmeasurement | FLOAT |
56
- | `CPI` | FIELDmeasurement | FLOAT |
57
- | `Unemployment` | FIELDmeasurement | FLOAT |
58
-
59
- > 注:有 2936 个原始 id 含非法标识符字符,已规范化为合法 device 名(如 10_1→_10_1, 10_10→_10_10, 10_11→_10_11)。
60
-
61
- ## 转换说明
62
-
63
- - 每行原始数据是一整条序列 `(id, timestamp[], target[])`,纵向打平为长表后写入 TsFile。
64
- - 数值类型按源列自适应:float32→FLOAT、float64→DOUBLE、整数→INT64、bool→BOOLEAN。
65
- - 时间精度:毫秒(INT64)。
66
- - 大表会被工具自动分片为 `<>_1.tsfile``<>_2.tsfile` …,同属一个逻辑表。
67
-
68
- ## 读取示例
69
 
70
  ```python
71
  from tsfile import TsFileReader
72
 
73
  reader = TsFileReader("walmart.tsfile")
74
  schemas = reader.get_all_table_schemas()
75
- # 表名:walmart;列见下方"列含义"。
76
  ```
 
2
  license: other
3
  task_categories:
4
  - time-series-forecasting
5
+ task_ids:
6
+ - univariate-time-series-forecasting
7
+ - multivariate-time-series-forecasting
8
+ annotations_creators:
9
+ - no-annotation
10
+ source_datasets:
11
+ - original
12
  tags:
13
  - time-series
14
+ - forecasting
15
+ - benchmark
16
+ - fev
17
  - tsfile
18
+ - apache-tsfile
19
+ - modality:timeseries
20
+ - Time-series
21
+ - format:tsfile
22
+ - arxiv:2509.26468
23
+ size_categories:
24
+ - 100K<n<1M
25
  pretty_name: walmart (TsFile format)
26
+ configs:
27
+ - config_name: default
28
+ data_files:
29
+ - split: train
30
+ path: "**/*.tsfile"
31
  ---
32
 
33
+ # walmart (TsFile format)
34
 
35
+ This repository contains time-series forecasting data stored in [Apache TsFile](https://tsfile.apache.org/) format.
36
 
37
+ ## Summary
38
 
39
+ - FEV subset: `walmart`
40
+ - Unified source collection: [`autogluon/fev_datasets`](https://huggingface.co/datasets/autogluon/fev_datasets)
41
+ - Original source: https://www.kaggle.com/competitions/walmart-recruiting-store-sales-forecasting
42
+ - Paper / citation: [[24]](https://www.kaggle.com/competitions/walmart-recruiting-store-sales-forecasting/overview/citation)
43
+ - Series: 2,936
44
+ - Modalities: Time-series
45
+ - TsFile rows (flattened observations): 4,609,143
46
+ - Frequencies: source-defined
47
+ - TsFile files: 1
48
+ - Time precision: milliseconds (`INT64`).
49
 
50
+ Licensing and citation requirements follow the original source. This repository does not claim ownership of the original data.
51
 
52
+ ## Dataset Statistics
53
 
54
+ | Series | Median series length | TsFile rows (observations) | Dynamic columns | Static columns | Data files |
55
+ |---:|---:|---:|---:|---:|---|
56
  | 2,936 | 143 | 4,609,143 | 11 | 4 | `walmart.tsfile` |
57
 
58
+ ## Files
59
 
60
+ The Hugging Face dataset card YAML points `configs.data_files` to all `*.tsfile` files in this repository.
 
 
 
 
61
 
62
+ - `walmart.tsfile`
63
 
64
+ ## TsFile Storage Model
65
+
66
+ - Each original series (`id`) is stored as one TsFile device.
67
+ - Static covariate columns are stored as TAG columns: `Store, Dept, Type, Size`.
68
+ - Time-varying targets and dynamic covariates are stored as FIELD measurements.
69
+ - Source `timestamp` values are mapped to the TsFile `Time` column as millisecond timestamps.
70
+ - Table name(s): walmart.
71
+
72
+ ### Column Schema
73
+
74
+ | Column | Role | TsFile type |
75
  |---|---|---|
76
+ | `Time` | Time column | INT64 |
77
+ | `id` | TAG (device dimension) | STRING |
78
+ | `Store` | TAG (device dimension) | DOUBLE |
79
+ | `Dept` | TAG (device dimension) | DOUBLE |
80
+ | `Type` | TAG (device dimension) | STRING |
81
+ | `Size` | TAG (device dimension) | DOUBLE |
82
+ | `target` | FIELD (measurement) | FLOAT |
83
+ | `IsHoliday` | FIELD (measurement) | FLOAT |
84
+ | `Temperature` | FIELD (measurement) | FLOAT |
85
+ | `Fuel_Price` | FIELD (measurement) | FLOAT |
86
+ | `MarkDown1` | FIELD (measurement) | FLOAT |
87
+ | `MarkDown2` | FIELD (measurement) | FLOAT |
88
+ | `MarkDown3` | FIELD (measurement) | FLOAT |
89
+ | `MarkDown4` | FIELD (measurement) | FLOAT |
90
+ | `MarkDown5` | FIELD (measurement) | FLOAT |
91
+ | `CPI` | FIELD (measurement) | FLOAT |
92
+ | `Unemployment` | FIELD (measurement) | FLOAT |
93
+
94
+ > Note: 2936 original `id` values contained invalid identifier characters and were normalized to valid device names, for example 10_1→_10_1, 10_10→_10_10, 10_11→_10_11.
95
+
96
+ ## Conversion Notes
97
+
98
+ - The source FEV format stores each time series as one nested row containing `id`, `timestamp[]`, and target or covariate arrays.
99
+ - The TsFile conversion flattens those nested arrays into long rows. Therefore, the `TsFile rows` values above correspond to the number of timestamped observations after flattening.
100
+ - TAG columns identify the device and static metadata. FIELD columns contain values that change over time.
101
+ - Large logical tables may be split into multiple `.tsfile` shards such as `<name>_1.tsfile`, `<name>_2.tsfile`, and so on. Shards listed for the same frequency belong to the same logical table.
102
+
103
+ ## Reading Example
104
 
105
  ```python
106
  from tsfile import TsFileReader
107
 
108
  reader = TsFileReader("walmart.tsfile")
109
  schemas = reader.get_all_table_schemas()
110
+ # Table name(s): walmart
111
  ```