eloukas commited on
Commit
28d4134
1 Parent(s): e5a7eba

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -8
README.md CHANGED
@@ -1851,15 +1851,24 @@ task_ids: []
1851
 
1852
  ## Dataset Description
1853
 
1854
- - **Point of Contact: Aman Khan**
1855
 
1856
  ### Dataset Summary
1857
 
1858
- This dataset contains annual report of public companinies from 1993-2020 from SEC EDGAR filings. The dataset is based on the paper **EDGAR-CORPUS: Billions of Tokens Make The World Go Round** authored by _Leftris Loukas et.al_ (refer to References for more details). The dataset is provided as a convenience to access via HF Hub.
 
 
 
 
 
 
 
 
1859
 
1860
  ### Supported Tasks
1861
 
1862
- This is a raw dataset meant to provide a base for financial NLP. It has to be adapted for specific NLP tasks. As such there are no annotations or labels. The datasets need further processing for specific NLP tasks.
 
1863
 
1864
  ### Languages
1865
 
@@ -1869,7 +1878,7 @@ The EDGAR Filings are in English.
1869
 
1870
  ### Data Instances
1871
 
1872
- Refer to dataset preview.
1873
 
1874
  ### Data Fields
1875
 
@@ -1901,10 +1910,12 @@ Refer to dataset preview.
1901
  import datasets
1902
 
1903
  # Load the entire dataset
1904
- raw_dataset = datasets.load_dataset("JanosAudran/edgar_corpus", "full")
1905
 
1906
  # Load a specific year and split
1907
- raw_dataset = datasets.load_dataset("JanosAudran/edgar_corpus", "year_1993", split="train")
 
 
1908
  ```
1909
 
1910
  ### Data Splits
@@ -1987,8 +1998,17 @@ The dataset needs further cleaning for improved performance.
1987
 
1988
  EDGAR data is publicly available.
1989
 
 
 
 
1990
  ### References
1991
 
1992
- - Lefteris Loukas, Manos Fergadiotis, Ion Androutsopoulos, & Prodromos Malakasiotis. (2021). EDGAR-CORPUS [Data set]. Zenodo. https://doi.org/10.5281/zenodo.5589195
 
 
 
 
 
 
1993
 
1994
- - Loukas, Lefteris & Fergadiotis, Manos & Androutsopoulos, Ion & Malakasiotis, Prodromos. (2021). EDGAR-CORPUS: Billions of Tokens Make The World Go Round. https://arxiv.org/abs/2109.14394v2
 
1851
 
1852
  ## Dataset Description
1853
 
1854
+ - **Point of Contact: Lefteris Loukas**
1855
 
1856
  ### Dataset Summary
1857
 
1858
+ This dataset card is based on the paper **EDGAR-CORPUS: Billions of Tokens Make The World Go Round** authored by _Lefteris Loukas et.al_, as published in the _ECONLP 2021_ workshop.
1859
+
1860
+ This dataset contains annual report of public companies from 1993-2020 from SEC EDGAR filings.
1861
+
1862
+ You may want to use this dataset to pre-train an ML/NLP model.
1863
+
1864
+ There is supported functionality to load a specific year.
1865
+
1866
+ If you wish to load specific year(s) of specific companies, you probably want to use the software which generated this dataset, EDGAR-CRAWLER: https://github.com/nlpaueb/edgar-crawler.
1867
 
1868
  ### Supported Tasks
1869
 
1870
+ This is a raw dataset/corpus for financial NLP.
1871
+ As such, there are no annotations or labels.
1872
 
1873
  ### Languages
1874
 
 
1878
 
1879
  ### Data Instances
1880
 
1881
+ Refer to the dataset preview.
1882
 
1883
  ### Data Fields
1884
 
 
1910
  import datasets
1911
 
1912
  # Load the entire dataset
1913
+ raw_dataset = datasets.load_dataset("eloukas/edgar-corpus", "full")
1914
 
1915
  # Load a specific year and split
1916
+ year_1993_training_dataset = datasets.load_dataset("eloukas/edgar-corpus", "year_1993", split="train")
1917
+
1918
+ # Since this is a corpus dataset, different splits do not have any special meaning. It's the default HF card format to have train/val/split sets.
1919
  ```
1920
 
1921
  ### Data Splits
 
1998
 
1999
  EDGAR data is publicly available.
2000
 
2001
+ ### Shoutout
2002
+ Huge shoutout to @JanosAudran (https://huggingface.co/JanosAudran) for the HF Card setup!
2003
+
2004
  ### References
2005
 
2006
+ - [Research Paper] Lefteris Loukas, Manos Fergadiotis, Ion Androutsopoulos, and, Prodromos Malakasiotis. EDGAR-CORPUS: Billions of Tokens Make The World Go Round. Third Workshop on Economics and Natural Language Processing (ECONLP). https://arxiv.org/abs/2109.14394 - Punta Cana, Dominican Republic, November 2021.
2007
+
2008
+ - [Software] Lefteris Loukas, Manos Fergadiotis, Ion Androutsopoulos, and, Prodromos Malakasiotis. EDGAR-CRAWLER. https://github.com/nlpaueb/edgar-crawler (2021)
2009
+
2010
+ - [EDGAR-CORPUS, but in zip files] EDGAR-CORPUS: A corpus for financial NLP research, built from SEC's EDGAR - https://zenodo.org/record/5528490 (2021)
2011
+
2012
+ ‌- [Word Embeddings] EDGAR-W2V: Word2vec Embeddings trained on EDGAR-CORPUS - https://zenodo.org/record/5524358 (2021)
2013
 
2014
+ - [Applied Research paper where EDGAR-CORPUS is used] Lefteris Loukas, Manos Fergadiotis, Ilias Chalkidis, Eirini Spyropoulou, Prodromos Malakasiotis, Ion Androutsopoulos, and, George Paliouras. FiNER: Financial Numeric Entity Recognition for XBRL Tagging. Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers). https://doi.org/10.18653/v1/2022.acl-long.303 (2022)