Rewrite dataset card in English
Browse files
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
|
| 12 |
|
| 13 |
-
|
| 14 |
|
| 15 |
-
##
|
| 16 |
|
| 17 |
-
-
|
| 18 |
-
-
|
| 19 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 20 |
|
| 21 |
-
|
| 22 |
|
| 23 |
-
##
|
| 24 |
|
| 25 |
-
|
|
| 26 |
-
|---|---|---|---|---|---|
|
| 27 |
| 2,936 | 143 | 4,609,143 | 11 | 4 | `walmart.tsfile` |
|
| 28 |
|
| 29 |
-
##
|
| 30 |
|
| 31 |
-
|
| 32 |
-
- 静态协变量列 → 也作 **TAG**(device 元数据):`Store, Dept, Type, Size`。
|
| 33 |
-
- 随时间变化的 target / 动态协变量 → **measurement**(FIELD)。
|
| 34 |
-
- `timestamp` → `Time`(INT64 毫秒)。
|
| 35 |
-
- 表名:walmart。
|
| 36 |
|
| 37 |
-
|
| 38 |
|
| 39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 40 |
|---|---|---|
|
| 41 |
-
| `Time` | Time
|
| 42 |
-
| `id` | TAG
|
| 43 |
-
| `Store` | TAG
|
| 44 |
-
| `Dept` | TAG
|
| 45 |
-
| `Type` | TAG
|
| 46 |
-
| `Size` | TAG
|
| 47 |
-
| `target` | FIELD
|
| 48 |
-
| `IsHoliday` | FIELD
|
| 49 |
-
| `Temperature` | FIELD
|
| 50 |
-
| `Fuel_Price` | FIELD
|
| 51 |
-
| `MarkDown1` | FIELD
|
| 52 |
-
| `MarkDown2` | FIELD
|
| 53 |
-
| `MarkDown3` | FIELD
|
| 54 |
-
| `MarkDown4` | FIELD
|
| 55 |
-
| `MarkDown5` | FIELD
|
| 56 |
-
| `CPI` | FIELD
|
| 57 |
-
| `Unemployment` | FIELD
|
| 58 |
-
|
| 59 |
-
>
|
| 60 |
-
|
| 61 |
-
##
|
| 62 |
-
|
| 63 |
-
-
|
| 64 |
-
-
|
| 65 |
-
-
|
| 66 |
-
-
|
| 67 |
-
|
| 68 |
-
##
|
| 69 |
|
| 70 |
```python
|
| 71 |
from tsfile import TsFileReader
|
| 72 |
|
| 73 |
reader = TsFileReader("walmart.tsfile")
|
| 74 |
schemas = reader.get_all_table_schemas()
|
| 75 |
-
#
|
| 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 |
```
|