Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,3 +1,62 @@
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
---
|
| 4 |
+
|
| 5 |
+
# dojo_event_remind — Corporate Events
|
| 6 |
+
|
| 7 |
+
## Overview
|
| 8 |
+
|
| 9 |
+
**Corporate events and disclosure schedules** per symbol: earnings pre-announcements, dividends, shareholder meetings, lock-up expiries, etc. Powers the DojoCore events timeline.
|
| 10 |
+
|
| 11 |
+
## Role in AlphaDojo
|
| 12 |
+
|
| 13 |
+
- **`NewsEventStore.events()`** (`core/stores/news_event_store.py`) filters by symbol, sorts by `notice_date` descending, paginates.
|
| 14 |
+
- **DojoCore:** Events / calendar tab on ticker detail.
|
| 15 |
+
- **DojoAgent:** Earnings dates and important corporate schedules.
|
| 16 |
+
|
| 17 |
+
## Files
|
| 18 |
+
|
| 19 |
+
| File | Description |
|
| 20 |
+
|------|-------------|
|
| 21 |
+
| `data.parquet` | Full event records |
|
| 22 |
+
|
| 23 |
+
## Key Fields
|
| 24 |
+
|
| 25 |
+
| Field | Description |
|
| 26 |
+
|-------|-------------|
|
| 27 |
+
| `symbol` | Stock symbol |
|
| 28 |
+
| `event_type` | Event category (e.g. filing disclosure) |
|
| 29 |
+
| `specific_eventtype` | Specific type (e.g. Q1 pre-disclosure) |
|
| 30 |
+
| `notice_date` | Event / reminder date (`YYYY-MM-DD`) |
|
| 31 |
+
| `level1_content` | Primary description (main display text) |
|
| 32 |
+
| `level2_content` | Secondary detail |
|
| 33 |
+
| `info_code` | Internal info code |
|
| 34 |
+
| `ios_url` / `android_url` | Mobile deep links (if any) |
|
| 35 |
+
|
| 36 |
+
## Scale (reference)
|
| 37 |
+
|
| 38 |
+
~**490k** rows.
|
| 39 |
+
|
| 40 |
+
## API Response Shape
|
| 41 |
+
|
| 42 |
+
```json
|
| 43 |
+
{
|
| 44 |
+
"event_type": "报表披露",
|
| 45 |
+
"title": "一季报预披露",
|
| 46 |
+
"event_date": "2026-06-19",
|
| 47 |
+
"description": "..."
|
| 48 |
+
}
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
`title` prefers `specific_eventtype`, else falls back to `level1_content`.
|
| 52 |
+
|
| 53 |
+
## Related Datasets
|
| 54 |
+
|
| 55 |
+
- [dojo_stock_info](https://huggingface.co/datasets/AlphaDojo/dojo_stock_info) — ticker resolution
|
| 56 |
+
- [dojo_stock_news](https://huggingface.co/datasets/AlphaDojo/dojo_stock_news) — news flow
|
| 57 |
+
- [dojo_fin_indicators](https://huggingface.co/datasets/AlphaDojo/dojo_fin_indicators) — actual financials after filing
|
| 58 |
+
|
| 59 |
+
## Notes
|
| 60 |
+
|
| 61 |
+
- Pre-disclosure dates are **estimates**; actual dates follow company announcements (as noted in source descriptions).
|
| 62 |
+
- Covers CN, HK, and US with market-specific event types and wording.
|