v4.0.0 release notes

README.md

@@ -648,6 +648,22 @@ configs:
 
 The Crello dataset is compiled for the study of vector graphic documents. The dataset contains document meta-data such as canvas size and pre-rendered elements such as images or text boxes. The original templates were collected from [crello.com](https://crello.com) (now [create.vista.com](https://create.vista.com/)) and converted to a low-resolution format suitable for machine learning analysis.
 
+### Usage
+
+```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")
+```
+
 ### Supported Tasks and Leaderboards
 
 [CanvasVAE](https://arxiv.org/abs/2108.01249) studies unsupervised document generation.
@@ -773,18 +789,20 @@ 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`                       |
+| 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       |
 
 **Element attributes**
 
@@ -817,13 +835,13 @@ https://create.vista.com/artboard/?template=<template_id>
 
 ### Data Splits
 
-The Crello dataset has 3 splits: train, validation, and test. The current split is generated such that the same title of the original template shows up in only in one split.
+The Crello dataset has 3 splits: train, validation, and test. The current split is generated based on appearance-based clustering.
 
 | Split     | Count |
 | --------- | ----- |
-| train     | 18659 |
-| validaton | 2391  |
-| test      | 2371  |
+| train     | 19095 |
+| validaton | 1951  |
+| test      | 2375  |
 
 
 ### Visualization
@@ -941,9 +959,15 @@ We do not re-distribute the original files as we are not allowed by terms.
 
 ### Releases
 
+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.
+- Class labels have been reordered: no compabilitity with v3.
+- Small improvement to font rendering.
+
 3.1: bugfix release (Feb 16, 2023)
 
-- Fix a bug that ignores newline characters in some of the texts
+- Fix a bug that ignores newline characters in some of the texts.
 
 3.0: v3 release (Feb 13, 2023)