Upload README.md with huggingface_hub

README.md

@@ -1,10 +1,15 @@
+
 ---
+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
-    dtype: 'null'
+    dtype: string
   - name: datetime
-    dtype: 'null'
+    dtype: string
   - name: short_volume
     dtype: int64
   - name: total_volume
@@ -17,15 +22,22 @@ dataset_info:
     dtype: float64
   - name: market_maker_short_ratio
     dtype: float64
-  splits:
-  - name: train
-    num_bytes: 493847664
-    num_examples: 10182426
-  download_size: 420232120
-  dataset_size: 493847664
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+
 ---
+# Dataset Information
+
+Weekly **Short Volume** statistics for publicly traded companies, provided by **SOV.AI**.
+The dataset highlights aggregate and segmented short-selling activity across exchanges and participant types.
+
+- **Coverage**: Major US-listed equities with reported short volume
+- **Update cadence**: Weekly snapshots reflecting exchange-reported short volume
+- **Fields**:
+  - `short_volume`: Shares sold short during the period
+  - `total_volume`: Total shares traded
+  - `short_volume_ratio_exchange`: Ratio of short to total volume at the exchange level
+  - `retail_short_ratio`: Share of short volume attributed to retail traders
+  - `institutional_short_ratio`: Share of short volume attributed to institutional traders
+  - `market_maker_short_ratio`: Share of short volume attributed to market makers
+
+## Data Source
+Data provided by SOV.AI.