Update README.md

README.md

@@ -567,15 +567,7 @@ The Crello dataset is compiled for the study of vector graphic documents. The da
 ```python
 import datasets
 
-dataset = datasets.load_dataset("cyberagent/crello")
-```
-
-Old revision is available via `revision` option.
-
-```python
-import datasets
-
-dataset = datasets.load_dataset("cyberagent/crello", revision="3.1")
+dataset = datasets.load_dataset("cyberagent/crello", revision="5.0.0")
 ```
 
 ### Supported Tasks and Leaderboards
@@ -590,110 +582,15 @@ Almost all design templates use English.
 
 ### Data Instances
 
-Each instance has scalar attributes (canvas) and sequence attributes (elements). Categorical values are stored as integer values. Check `ClassLabel` features of the dataset for the list of categorical labels.
-
-```
-{'id': '592d6c2c95a7a863ddcda140',
- 'length': 8,
- 'group': 4,
- 'format': 20,
- 'canvas_width': 3,
- 'canvas_height': 1,
- 'category': 0,
- 'title': 'Beauty Blog Ad Woman with Unusual Hairstyle',
- 'type': [1, 3, 3, 3, 3, 4, 4, 4],
- 'left': [0.0,
-  -0.0009259259095415473,
-  0.24444444477558136,
-  0.5712962746620178,
-  0.2657407522201538,
-  0.369228333234787,
-  0.2739444375038147,
-  0.44776931405067444],
- 'top': [0.0,
-  -0.0009259259095415473,
-  0.37037035822868347,
-  0.41296297311782837,
-  0.41296297311782837,
-  0.8946287035942078,
-  0.4549448788166046,
-  0.40591198205947876],
- 'width': [1.0,
-  1.0018517971038818,
-  0.510185182094574,
-  0.16296295821666718,
-  0.16296295821666718,
-  0.30000001192092896,
-  0.4990740716457367,
-  0.11388888955116272],
- 'height': [1.0,
-  1.0018517971038818,
-  0.25833332538604736,
-  0.004629629664123058,
-  0.004629629664123058,
-  0.016611294820904732,
-  0.12458471953868866,
-  0.02657807245850563],
- 'opacity': [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],
- 'text': ['', '', '', '', '', 'STAY WITH US', 'FOLLOW', 'PRESS'],
- 'font': [0, 0, 0, 0, 0, 152, 172, 152],
- 'font_size': [0.0, 0.0, 0.0, 0.0, 0.0, 18.0, 135.0, 30.0],
- 'text_align': [0, 0, 0, 0, 0, 2, 2, 2],
- 'angle': [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
- 'capitalize': [0, 0, 0, 0, 0, 0, 0, 0],
- 'line_height': [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],
- 'letter_spacing': [0.0, 0.0, 0.0, 0.0, 0.0, 14.0, 12.55813980102539, 3.0],
- 'suitability': [0],
- 'keywords': ['beautiful',
-  'beauty',
-  'blog',
-  'blogging',
-  'caucasian',
-  'cute',
-  'elegance',
-  'elegant',
-  'fashion',
-  'fashionable',
-  'femininity',
-  'glamour',
-  'hairstyle',
-  'luxury',
-  'model',
-  'stylish',
-  'vogue',
-  'website',
-  'woman',
-  'post',
-  'instagram',
-  'ig',
-  'insta',
-  'fashion',
-  'purple'],
- 'industries': [1, 8, 13],
- 'color': [[153.0, 118.0, 96.0],
-  [34.0, 23.0, 61.0],
-  [34.0, 23.0, 61.0],
-  [255.0, 255.0, 255.0],
-  [255.0, 255.0, 255.0],
-  [255.0, 255.0, 255.0],
-  [255.0, 255.0, 255.0],
-  [255.0, 255.0, 255.0]],
- 'image': [<PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>,
-  <PIL.PngImagePlugin.PngImageFile image mode=RGBA size=256x256>]}
-```
+Each instance has scalar attributes (canvas) and sequence attributes (elements).
+Categorical values are stored as integer values. Check `ClassLabel` features of the dataset for the list of categorical labels.
 
 To get a label for categorical values, use the `int2str` method:
 
 ```python
 data = dataset['train'] # obtain the train set
 key = "font"
-example = data[0] # obtain first sample in train set
+example = data[0] # obtain the first sample in train set
 
 data.features[key].feature.int2str(example[key]) # obtain the text equivalent of the encoded values
 ```
@@ -704,109 +601,83 @@ In the following, categorical fields are shown as `categorical` type, but the ac
 
 **Canvas attributes**
 
-| Field         | Type        | Shape   | Description                                                       |
-| ------------- | ----------- | ------- | ----------------------------------------------------------------- |
-| id            | string      | ()      | Template ID from crello.com                                       |
-| group         | categorical | ()      | Broad design groups, such as social media posts or blog headers   |
-| format        | categorical | ()      | Detailed design formats, such as Instagram post or postcard       |
-| category      | categorical | ()      | Topic category of the design, such as holiday celebration         |
-| canvas_width  | categorical | ()      | Canvas pixel width                                                |
-| canvas_height | categorical | ()      | Canvas pixel height                                               |
-| length        | int64       | ()      | Length of elements                                                |
-| suitability   | categorical | (None,) | List of display tags, only `mobile` tag exists                    |
-| keywords      | string      | (None,) | List of keywords associated to this template                      |
-| industries    | categorical | (None,) | List of industry tags like `marketingAds`                         |
-| preview       | image       | ()      | Preview image of the template for convenience; only for debugging |
-| cluster_index | int64       | ()      | Cluster index used to split the dataset; only for debugging       |
+| Field         | Type        | Shape   | Description                                                     |
+| ------------- | ----------- | ------- | --------------------------------------------------------------- |
+| id            | string      | ()      | Template ID from create.vista.com                               |
+| group         | categorical | ()      | Broad design groups, such as social media posts or blog headers |
+| format        | categorical | ()      | Detailed design formats, such as Instagram post or postcard     |
+| category      | categorical | ()      | Topic category of the design, such as holiday celebration       |
+| canvas_width  | int64       | ()      | Canvas pixel width                                              |
+| canvas_height | int64       | ()      | Canvas pixel height                                             |
+| length        | int64       | ()      | Length of elements                                              |
+| suitability   | categorical | (None,) | List of display tags, only `mobile` tag exists                  |
+| keywords      | string      | (None,) | List of keywords associated to this template                    |
+| industries    | categorical | (None,) | List of industry tags like `marketingAds`                       |
+| preview       | image       | ()      | Preview image of the template for convenience                   |
+| cluster_index | int64       | ()      | Cluster index used to split the dataset; only for debugging     |
 
 **Element attributes**
 
-| Field          | Type        | Shape     | Description                                                          |
-| -------------- | ----------- | --------- | -------------------------------------------------------------------- |
-| type           | categorical | (None,)   | Element type, such as vector shape, image, or text                   |
-| left           | float32     | (None,)   | Element left position normalized to [0, 1] range w.r.t. canvas_width |
-| top            | float32     | (None,)   | Element top position normalized to [0, 1] range w.r.t. canvas_height |
-| width          | float32     | (None,)   | Element width normalized to [0, 1] range w.r.t. canvas_width         |
-| height         | float32     | (None,)   | Element height normalized to [0, 1] range w.r.t. canvas_height       |
-| color          | int64       | (None, 3) | Extracted main RGB color of the element                              |
-| opacity        | float32     | (None,)   | Opacity in [0, 1] range                                              |
-| image          | image       | (None,)   | Pre-rendered 256x256 preview of the element encoded in PNG format    |
-| text           | string      | (None,)   | Text content in UTF-8 encoding for text element                      |
-| font           | categorical | (None,)   | Font family name for text element                                    |
-| font_size      | float32     | (None,)   | Font size (height) in pixels                                         |
-| text_align     | categorical | (None,)   | Horizontal text alignment, left, center, right for text element      |
-| angle          | float32     | (None,)   | Element rotation angle (radian) w.r.t. the center of the element     |
-| capitalize     | categorical | (None,)   | Binary flag to capitalize letters                                    |
-| line_height    | float32     | (None,)   | Scaling parameter to line height, default is 1.0                     |
-| letter_spacing | float32     | (None,)   | Adjustment parameter for letter spacing, default is 0.0              |
-
-Note that the color and pre-rendered images do not necessarily accurately reproduce the original design templates. The original template is accessible at the following URL if still available.
+| Field          | Type        | Shape        | Description                                                      |
+| -------------- | ----------- | ------------ | ---------------------------------------------------------------- |
+| type           | categorical | (None,)      | Element type, such as vector shape, image, or text               |
+| left           | float32     | (None,)      | Element left position                                            |
+| top            | float32     | (None,)      | Element top position                                             |
+| width          | float32     | (None,)      | Element width                                                    |
+| height         | float32     | (None,)      | Element height                                                   |
+| color          | string      | (None, None) | RGB color palette of the vector graphic element                  |
+| opacity        | float32     | (None,)      | Opacity in [0, 1] range                                          |
+| image          | image       | (None,)      | Pre-rendered preview of the element encoded in PNG format        |
+| text           | string      | (None,)      | Text content in UTF-8 encoding for text element                  |
+| font           | categorical | (None,)      | Font family name for text element                                |
+| font_size      | float32     | (None,)      | Font size (height) in pixels                                     |
+| text_align     | categorical | (None,)      | Horizontal text alignment, left, center, right for text element  |
+| angle          | float32     | (None,)      | Element rotation angle (degree) w.r.t. the center of the element |
+| font_bold      | boolean     | (None, None) | Character-wise flag to indicate bold font                        |
+| font_italic    | boolean     | (None, None) | Character-wise flag to indicate italic font                      |
+| text_color     | string      | (None, None) | Character-wise rgba color                                        |
+| text_line      | int64       | (None, None) | Character-wise index of line number                              |
+| capitalize     | boolean     | (None,)      | Binary flag to capitalize letters                                |
+| line_height    | float32     | (None,)      | Scaling parameter to line height, default is 1.0                 |
+| letter_spacing | float32     | (None,)      | Adjustment parameter for letter spacing, default is 0.0          |
+
+`left` and `top` can be negative because elements can be bigger than the canvas size.
+`text_line` indicates the index of the text line.
+For example, the following indicates that `Be` is in the first line and the rest in the next line.
+The newline character `\n` if present is ignored in rendering.
+
+```
+{
+  "text": "Be\nambitious!",
+  "text_line": [0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+}
+```
+
+Note that the color and pre-rendered images do not necessarily accurately reproduce the original design templates.
+The original template is accessible at the following URL if still available.
 
 ```
 https://create.vista.com/artboard/?template=<template_id>
 ```
 
-`left` and `top` can be negative because elements can be bigger than the canvas size.
-
 ### Data Splits
 
 The Crello dataset has 3 splits: train, validation, and test. The current split is generated based on appearance-based clustering.
 
 | Split     | Count |
 | --------- | ----- |
-| train     | 19095 |
-| validaton | 1951  |
-| test      | 2375  |
-
+| train     | 19,421 |
+| validaton | 1,875  |
+| test      | 2,006  |
 
 ### Visualization
 
-Each example can be visualized in the following approach using [`skia-python`](https://kyamagu.github.io/skia-python/). Note the following does not guarantee a similar appearance to the original template. Currently, the quality of text rendering is far from perfect.
+Each example can be visualized in the following approach using [`cr-renderer`](https://github.com/CyberAgentAILab/cr-renderer).
 
-```python
-import io
-from typing import Any, Dict
-
-import numpy as np
-import skia
-
-
-def render(features: datasets.Features, example: Dict[str, Any], max_size: float=512.) -> bytes:
-    """Render parsed sequence example onto an image and return as PNG bytes."""
-    canvas_width = int(features["canvas_width"].int2str(example["canvas_width"]))
-    canvas_height = int(features["canvas_height"].int2str(example["canvas_height"]))
-
-    scale = min(1.0, max_size / canvas_width, max_size / canvas_height)
-
-    surface = skia.Surface(int(scale * canvas_width), int(scale * canvas_height))
-    with surface as canvas:
-        canvas.scale(scale, scale)
-        for index in range(example["length"]):
-            pil_image = example["image"][index]
-            image = skia.Image.frombytes(
-                pil_image.convert('RGBA').tobytes(),
-                pil_image.size,
-                skia.kRGBA_8888_ColorType)
-            left = example["left"][index] * canvas_width
-            top = example["top"][index] * canvas_height
-            width = example["width"][index] * canvas_width
-            height = example["height"][index] * canvas_height
-            rect = skia.Rect.MakeXYWH(left, top, width, height)
-            paint = skia.Paint(Alphaf=example["opacity"][index], AntiAlias=True)
-
-            angle = example["angle"][index]
-            with skia.AutoCanvasRestore(canvas):
-                if angle != 0:
-                    degree = 180. * angle / np.pi
-                    canvas.rotate(degree, left + width / 2., top + height / 2.)
-                canvas.drawImageRect(image, rect, paint=paint)
-
-    image = surface.makeImageSnapshot()
-    with io.BytesIO() as f:
-        image.save(f, skia.kPNG)
-        return f.getvalue()
-```
+https://github.com/CyberAgentAILab/cr-renderer
 
+Note the renderer does not guarantee a similar appearance to the original template.
+Currently, the quality of text rendering is far from perfect.
 
 ## Dataset Creation
 
@@ -874,6 +745,17 @@ We do not re-distribute the original files as we are not allowed by terms.
 
 ### Releases
 
+5.0.0: v5 release (Sep 18, 2024)
+
+- Element positions and sizes are not normalized by canvas size
+- Angle is in degrees instead of radians.
+- New rich-text attributes (font_bold, font_italic, font_color, text_line) that specify character-level styling
+- Pre-rendered layer images are now resized to fit the longer side in 512px
+- Significantly improved pre-rendering quality for each layer
+- Color attribute now only contains palette when the original data has
+- There are now five element types
+- Dataset split is updated, no compatibility with v4.
+
 4.0.0: v4 release (Dec 5, 2023)
 
 - Change the dataset split based on the template appearance to avoid near-duplicates: no compatibility with v3.