Upload README.md with huggingface_hub

README.md

@@ -8,16 +8,7 @@ license: apache-2.0
 
 ## Overview
 
-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.
-
-## Role in AlphaDojo
-
-- **`FundamentalStore`**:
-  - `fin_indicators()` — metric time series by symbol
-  - `rolling_ttm_net_profit()` / `rolling_ttm_eps()` — rolling TTM math
-- **DojoCore:** Financial metrics panel, ROE / margin / leverage charts.
-- **DojoCore P/E band:** `latest_eps_ttm()` with bars and shares for historical P/E.
-- **DojoAgent:** Valuation, profitability, high-dividend screens, etc.
+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.
 
 ## Files
 
@@ -32,7 +23,7 @@ Multi-period **financial statement derivatives** per symbol: income statement, b
 | `symbol` | Stock symbol |
 | `report_type` | e.g. `quarter`, `accumulate` |
 | `report_date` / `std_report_date` | Report period / normalized period |
-| `public_date` | Disclosure date (default API sort key) |
+| `public_date` | Disclosure date |
 | `report_period_name` | Period label (e.g. “Q1 2026”) |
 | `security_name` | Company name |
 | `currency` | Report currency |
@@ -43,22 +34,21 @@ Multi-period **financial statement derivatives** per symbol: income statement, b
 | `debt_asset_ratio` / `current_ratio` / `quick_ratio` | Leverage and liquidity |
 | `pe_ttm` / `pb_ttm` | Period TTM valuation (when present) |
 | `dividend_rate` / `divi_ratio` | Dividend-related fields |
-
-Many columns are filled selectively by `org_type` (general / bank / insurance / broker).
+| `org_type` | Entity type (general / bank / insurance / broker); many columns are filled selectively |
 
 ## Scale (reference)
 
 ~**278k** rows (symbol × period × report type).
 
-## API Behavior
+## Data Notes
 
-- Default: most recent N periods by `_disclosure_date` (`report_date` or `std_report_date`), descending.
-- Period parsing for CN/HK/US: `core/fin_period.py`.
-- `report_type=quarter` used for TTM rolling sums.
+- Multiple rows per symbol across `report_type` and `report_date`; use `public_date` or `report_date` for chronological ordering.
+- `report_type = quarter` rows support trailing-four-quarter (TTM) aggregation.
+- Report period conventions differ by market (`us`, `cn`, `hk`); prefer `std_report_date` when present for cross-market comparison.
 
 ## Related Datasets
 
-- [dojo_main_income](https://huggingface.co/datasets/AlphaDojo/dojo_main_income) — revenue breakdown
-- [dojo_quote](https://huggingface.co/datasets/AlphaDojo/dojo_quote) — market cap and dynamic P/E
-- [dojo_stock_kline](https://huggingface.co/datasets/AlphaDojo/dojo_stock_kline) — P/E band
-- [dojo_forex_kline](https://huggingface.co/datasets/AlphaDojo/dojo_forex_kline) — planned FX conversion for cross-currency reports
+- [dojo_main_income](https://huggingface.co/datasets/AlphaDojo/dojo_main_income) — revenue breakdown for the same periods
+- [dojo_quote](https://huggingface.co/datasets/AlphaDojo/dojo_quote) — market cap and market-based valuation
+- [dojo_stock_kline](https://huggingface.co/datasets/AlphaDojo/dojo_stock_kline) — price history
+- [dojo_forex_kline](https://huggingface.co/datasets/AlphaDojo/dojo_forex_kline) — FX rates when report currency differs from analysis currency