CharlesMoslonka commited on
Commit
f7bb327
·
verified ·
1 Parent(s): 7eaba86

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -45
README.md CHANGED
@@ -75,48 +75,3 @@ Each document folder contains:
75
  Document folders follow the pattern: `{EXCHANGE}_{TICKER}_{YEAR}`
76
  - Example: `NYSE_DEI_2019` (NYSE, ticker DEI, year 2019)
77
  - Example: `NASDAQ_CASS_2022` (NASDAQ, ticker CASS, year 2022)
78
-
79
- ## Usage Example
80
-
81
- ```python
82
- import json
83
- from pathlib import Path
84
- from PIL import Image
85
-
86
- # Load a document
87
- doc_path = Path("documents/NYSE_DEI_2019")
88
-
89
- # Read metadata
90
- with open(doc_path / "NYSE_DEI_2019_metadata.json") as f:
91
- metadata = json.load(f)
92
-
93
- # Access images
94
- images_dir = doc_path / "images"
95
- for img_file in sorted(images_dir.glob("*_img.webp")):
96
- img = Image.open(img_file)
97
- # Process image...
98
-
99
- # Read OCR text
100
- with open(doc_path / "NYSE_DEI_2019.md") as f:
101
- text = f.read()
102
- ```
103
-
104
- ## Metadata Format
105
-
106
- Each `*_metadata.json` file contains:
107
- - `document_name`: Document identifier (e.g., "NYSE_DEI_2019")
108
- - `source`: Stock exchange
109
- - `ticker`: Company ticker symbol
110
- - `year`: Publication year
111
- - `page_count`: Total number of pages
112
- - `image_count`: Total number of extracted images
113
- - `ocr_model`: Model used for OCR
114
- - `extraction_date`: Date of OCR extraction
115
-
116
- ## License
117
-
118
- Please specify the appropriate license for your dataset.
119
-
120
- ## Citation
121
-
122
- If you use this dataset, please cite it appropriately.
 
75
  Document folders follow the pattern: `{EXCHANGE}_{TICKER}_{YEAR}`
76
  - Example: `NYSE_DEI_2019` (NYSE, ticker DEI, year 2019)
77
  - Example: `NASDAQ_CASS_2022` (NASDAQ, ticker CASS, year 2022)