README

README.md

@@ -1,3 +1,97 @@
 ---
 license: cc-by-nc-4.0
+task_categories:
+- text-generation
+language:
+- en
+tags:
+- finance
+- legal
+pretty_name: swan - finance dataset
+size_categories:
+- 100K<n<1M
+configs:
+- config_name: default
+  data_files:
+  - split: corpus
+    path: "corpus.txt"
+  - split: corpus_deduped
+    path: "corpus_deduped.txt"
+  - split: sec_tracker
+    path: "all_sec_filings.csv"
+  - split: leaked_tracker
+    path: "all_leaked_pdfs.csv"
+  - split: fed_tracker
+    path: "all_fed_filings.csv"
+  - split: bls_jolts_tracker
+    path: "all_bls_jolts.csv"
+  - split: bls_cpi_tracker
+    path: "all_bls_cpi.csv"
+  - split: bls_ces_tracker
+    path: "all_bls_ces.csv"
+  - split: bls_historical_tracker
+    path: "all_bls_historical.csv"
 ---
+<!-- header start -->
+<div style="min-width:100%">
+<center>
+        <img style="max-width:200px" src="https://huggingface.co/datasets/dylanalloy/swan/resolve/main/swan.png">
+        <h3>swan</h3>
+        <small>aggressively updated financial text dataset</small>
+
+<a href="https://github.com/DylanAlloy/swan_scrape" target="_blank">scraping code</a>
+        
+</center>
+</div>
+<!-- header end -->
+
+
+### usage
+
+```python
+from datasets import load_dataset
+sets = ["corpus", "corpus_deduped"]
+swan_data, swan_deduped = [load_dataset("dylanalloy/swan", data_files=f"{_}.txt") for _ in sets]
+swan_data, swan_deduped
+```
+
+### data
+
+<center>
+
+| data        | added |
+| ----------- | ----------- |
+| SEC filings      | Wed. Aug 30th, 2023       |
+| Federal Reserve transcripts   | Wed. Aug 30th, 2023       |
+| private wealth management releases   | Wed. Aug 30th, 2023       |
+| large bank releases   | Wed. Aug 30th, 2023       |
+| large fund releases   | Wed. Aug 30th, 2023       |
+| large trading firm releases   | Wed. Aug 30th, 2023       |
+| BLS JOLTS releases   | Wed. Aug 30th, 2023       |
+| BLS CPI releases   | Wed. Aug 30th, 2023       |
+| BLS CES releases   | Wed. Aug 30th, 2023       |
+| BLS historical reports   | Wed. Aug 30th, 2023       |
+</center>
+
+### updates
+
+<small>this repo updates daily at 6AM EST</small>
+
+| SEC Filngs  | Federal Reserve transcripts | releases & reports     |
+| :---        |    :----:   |          ---: |
+| 30 minutes      | daily       | daily   |
+
+<small>🐒 **corpus** ⌨️ updated daily</small>
+
+### stats and delta
+
+<center>
+<img style="max-width:100%" src="https://huggingface.co/datasets/dylanalloy/swan/resolve/main/words_sizes.png">
+<img style="max-width:100%" src="https://huggingface.co/datasets/dylanalloy/swan/resolve/main/vocab_sizes_time.png">
+</center>
+
+### organization
+
+- *.csv: tracker
+- corpus.txt: collated text from all documents across all categories (designed for base model training)
+- corpus_deduped.txt: unique lines of corpus