Datasets:

License:
shamotskyi commited on
Commit
859b45e
1 Parent(s): 7456591

Update README.md

Browse files

Fix broken link in README

Files changed (1) hide show
  1. README.md +3 -12
README.md CHANGED
@@ -112,14 +112,10 @@ It's composed of multiple collections, with the text content available as datase
112
  - Base_prospectuses
113
  - Final_terms
114
  - Law
115
- <!--
116
- - ~~IFRS~~
117
- - ~~Informational_materials~~
118
- -->
119
 
120
  (By default, all collections are downloaded).
121
 
122
- The entire corpus, pdf and txt files, can be downloaded here: <https://huggingface.co/datasets/anhaltai/fincorpus-de-10k/resolve/main/data/corpus_safe.zip?download=true>
123
 
124
  ### Dataset Sources
125
  The FinCorpus-DE10k dataset is composed of financial documents from various collections, each with its unique characteristics and source of origin. The documents were primarily sourced from the websites of financial institutions, regulatory bodies, and publicly available databases, with significant contributions from the Deutsche Bundesbank. The dataset includes:
@@ -128,12 +124,6 @@ The FinCorpus-DE10k dataset is composed of financial documents from various coll
128
  - **Base Prospectuses**: Containing information about the issuer, description of the security, and the summary of the prospectus. These documents are longer and fewer compared to the Final Terms but hold comprehensive information required for investors.
129
  - **Bundesbank Monthly Reports**: Consisting of 838 monthly reports from the German Bundesbank, spanning from 1949 to 2022. These documents offer a historical perspective on the German financial language. We didn't extract text from these documents. **Licensed [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)**
130
  - **Annual Reports**: This collection includes annual (and some quarterly) reports from the Bundesbank and other institutions, covering economic and financial issues, monetary policy, and financial stability risks. **Licensed [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)**
131
- <!--
132
- - **International Financial Reporting Standards (IFRS)**: Comprising the EU International Financial Reporting Standards documents from 2017 to 2023, these are vital for ensuring corporate transparency and comparability of financial statements across international borders.
133
- - <font color="red">DANGER ZONE:</font> licensing unclear, see [IFRS - IFRS Sustainability Licensing](https://www.ifrs.org/products-and-services/sustainability-products-and-services/ifrs-sustainability-licensing/) ('free for personal non-commercial use' but with limitations that may or may not apply to you).
134
- - **Informational Materials**: This collection contains miscellaneous brochures and advertisements in the area of finance, targeting a general audience with a variety of fonts, photos, and colors.
135
- - <font color="red">DANGER ZONE:</font> the materials contained (including graphics, formatting etc.) were created by different entities with differing licenses and applicable copyright laws and differs on a per-document basis. Compliance to the applicable laws is your own responsibility.
136
- -->
137
  - **Law**: Featuring German laws in the financial and related domains, including some English translations. This collection reflects the regulations applicable to the financial sector in Germany and EU Directives implemented into German law.
138
 
139
  The collection as a whole is licensed [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) except where stated otherwise.
@@ -143,6 +133,7 @@ The collection as a whole is licensed [CC BY-NC 4.0](https://creativecommons.org
143
  - **Repository:** **TODO**
144
  - **Paper:** **TODO**
145
 
 
146
  ## Uses
147
 
148
  ### Direct Use
@@ -164,7 +155,7 @@ The dataset is not designed for non-NLP tasks or NLP tasks outside the financial
164
  <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
165
  When used through `load_dataset()`, the dataset has two features: `filename` and `text`, one instance per .txt document.
166
 
167
- The complete dataset, pdf and txt, can be found in [corpus.zip](https://huggingface.co/datasets/anhaltai/fincorpus-de-10k-complete/resolve/main/data/corpus.zip?download=true). In the archive, `metadata.csv` contains the path for the PDF and its extracted .txt (if available), as well as collection name, presence of extracted text, paths to PDF and .txt files, document language(s), and financial identifiers like ISIN and country for relevant documents.
168
 
169
  The pdf and txt subfolders contain the same mirrored directory structure, sorted by collection.
170
 
 
112
  - Base_prospectuses
113
  - Final_terms
114
  - Law
 
 
 
 
115
 
116
  (By default, all collections are downloaded).
117
 
118
+ The entire corpus, pdf and txt files, can be downloaded here: [https://huggingface.co/datasets/anhaltai/fincorpus-de-10k/resolve/main/data/corpus_safe.zip?download=true](https://huggingface.co/datasets/anhaltai/fincorpus-de-10k/resolve/main/data/corpus_safe.zip?download=true)
119
 
120
  ### Dataset Sources
121
  The FinCorpus-DE10k dataset is composed of financial documents from various collections, each with its unique characteristics and source of origin. The documents were primarily sourced from the websites of financial institutions, regulatory bodies, and publicly available databases, with significant contributions from the Deutsche Bundesbank. The dataset includes:
 
124
  - **Base Prospectuses**: Containing information about the issuer, description of the security, and the summary of the prospectus. These documents are longer and fewer compared to the Final Terms but hold comprehensive information required for investors.
125
  - **Bundesbank Monthly Reports**: Consisting of 838 monthly reports from the German Bundesbank, spanning from 1949 to 2022. These documents offer a historical perspective on the German financial language. We didn't extract text from these documents. **Licensed [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)**
126
  - **Annual Reports**: This collection includes annual (and some quarterly) reports from the Bundesbank and other institutions, covering economic and financial issues, monetary policy, and financial stability risks. **Licensed [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)**
 
 
 
 
 
 
127
  - **Law**: Featuring German laws in the financial and related domains, including some English translations. This collection reflects the regulations applicable to the financial sector in Germany and EU Directives implemented into German law.
128
 
129
  The collection as a whole is licensed [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) except where stated otherwise.
 
133
  - **Repository:** **TODO**
134
  - **Paper:** **TODO**
135
 
136
+
137
  ## Uses
138
 
139
  ### Direct Use
 
155
  <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
156
  When used through `load_dataset()`, the dataset has two features: `filename` and `text`, one instance per .txt document.
157
 
158
+ The complete dataset, pdf and txt, can be found in [corpus.zip](https://huggingface.co/datasets/anhaltai/fincorpus-de-10k/resolve/main/data/corpus_safe.zip?download=true). In the archive, `metadata.csv` contains the path for the PDF and its extracted .txt (if available), as well as collection name, presence of extracted text, paths to PDF and .txt files, document language(s), and financial identifiers like ISIN and country for relevant documents.
159
 
160
  The pdf and txt subfolders contain the same mirrored directory structure, sorted by collection.
161