fix: revise the README.md
Browse files
README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
| 1 |
---
|
| 2 |
-
|
|
|
|
|
|
|
| 3 |
task_categories:
|
| 4 |
- time-series-forecasting
|
| 5 |
- text-classification
|
|
@@ -7,48 +9,71 @@ tags:
|
|
| 7 |
- finance
|
| 8 |
- portfolio-management
|
| 9 |
- multi-asset
|
| 10 |
-
- market-data
|
| 11 |
- benchmark
|
| 12 |
-
|
| 13 |
-
-
|
| 14 |
size_categories:
|
| 15 |
- 10M<n<100M
|
| 16 |
---
|
| 17 |
|
| 18 |
-
# PortBench
|
| 19 |
|
| 20 |
## Dataset Description
|
| 21 |
|
| 22 |
-
A ten-year (
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
|
| 27 |
-
|
|
|
|
|
|
|
| 28 |
|
| 29 |
-
|
| 30 |
-
|-------------|-------------|---------|----------|
|
| 31 |
-
| Equities | 126 | Yahoo Finance, Kaggle, SEC | SPY, QQQ, sector ETFs, factor ETFs, international |
|
| 32 |
-
| Commodities | 16 | Yahoo Finance, FRED | GLD, USO, DBA, commodity indices |
|
| 33 |
-
| Bonds | 15 | Yahoo Finance, FRED | Treasury ETFs (SHV→TLT), TIPS, corporate, EM |
|
| 34 |
-
| Cryptocurrency | 12 | Yahoo Finance, Kaggle | BTC, ETH, SOL, XRP, ADA, ... |
|
| 35 |
-
| Real Estate | 10 | Yahoo Finance, FRED | VNQ, IYR, Case-Shiller indices |
|
| 36 |
-
| Cash | 4 | Yahoo Finance, FRED | BIL, SGOV, T-bill rates |
|
| 37 |
|
| 38 |
-
|
| 39 |
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
-
|
| 45 |
-
|
| 46 |
-
-
|
|
|
|
|
|
|
|
|
|
| 47 |
|
| 48 |
### Temporal Coverage
|
| 49 |
|
| 50 |
-
- **Full range**: 2015-01-
|
| 51 |
-
- **
|
| 52 |
-
- **
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 53 |
|
| 54 |
-
|
|
|
|
| 1 |
---
|
| 2 |
+
language:
|
| 3 |
+
- en
|
| 4 |
+
license: apache-2.0
|
| 5 |
task_categories:
|
| 6 |
- time-series-forecasting
|
| 7 |
- text-classification
|
|
|
|
| 9 |
- finance
|
| 10 |
- portfolio-management
|
| 11 |
- multi-asset
|
|
|
|
| 12 |
- benchmark
|
| 13 |
+
- market-data
|
| 14 |
+
- macroeconomics
|
| 15 |
size_categories:
|
| 16 |
- 10M<n<100M
|
| 17 |
---
|
| 18 |
|
| 19 |
+
# PortBench Market Base Dataset
|
| 20 |
|
| 21 |
## Dataset Description
|
| 22 |
|
| 23 |
+
A ten-year (Jan 2015–Dec 2025) daily financial dataset covering **183 instruments** across six heterogeneous asset classes, designed for multi-asset portfolio management research and LLM evaluation.
|
| 24 |
+
|
| 25 |
+
### Asset Coverage
|
| 26 |
+
|
| 27 |
+
| Asset Class | Instruments | Data Fields | Sources |
|
| 28 |
+
|-------------|-------------|-------------|---------|
|
| 29 |
+
| Equities | 126 | OHLCV + return | Yahoo Finance (ETFs: broad market, sector, factor, international) |
|
| 30 |
+
| Bonds | 16 | Close + return (ETFs); yield levels (FRED) | Yahoo Finance, FRED |
|
| 31 |
+
| Commodities | 16 | OHLCV + return | Yahoo Finance, Kaggle (spot prices) |
|
| 32 |
+
| Real Estate | 10 | OHLCV + return (REITs); housing indices (FRED) | Yahoo Finance, FRED |
|
| 33 |
+
| Cryptocurrency | 12 | OHLCV + return | Yahoo Finance, Kaggle (market cap, supply) |
|
| 34 |
+
| Cash | 4 | Close + return (money market ETFs); macro indicators (FRED) | Yahoo Finance, FRED |
|
| 35 |
+
|
| 36 |
+
### Additional Features
|
| 37 |
|
| 38 |
+
- **Macroeconomic indicators** (FRED): Fed funds rate, CPI, unemployment, GDP, yield curve spreads, breakeven inflation, credit spreads, mortgage rates, VIX, and 40+ additional series
|
| 39 |
+
- **News text**: monthly aggregated financial news for equities and cryptocurrency (JSON-encoded columns)
|
| 40 |
+
- **Cross-asset correlation structures**: intra-class and inter-class correlation matrices available as companion artifacts
|
| 41 |
|
| 42 |
+
### Dataset Structure
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 43 |
|
| 44 |
+
Single CSV file with 4,017 rows (trading days) × 1,087 columns.
|
| 45 |
|
| 46 |
+
Column naming convention: `{asset_class}_{ticker}_{field}`
|
| 47 |
+
|
| 48 |
+
```
|
| 49 |
+
date,equities_ACWI_open,equities_ACWI_high,...,bonds_FRED_DGS10,...,cash_FRED_FEDFUNDS,...
|
| 50 |
+
2015-01-02,52.34,52.45,...,2.17,...,0.11,...
|
| 51 |
+
...
|
| 52 |
+
2025-12-31,...
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
Fields per instrument (where applicable): `open`, `high`, `low`, `close`, `volume`, `return`
|
| 56 |
|
| 57 |
### Temporal Coverage
|
| 58 |
|
| 59 |
+
- **Full range**: 2015-01-02 to 2025-12-31
|
| 60 |
+
- **Frequency**: Daily (trading days)
|
| 61 |
+
- **Three stress windows highlighted**: 2015 China Shock (Aug 2015–Feb 2016), 2020 COVID Crash (Feb–May 2020), 2022 Crypto Collapse (May–Dec 2022)
|
| 62 |
+
|
| 63 |
+
### Intended Use
|
| 64 |
+
|
| 65 |
+
This dataset serves as the foundation for PortBench's dual-layer evaluation. It supports:
|
| 66 |
+
- Static QA generation for financial reasoning tasks
|
| 67 |
+
- Dynamic five-stage pipeline evaluation with realistic market replay
|
| 68 |
+
- Stress testing under historical crisis regimes
|
| 69 |
+
- Cross-asset correlation analysis and portfolio optimization research
|
| 70 |
+
|
| 71 |
+
### Point-in-Time (PiT) Constraint
|
| 72 |
+
|
| 73 |
+
All features strictly respect temporal integrity — no look-ahead bias. Any derived feature uses only information available at or before the corresponding date.
|
| 74 |
+
|
| 75 |
+
### Citation
|
| 76 |
+
|
| 77 |
+
```bibtex
|
| 78 |
|
| 79 |
+
```
|