Rewrite dataset card in English

README.md

@@ -2,62 +2,99 @@
 license: other
 task_categories:
 - time-series-forecasting
+task_ids:
+- univariate-time-series-forecasting
+- multivariate-time-series-forecasting
+annotations_creators:
+- no-annotation
+source_datasets:
+- original
 tags:
 - time-series
+- forecasting
+- benchmark
+- fev
 - tsfile
+- apache-tsfile
+- modality:timeseries
+- Time-series
+- format:tsfile
+- arxiv:2509.26468
+size_categories:
+- 100K<n<1M
 pretty_name: us_consumption (TsFile format)
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: "**/*.tsfile"
 ---
 
-# us_consumption — TsFile 格式
+# us_consumption (TsFile format)
 
-本目录是 [`autogluon/fev_datasets`](https://huggingface.co/datasets/autogluon/fev_datasets) 中 **us_consumption** 子集转换为 [Apache TsFile](https://tsfile.apache.org/) 格式的版本。
+This repository contains time-series forecasting data stored in [Apache TsFile](https://tsfile.apache.org/) format.
 
-## 来源与引用
+## Summary
 
-- **原始来源**：https://apps.bea.gov/iTable/?reqid=19&step=3&isuri=1&nipa_table_list=2017&categories=underlying
-- **论文/引用**：[[23]](https://doi.org/10.1016/j.ijforecast.2016.04.005)
-- **统一格式合集**：[autogluon/fev_datasets](https://huggingface.co/datasets/autogluon/fev_datasets)
+- FEV subset: `us_consumption`
+- Unified source collection: [`autogluon/fev_datasets`](https://huggingface.co/datasets/autogluon/fev_datasets)
+- Original source: https://apps.bea.gov/iTable/?reqid=19&step=3&isuri=1&nipa_table_list=2017&categories=underlying
+- Paper / citation: [[23]](https://doi.org/10.1016/j.ijforecast.2016.04.005)
+- Series: 31
+- Modalities: Time-series
+- TsFile rows (flattened observations): 34,658
+- Frequencies: 1M, 1Q, 1Y
+- TsFile files: 3
+- Time precision: milliseconds (`INT64`).
 
-> 本数据由外部来源转换为统一格式后再转为 TsFile。许可与引用以**原始来源**为准，我们不对原始数据主张任何权利。除非另有说明，数据仅供研究用途。
+Licensing and citation requirements follow the original source. This repository does not claim ownership of the original data.
 
-## 数据统计
+## Dataset Statistics
 
-| 频率 | 序列数 | 中位长度 | 观测点数 | 动态列 | 静态列 | 文件 |
-|---|---|---|---|---|---|---|
+| Frequency | Series | Median series length | TsFile rows (observations) | Dynamic columns | Static columns | Data files |
+|---|---:|---:|---:|---:|---:|---|
 | 1M | 31 | 792 | 24,552 | 1 | 0 | `1M/1M.tsfile` |
 | 1Q | 31 | 262 | 8,122 | 1 | 0 | `1Q/1Q.tsfile` |
 | 1Y | 31 | 64 | 1,984 | 1 | 0 | `1Y/1Y.tsfile` |
 
-## TsFile 存储模型
+## Files
 
-- 每条原始序列（`id`）→ 一个 **device**（TAG 维度）。
-- 随时间变化的 target / 动态协变量 → **measurement**（FIELD）。
-- `timestamp` → `Time`（INT64 毫秒）。
-- 表名：us_consumption_1M, us_consumption_1Q, us_consumption_1Y。
+The Hugging Face dataset card YAML points `configs.data_files` to all `*.tsfile` files in this repository.
 
-### 列含义
+- `1M/1M.tsfile`
+- `1Q/1Q.tsfile`
+- `1Y/1Y.tsfile`
 
-| 列 | 角色 | TsFile 类型 |
+## TsFile Storage Model
+
+- Each original series (`id`) is stored as one TsFile device.
+- Time-varying targets and dynamic covariates are stored as FIELD measurements.
+- Source `timestamp` values are mapped to the TsFile `Time` column as millisecond timestamps.
+- Table name(s): us_consumption_1M, us_consumption_1Q, us_consumption_1Y.
+
+### Column Schema
+
+| Column | Role | TsFile type |
 |---|---|---|
-| `Time` | Time（时间列） | INT64 |
-| `id` | TAG（device 维度） | STRING |
-| `target` | FIELD（measurement） | FLOAT |
+| `Time` | Time column | INT64 |
+| `id` | TAG (device dimension) | STRING |
+| `target` | FIELD (measurement) | FLOAT |
 
-> 注：有 3 个原始 id 含非法标识符字符，已规范化为合法 device 名（如 food_and_beverages_purchased_for_off-premises_consumption→food_and_beverages_purchased_for_off_premises_consumption, food_and_beverages_purchased_for_off-premises_consumption→food_and_beverages_purchased_for_off_premises_consumption, food_and_beverages_purchased_for_off-premises_consumption→food_and_beverages_purchased_for_off_premises_consumption）。
+> Note: 3 original `id` values contained invalid identifier characters and were normalized to valid device names, for example food_and_beverages_purchased_for_off-premises_consumption→food_and_beverages_purchased_for_off_premises_consumption, food_and_beverages_purchased_for_off-premises_consumption→food_and_beverages_purchased_for_off_premises_consumption, food_and_beverages_purchased_for_off-premises_consumption→food_and_beverages_purchased_for_off_premises_consumption.
 
-## 转换说明
+## Conversion Notes
 
-- 每行原始数据是一整条序列 `(id, timestamp[], 各 target[])`，纵向打平为长表后写入 TsFile。
-- 数值类型按源列自适应：float32→FLOAT、float64→DOUBLE、整数→INT64、bool→BOOLEAN。
-- 时间精度：毫秒（INT64）。
-- 大表会被工具自动分片为 `<名>_1.tsfile`、`<名>_2.tsfile` …，同属一个逻辑表。
+- The source FEV format stores each time series as one nested row containing `id`, `timestamp[]`, and target or covariate arrays.
+- 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.
+- TAG columns identify the device and static metadata. FIELD columns contain values that change over time.
+- 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.
 
-## 读取示例
+## Reading Example
 
 ```python
 from tsfile import TsFileReader
 
 reader = TsFileReader("1M/1M.tsfile")
 schemas = reader.get_all_table_schemas()
-# 表名：us_consumption_1M；列见下方"列含义"。
+# Table name(s): us_consumption_1M, us_consumption_1Q, us_consumption_1Y
 ```