AyoubChLin commited on
Commit
b2af4a3
1 Parent(s): fcadeb6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -0
README.md CHANGED
@@ -1,3 +1,39 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ task_categories:
4
+ - text-classification
5
+ - feature-extraction
6
+ language:
7
+ - en
8
+ tags:
9
+ - finance
10
+ - stock rapport
11
+ - northwind
12
+ - company documents
13
  ---
14
+
15
+ # Northwind Stock Report Dataset
16
+
17
+ This dataset was created by [CHERGUELAINE Ayoub](https://www.linkedin.com/in/ayoub-cherguelaine/) & [BOUBEKRI Faycal](https://www.linkedin.com/in/faycal-boubekri-832848199/) for the purpose of document classification and analytics. The dataset contains monthly stock reports and monthly stock reports by category, extracted from the Northwind dataset.
18
+
19
+ The Northwind dataset is a sample database that comes with Microsoft Access, and is commonly used as a demo database for learning SQL. The dataset contains data on a fictional company called "Northwind Traders", which imports and exports specialty foods.
20
+
21
+ To create the dataset of stock reports, we used SQL queries to extract data from the Northwind database, and then converted the results to PDF documents using the ReportLab library in Python. The resulting PDFs were then manually labeled with their corresponding categories.
22
+
23
+ We used ChatGPT, a language model trained by OpenAI, to help us write the Python scripts to extract the data and generate the PDFs. ChatGPT provided us with valuable guidance and assistance throughout the project.
24
+
25
+ ## Dataset Structure
26
+
27
+ The dataset contains two subdirectories: `monthly_reports` and `category_reports`.
28
+
29
+ ### Monthly Reports
30
+
31
+ The `monthly_reports` directory contains monthly stock reports, where each file represents a stock report for a specific month. The filenames are in the format `YYYY_MM.pdf`, where `YYYY` is the year and `MM` is the month.
32
+
33
+ ### Category Reports
34
+
35
+ The `category_reports` directory contains monthly stock reports by category, where each file represents a stock report for a specific month and category. The filenames are in the format `YYYY_MM_Category.pdf`, where `YYYY` is the year, `MM` is the month, and `Category` is the name of the category.
36
+
37
+ ## Acknowledgments
38
+
39
+ We would like to thank ChatGPT, a language model trained by OpenAI, for providing valuable guidance and assistance throughout the project.