Upload README.md with huggingface_hub

README.md

@@ -1,4 +1,9 @@
+
 ---
+language:
+- en
+license: other
+extra_gated_prompt: "To get access to this dataset, you must subscribe to Papers With Backtest. To subscribe, go to https://paperswithbacktest.com/ > Login > Choose Your Plan > Subscribe."
 dataset_info:
   features:
   - name: symbol
@@ -25,15 +30,26 @@ dataset_info:
     dtype: float64
   - name: volume
     dtype: float64
-  splits:
-  - name: train
-    num_bytes: 377979751
-    num_examples: 3722965
-  download_size: 119415295
-  dataset_size: 377979751
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+
 ---
+# Dataset Information
+
+Weekly **Over-Shorted Stocks** metrics for publicly traded companies, provided by **SOV.AI**.
+Each record captures short interest positioning, changes, and context for individual tickers.
+
+- **Coverage**: Major US-listed equities with available short interest data
+- **Update cadence**: Weekly snapshots sourced from short interest models
+- **Fields**:
+  - `over_shorted`: Relative measure of how over-shorted a ticker is
+  - `over_shorted_chg`: Week-over-week change in the over-shorted measure
+  - `short_interest`: Shares currently sold short
+  - `number_of_shares`: Total shares outstanding
+  - `short_percentage`: Percentage of float sold short
+  - `short_prediction`: Model prediction for short interest trend
+  - `days_to_cover`: Estimated days to cover outstanding short positions
+  - `market_cap`: Market capitalization (USD)
+  - `total_revenue`: Reported revenue (USD)
+  - `volume`: Trading volume for the period
+
+## Data Source
+Data provided by SOV.AI.