Create README.md

README.md

@@ -0,0 +1,64 @@
+---
+license: mit
+language:
+- fr
+- de
+- en
+task_categories:
+- image-to-text
+pretty_name: NewsEye
+dataset_info:
+  features:
+  - name: image
+    dtype: image
+  - name: text
+    dtype: string
+  splits:
+  - name: train
+    num_examples: 3834
+  - name: validation
+    num_examples: 479
+  - name: test
+    num_examples: 478
+  dataset_size: 4791
+---
+
+# NewsEye Dataset
+
+## Table of Contents
+- [NewsEye Dataset](#newseye-dataset)
+  - [Table of Contents](#table-of-contents)
+  - [Dataset Description](#dataset-description)
+    - [Languages](#languages)
+  - [Dataset Structure](#dataset-structure)
+    - [Data Instances](#data-instances)
+    - [Data Fields](#data-fields)
+
+## Dataset Description
+
+- **Homepage:** [NewsEye](https://www.newseye.eu/)
+- **Point of Contact:** [TEKLIA](https://teklia.com)
+
+### Languages
+
+There are multiple languages used in the documents, among them are:
+- French,
+- English,
+- German.
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{
+  'image': <PIL.JpegImagePlugin.JpegImageFile image mode=RGB size=4300x128 at 0x1A800E8E190,
+  'text': 'Mann; und als wir uns zum Angriff stark genug'
+}
+```
+
+### Data Fields
+
+
+- `image`: A PIL.Image.Image object containing the image. Note that when accessing the image column: dataset[0]["image"] the image file is automatically decoded. Decoding of a large number of image files might take a significant amount of time. Thus it is important to first query the sample index before the "image" column, i.e. dataset[0]["image"] should always be preferred over dataset["image"][0].
+- `text`: the label transcription of the image.