Update README.md

README.md

@@ -122,3 +122,33 @@ configs:
   - split: test
     path: data/test-*
 ---
+
+# US Stock News With Price
+>  A stock news and price dataset design for the alignment between financial news and the market. **Please only use for academic purpose.**
+
+## 1.  Data Description
+* **date**: The date of the news published.
+* **stock**: The symbol of the stocks the news related to. (checked by whether title or content has the company information.
+* **title**:  The title of the news.
+* **content**: The content of the news.
+* **trading_date**: Here is the assumed trading date, which should be the next date of the publish date.
+* **exact_trading_date**: The exact next trading date after the news was made public.
+* **ts_{-30...-1}**: Stock prices before the exact trading date. (30 trading days)
+* **ts_0**: Stock prices of the exact trading date.
+* **ts_{1...15}**: Stock prices after the exact trading date. (15trading days)
+
+## 2.Data Split
+* **Train phrase**: `exact_trading_date` < = '2021-12-31'.
+* **Test phrase**: `exact_trading_date` > '2021-12-31'.
+
+## 3. Citation
+* To cite this dataset, please use the following BibTeX entry:
+``` 
+@misc{wang2024huggingface,
+    author       = {Guoxuan Wang},
+    title        = {US Stock News With Price: A stock news and price dataset design for the alignment between financial news and the market.},
+    year         = {2024},
+    url          = {https://huggingface.co/datasets/oliverwang15/us_stock_news_with_price},
+    note         = {Available at Hugging Face.}
+  }
+  ```