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

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -7
README.md CHANGED
@@ -1857,13 +1857,14 @@ task_ids: []
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
 
@@ -1914,8 +1915,6 @@ 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
@@ -1999,7 +1998,7 @@ The dataset needs further cleaning for improved performance.
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
 
 
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 the annual reports of public companies from 1993-2020 from SEC EDGAR filings.
 
 
1861
 
1862
  There is supported functionality to load a specific year.
1863
 
1864
+ Care: since this is a corpus dataset, different `train/val/test` splits do not have any special meaning. It's the default HF card format to have train/val/test splits.
1865
+
1866
+ If you wish to load specific year(s) of specific companies, you probably want to use the open-source software which generated this dataset, EDGAR-CRAWLER: https://github.com/nlpaueb/edgar-crawler.
1867
+
1868
 
1869
  ### Supported Tasks
1870
 
 
1915
 
1916
  # Load a specific year and split
1917
  year_1993_training_dataset = datasets.load_dataset("eloukas/edgar-corpus", "year_1993", split="train")
 
 
1918
  ```
1919
 
1920
  ### Data Splits
 
1998
  EDGAR data is publicly available.
1999
 
2000
  ### Shoutout
2001
+ Huge shoutout to [@JanosAudran](https://huggingface.co/JanosAudran) for the HF Card setup!
2002
 
2003
  ### References
2004