Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,3 +1,64 @@
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
---
|
| 4 |
+
|
| 5 |
+
> **Languages:** [简体中文](README_ZH.md) · [English](README.md)
|
| 6 |
+
|
| 7 |
+
# dojo_fin_indicators — Financial Metrics
|
| 8 |
+
|
| 9 |
+
## Overview
|
| 10 |
+
|
| 11 |
+
Multi-period **financial statement derivatives** per symbol: income statement, balance sheet, cash flow, and industry-specific metrics (banks, insurers, brokers, etc.). Supports quarterly, cumulative, and other `report_type` values.
|
| 12 |
+
|
| 13 |
+
## Role in AlphaDojo
|
| 14 |
+
|
| 15 |
+
- **`FundamentalStore`**:
|
| 16 |
+
- `fin_indicators()` — metric time series by symbol
|
| 17 |
+
- `rolling_ttm_net_profit()` / `rolling_ttm_eps()` — rolling TTM math
|
| 18 |
+
- **DojoCore:** Financial metrics panel, ROE / margin / leverage charts.
|
| 19 |
+
- **DojoCore P/E band:** `latest_eps_ttm()` with bars and shares for historical P/E.
|
| 20 |
+
- **DojoAgent:** Valuation, profitability, high-dividend screens, etc.
|
| 21 |
+
|
| 22 |
+
## Files
|
| 23 |
+
|
| 24 |
+
| File | Description |
|
| 25 |
+
|------|-------------|
|
| 26 |
+
| `data.parquet` | Full financial metrics (wide table, 100+ columns) |
|
| 27 |
+
|
| 28 |
+
## Key Fields (common)
|
| 29 |
+
|
| 30 |
+
| Field | Description |
|
| 31 |
+
|-------|-------------|
|
| 32 |
+
| `symbol` | Stock symbol |
|
| 33 |
+
| `report_type` | e.g. `quarter`, `accumulate` |
|
| 34 |
+
| `report_date` / `std_report_date` | Report period / normalized period |
|
| 35 |
+
| `public_date` | Disclosure date (default API sort key) |
|
| 36 |
+
| `report_period_name` | Period label (e.g. “Q1 2026”) |
|
| 37 |
+
| `security_name` | Company name |
|
| 38 |
+
| `currency` | Report currency |
|
| 39 |
+
| `eps_basic` / `eps_diluted` / `eps_ttm` | EPS metrics |
|
| 40 |
+
| `net_profit_attr_parent` | Net profit attributable to parent |
|
| 41 |
+
| `total_operating_revenue` | Total operating revenue |
|
| 42 |
+
| `gross_margin` / `net_margin` / `roe_weighted` | Margins and ROE |
|
| 43 |
+
| `debt_asset_ratio` / `current_ratio` / `quick_ratio` | Leverage and liquidity |
|
| 44 |
+
| `pe_ttm` / `pb_ttm` | Period TTM valuation (when present) |
|
| 45 |
+
| `dividend_rate` / `divi_ratio` | Dividend-related fields |
|
| 46 |
+
|
| 47 |
+
Many columns are filled selectively by `org_type` (general / bank / insurance / broker).
|
| 48 |
+
|
| 49 |
+
## Scale (reference)
|
| 50 |
+
|
| 51 |
+
~**278k** rows (symbol × period × report type).
|
| 52 |
+
|
| 53 |
+
## API Behavior
|
| 54 |
+
|
| 55 |
+
- Default: most recent N periods by `_disclosure_date` (`report_date` or `std_report_date`), descending.
|
| 56 |
+
- Period parsing for CN/HK/US: `core/fin_period.py`.
|
| 57 |
+
- `report_type=quarter` used for TTM rolling sums.
|
| 58 |
+
|
| 59 |
+
## Related Datasets
|
| 60 |
+
|
| 61 |
+
- [dojo_main_income](https://huggingface.co/datasets/AlphaDojo/dojo_main_income) — revenue breakdown
|
| 62 |
+
- [dojo_quote](https://huggingface.co/datasets/AlphaDojo/dojo_quote) — market cap and dynamic P/E
|
| 63 |
+
- [dojo_stock_kline](https://huggingface.co/datasets/AlphaDojo/dojo_stock_kline) — P/E band
|
| 64 |
+
- [dojo_forex_kline](https://huggingface.co/datasets/AlphaDojo/dojo_forex_kline) — planned FX conversion for cross-currency reports
|