Update README.md

README.md

@@ -58,3 +58,50 @@ configs:
   - split: train
     path: data/train-*
 ---
+
+# Stock Metrics Dataset
+
+This dataset contains daily financial metrics and indicators for selected stocks (AMD, INTC) from 2023-01-01 to 2023-12-31. The dataset combines various financial metrics including earnings data, technical indicators, and market yields.
+
+## Features
+
+### Stock-specific Metrics
+- `date`: Trading date
+- `symbol`: Stock ticker symbol (AMD or INTC)
+- `eps`: Actual Earnings Per Share
+- `estimated_eps`: Analyst-estimated EPS
+- `forecast_eps`: Forecasted EPS
+- `earning`: Boolean flag indicating if it's an earnings announcement date
+- `consensus`: Analyst consensus rating
+- `actual`: Actual market performance metric
+- `diff`: Difference between actual and expected performance
+
+### Technical Indicators
+- `money_flow_index`: Momentum indicator combining price and volume (0-100)
+- `ultimate_oscillator`: Technical indicator combining multiple timeframes
+- `close`: Daily closing price
+- `volume`: Daily trading volume
+- `change_percent`: Daily price change percentage
+- `marketcap`: Company market capitalization
+- `marketcap_volume_ratio`: Ratio of market cap to trading volume
+
+### Yield Data
+- `three_month`: 3-month Treasury yield
+- `ten_year`: 10-year Treasury yield
+- `ten_three_diff`: Spread between 10-year and 3-month yields (yield curve indicator)
+
+## Data Source
+This dataset combines multiple data sources including:
+- Stock price and volume data
+- Company earnings reports
+- Treasury yield data
+- Technical market indicators
+- Analyst estimates and consensus ratings
+
+## Usage
+This dataset can be used for:
+- Financial market analysis
+- Stock price prediction
+- Market sentiment analysis
+- Earnings impact studies
+- Yield curve analysis