Upload README.md

README.md

@@ -1,10 +1,52 @@
-# Alt Data Directory
+---
+pretty_name: Trading Forecasting Data
+license: other
+task_categories:
+- tabular-classification
+- tabular-regression
+tags:
+- finance
+- forecasting
+- market-data
+---
 
-This folder holds supporting datasets that are separate from the core market-data pipeline.
+# Trading Forecasting Dataset
 
-- `options/` contains raw and processed options datasets.
-- `institutional/` contains institutional flow and positioning datasets.
-- `external/` contains macro, index, FX, and other outside-market reference data.
-- `metadata/` contains research notes and supporting documentation for alternate datasets.
+Upload the contents of this `dataset` folder to a separate Hugging Face Dataset repository.
 
-Keep the same `raw/` and `processed/` split inside each alternate-data area where possible.
+Expected Dataset repo root:
+
+```text
+Data/
+Alt Data/
+README.md
+.gitattributes
+```
+
+The Hugging Face Space backend expects these folders to hydrate into its `research_runtime` folder:
+
+- `Data/`
+- `Alt Data/`
+
+After uploading this dataset repo, set this Space environment variable:
+
+```text
+HF_DATASET_REPO_ID=your-hf-username/your-forecasting-dataset
+```
+
+Optional:
+
+```text
+HF_DATASET_REVISION=main
+```
+
+The backend will download this dataset at startup if `research_runtime/Data` or `research_runtime/Alt Data` is missing. It also checks before update/retrain jobs.
+
+## Upload Notes
+
+This repo contains large CSV files. Use Git LFS or `huggingface-cli upload` / `huggingface_hub` upload helpers rather than dragging hundreds of files into the browser.
+
+Keep the folder names exactly as-is:
+
+- `Data`
+- `Alt Data`