Hugging Face's logo

Datasets:
AlphaDojo
/
dojo_event_remind

Modalities:
Text
Formats:
parquet
Size:
100K - 1M
Libraries:
Datasets
pandas
Polars
License:
Dataset card Data Studio Files
xet
 Community
1
futurefeader commited on
Commit
0476098
·
verified ·
1 Parent(s): 2422596

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +11 -17
README.md CHANGED
@@ -8,13 +8,7 @@ license: apache-2.0
8
 
9
  ## Overview
10
 
11
- **Corporate events and disclosure schedules** per symbol: earnings pre-announcements, dividends, shareholder meetings, lock-up expiries, etc. Powers the DojoCore events timeline.
12
-
13
- ## Role in AlphaDojo
14
-
15
- - **`NewsEventStore.events()`** filters by symbol, sorts by `notice_date` descending, paginates.
16
- - **DojoCore:** Events / calendar tab on ticker detail.
17
- - **DojoAgent:** Earnings dates and important corporate schedules.
18
 
19
  ## Files
20
 
@@ -30,7 +24,7 @@ license: apache-2.0
30
  | `event_type` | Event category (e.g. filing disclosure) |
31
  | `specific_eventtype` | Specific type (e.g. Q1 pre-disclosure) |
32
  | `notice_date` | Event / reminder date (`YYYY-MM-DD`) |
33
- | `level1_content` | Primary description (main display text) |
34
  | `level2_content` | Secondary detail |
35
  | `info_code` | Internal info code |
36
  | `ios_url` / `android_url` | Mobile deep links (if any) |
@@ -39,7 +33,7 @@ license: apache-2.0
39
 
40
  ~**490k** rows.
41
 
42
- ## API Response Shape
43
 
44
  ```json
45
  {
@@ -50,15 +44,15 @@ license: apache-2.0
50
  }
51
  ```
52
 
53
- `title` prefers `specific_eventtype`, else falls back to `level1_content`.
54
 
55
- ## Related Datasets
56
 
57
- - [dojo_stock_info](https://huggingface.co/datasets/AlphaDojo/dojo_stock_info) — ticker resolution
58
- - [dojo_stock_news](https://huggingface.co/datasets/AlphaDojo/dojo_stock_news) — news flow
59
- - [dojo_fin_indicators](https://huggingface.co/datasets/AlphaDojo/dojo_fin_indicators) — actual financials after filing
60
 
61
- ## Notes
62
 
63
- - Pre-disclosure dates are **estimates**; actual dates follow company announcements (as noted in source descriptions).
64
- - Covers CN, HK, and US with market-specific event types and wording.
 
 
8
 
9
  ## Overview
10
 
11
+ Corporate events and disclosure schedules per symbol: earnings pre-announcements, dividends, shareholder meetings, lock-up expiries, and similar items.
 
 
 
 
 
 
12
 
13
  ## Files
14
 
 
24
  | `event_type` | Event category (e.g. filing disclosure) |
25
  | `specific_eventtype` | Specific type (e.g. Q1 pre-disclosure) |
26
  | `notice_date` | Event / reminder date (`YYYY-MM-DD`) |
27
+ | `level1_content` | Primary description |
28
  | `level2_content` | Secondary detail |
29
  | `info_code` | Internal info code |
30
  | `ios_url` / `android_url` | Mobile deep links (if any) |
 
33
 
34
  ~**490k** rows.
35
 
36
+ ## Record Example
37
 
38
  ```json
39
  {
 
44
  }
45
  ```
46
 
47
+ Display title typically maps from `specific_eventtype`, with `level1_content` as fallback.
48
 
49
+ ## Data Notes
50
 
51
+ - Pre-disclosure dates are **estimates**; actual dates follow company announcements.
52
+ - Covers CN, HK, and US with market-specific event types and wording.
 
53
 
54
+ ## Related Datasets
55
 
56
+ - [dojo_stock_info](https://huggingface.co/datasets/AlphaDojo/dojo_stock_info) — ticker metadata
57
+ - [dojo_stock_news](https://huggingface.co/datasets/AlphaDojo/dojo_stock_news) — news flow
58
+ - [dojo_fin_indicators](https://huggingface.co/datasets/AlphaDojo/dojo_fin_indicators) — financials after actual filing