Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,48 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ESG Report PDF Dataset
|
| 2 |
+
|
| 3 |
+
## Download Instructions
|
| 4 |
+
To download the dataset, follow these steps:
|
| 5 |
+
|
| 6 |
+
1. Navigate to the `data` directory in the GitHub repository:
|
| 7 |
+
```bash
|
| 8 |
+
cd data
|
| 9 |
+
```
|
| 10 |
+
|
| 11 |
+
2. Install Git LFS (if not already installed):
|
| 12 |
+
```bash
|
| 13 |
+
git lfs install
|
| 14 |
+
```
|
| 15 |
+
|
| 16 |
+
3. Clone the dataset from Hugging Face Hub:
|
| 17 |
+
```bash
|
| 18 |
+
git clone https://huggingface.co/datasets/WHATX/ESG_Report
|
| 19 |
+
```
|
| 20 |
+
|
| 21 |
+
---
|
| 22 |
+
|
| 23 |
+
## Dataset Description
|
| 24 |
+
|
| 25 |
+
This dataset contains three main components:
|
| 26 |
+
|
| 27 |
+
1. **raw_pdf**:
|
| 28 |
+
- A collection of 195 PDFs scraped from [TCFD Hub](https://www.tcfdhub.org/).
|
| 29 |
+
- The PDFs are ESG-related reports published by various companies.
|
| 30 |
+
|
| 31 |
+
2. **raw_txt**:
|
| 32 |
+
- The corresponding text files converted from the PDFs using the PDF Parser tool.
|
| 33 |
+
- These files provide easy access to the textual content of the reports.
|
| 34 |
+
|
| 35 |
+
3. **target_list**:
|
| 36 |
+
- A summary of statistical information about the dataset.
|
| 37 |
+
- This includes metadata about the reports and other relevant statistics.
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
## License and Usage
|
| 42 |
+
|
| 43 |
+
- The original PDFs are copyrighted by [TCFD Hub](https://www.tcfdhub.org/) and the respective companies that published the reports.
|
| 44 |
+
- This dataset is provided **strictly for research purposes** and is not intended for commercial use.
|
| 45 |
+
- License: mit
|
| 46 |
+
|
| 47 |
+
---
|
| 48 |
+
|