LeonidSmoliuk commited on
Commit
930b481
·
1 Parent(s): 033f6ed

upd readme to add ai-tale pdf example

Browse files
Files changed (1) hide show
  1. README.md +74 -43
README.md CHANGED
@@ -27,34 +27,35 @@ dataset_info:
27
  '0': MainChar
28
  '1': Icons
29
  '2': Charts
 
30
  ---
31
 
32
  # LS_ImgCreate — Visual Content Image Library 🎨
33
 
34
- [🇧 English](#english) | [🇷🇺 Русский](#русский)
35
 
36
  ---
37
 
38
  ## English
39
 
40
  **Contents:**
41
- - [🎯 What This Is](#-what-this-is)
42
- - [🖼 Examples](#-examples)
43
- - [📂 Repository Structure](#-repository-structure)
44
- - [🖼 Image Categories](#-image-categories)
45
- - [⚙️ Technical Specifications](#-technical-specifications)
46
- - [🎨 Themes and Color Modes](#-themes-and-color-modes)
47
- - [🏷 File Naming Convention](#-file-naming-convention)
48
- - [🤝 Contributing](#-contributing)
49
- - [📄 License](#-license)
50
 
51
  ### 🎯 What This Is
52
 
53
- A curated image library of hand-drawn pencil-sketch illustrations created according to the ImgCreate visual style system. The dataset stores example images of the main character Rosa Romashkina, interface icons, chart examples, and reference style samples for diagrams.
54
 
55
- Companion project with detailed style instructions: [find-project / ImgCreate](https://github.com/find-project-su/find-project/tree/master/ImgCreate).
56
 
57
- > **This is a style reference gallery, not a labeled training set.** It exists so people writing or reviewing ImgCreate prompts can see what the prompts actually produce. If you open this dataset via the Data Studio viewer, you'll see an automatically generated `label` column with 3 values (`Charts` / `Icons` / `MainChar`) — that comes from the Hugging Face `imagefolder` loader, which turns subfolder names into classes automatically. It is **not** a hand-annotated classification task, and this dataset isn't intended for training an image classifier.
58
 
59
  ### 🖼 Examples
60
 
@@ -69,7 +70,9 @@ One representative image per category — the collection keeps growing, so only
69
  </tr>
70
  </table>
71
 
72
- The full and growing set — all themes, artistic styles, and icon packs — is browsable in [Files and versions](https://huggingface.co/datasets/LeonidSmoliuk/LS_ImgCreate/tree/main).
 
 
73
 
74
  ### 📂 Repository Structure
75
 
@@ -79,11 +82,13 @@ LS_ImgCreate/
79
  │ ├── MainChar/ # Illustrations featuring the main character (Rosa)
80
  │ ├── Icons/ # Icon illustrations
81
  │ └── Charts/ # Chart and diagram examples
82
- └── Reference_Imgs/
83
- └── Charts/ # Style reference samples for charts and diagrams
 
 
84
  ```
85
 
86
- > **Known gap:** `Reference_Imgs/` currently only covers `Charts/`. There are no dedicated style-reference sheets yet for `MainChar` or `Icons` — those categories currently only have `Example_Imgs/`. This is a coverage gap to fill, not a documentation error. See [Contributing](#-contributing) if you'd like to add them.
87
 
88
  ### 🖼 Image Categories
89
 
@@ -91,8 +96,9 @@ LS_ImgCreate/
91
  | ------------------------ | ------------------------ | -------- | --------------------------------------------- |
92
  | Main character | `Example_Imgs/MainChar/` | 0xxxx | Rosa Romashkina illustrations |
93
  | Icons | `Example_Imgs/Icons/` | 1xxxx | Interface and concept icons |
94
- | Chart references (style) | `Reference_Imgs/Charts/` | 2xxxx | Style samples for diagrams (Donut, Histogram) |
95
  | Chart examples | `Example_Imgs/Charts/` | 3xxxx | Ready-made chart examples (Spider charts) |
 
96
 
97
  ### ⚙️ Technical Specifications
98
 
@@ -131,6 +137,13 @@ LS_ImgCreate/
131
  - Ready-made examples demonstrating the final output
132
  - Current types: Spider chart (5-axis, 6-axis)
133
 
 
 
 
 
 
 
 
134
  ### 🎨 Themes and Color Modes
135
 
136
  - **BaseTheme** — black pencil sketch on a clean white background
@@ -152,21 +165,24 @@ LS_ImgCreate/
152
  - `Theme` — `BaseTheme` / `DarkTheme` for illustrations, short `Base` / `Dark` in chart references
153
  - `Color` — optional marker, present only when the image contains color accents
154
 
 
 
155
  Examples (one per ID range, each showing different optional markers):
156
 
157
  - `00001_Roza on SkateBoard_DarkTheme_Color.webp` — main character with theme and color markers
158
  - `10004_Sport-fitness_BaseTheme.webp` — icon without color accents
159
  - `20003_Donut_Crayon-style_Dark.webp` — style reference with artistic style marker
160
  - `30001_SpiderChart_5axis.webp` — chart example with variant marker
 
161
 
162
  ### 🤝 Contributing
163
 
164
  To propose new example or reference images:
165
 
166
- 1. Follow the [file naming convention](#-file-naming-convention) and pick the next free ID in the right range.
167
- 2. Match the [technical specifications](#-technical-specifications) for that category (format, size, aspect ratio).
168
- 3. Place the file in the matching folder — including a new `Reference_Imgs/MainChar/` or `Reference_Imgs/Icons/` folder if you're closing the [known gap](#-repository-structure) above.
169
- 4. Open a discussion or PR on this dataset, or on the companion [find-project / ImgCreate](https://github.com/find-project-su/find-project/tree/master/ImgCreate) repository, whichever the change relates to more closely.
170
 
171
  ### 📄 License
172
 
@@ -177,23 +193,23 @@ MIT — free to use, modify, and distribute with attribution to the original sou
177
  ## Русский
178
 
179
  **Содержание:**
180
- - [🎯 Что это](#-что-это)
181
- - [🖼 Примеры](#-примеры)
182
- - [📂 Структура репозитория](#-структура-репозитория)
183
- - [🖼 Категории изображений](#-категории-изображений)
184
- - [⚙️ Технические требования](#-технические-требования)
185
- - [🎨 Темы и цветовые режимы](#-темы-и-цветовые-режимы)
186
- - [🏷 Правила именования файлов](#-правила-именования-файлов)
187
- - [🤝 Участие в проекте](#-участие-в-проекте)
188
- - [📄 Лицензия](#-лицензия)
189
 
190
  ### 🎯 Что это
191
 
192
- Подборка иллюстраций в технике карандашного наброска, созданных по правилам визуальной системы ImgCreate. Набор данных хранит примеры изображений главного персонажа Розы Ромашкиной, иконок интерфейса, готовых диаграмм и эталонных образцов стиля.
193
 
194
- Сопроводительный проект с подробными инструкциями по стилю: [find-project / ImgCreate](https://github.com/find-project-su/find-project/tree/master/ImgCreate).
195
 
196
- > **Это референс-галерея стиля, а не размеченный тренировочный датасет.** Она существует, чтобы те, кто пишет или проверяет промты ImgCreate, могли увидеть, что эти промты реально производят. Если вы откроете датасет через Data Studio, увидите автоматически сгенерированную колонку `label` с 3 значениями (`Charts` / `Icons` / `MainChar`) — это результат работы загрузчика `imagefolder` Hugging Face, который автоматически превращает названия подпапок в классы. Это **не** вручную размеченная задача классификации, и датасет не предназначен для обучения классификатора изображений.
197
 
198
  ### 🖼 Примеры
199
 
@@ -208,7 +224,9 @@ MIT — free to use, modify, and distribute with attribution to the original sou
208
  </tr>
209
  </table>
210
 
211
- Полный и растущий набор — все темы, художественные стили и паки иконок — во вкладке [Files and versions](https://huggingface.co/datasets/LeonidSmoliuk/LS_ImgCreate/tree/main).
 
 
212
 
213
  ### 📂 Структура репозитория
214
 
@@ -218,11 +236,13 @@ LS_ImgCreate/
218
  │ ├── MainChar/ # Иллюстрации с главным персонажем (Розой)
219
  │ ├── Icons/ # Иконки
220
  │ └── Charts/ # Примеры диаграмм и графиков
221
- └── Reference_Imgs/
222
- └── Charts/ # Эталонные образцы стиля для диаграмм
 
 
223
  ```
224
 
225
- > **Известный пробел:** `Reference_Imgs/` сейчас покрывает только `Charts/`. Эталонных образцов стиля для `MainChar` и `Icons` пока нет — у этих категорий есть только `Example_Imgs/`. Это пробел в покрытии, а не ошибка документации. Если хотите его закрыть — см. раздел [Участие в проекте](#-участие-в-проекте).
226
 
227
  ### 🖼 Категории изображений
228
 
@@ -232,6 +252,7 @@ LS_ImgCreate/
232
  | Иконки | `Example_Imgs/Icons/` | 1xxxx | Иконки интерфейса и понятий |
233
  | Референсы диаграмм (стиль) | `Reference_Imgs/Charts/` | 2xxxx | Образцы стиля (кольцевая диаграмма, гистограмма) |
234
  | Примеры диаграмм | `Example_Imgs/Charts/` | 3xxxx | Готовые примеры диаграмм (лепестковые) |
 
235
 
236
  ### ⚙️ Технические требования
237
 
@@ -270,6 +291,13 @@ LS_ImgCreate/
270
  - Готовые примеры, демонстрирующие итоговый результат
271
  - Текущие типы: лепестковая диаграмма (5 осей, 6 осей)
272
 
 
 
 
 
 
 
 
273
  ### 🎨 Темы и цветовые режимы
274
 
275
  - **BaseTheme** — чёрный карандашный набросок на чистом белом фоне
@@ -291,22 +319,25 @@ LS_ImgCreate/
291
  - `Theme` — `BaseTheme` / `DarkTheme` для иллюстраций, короткие формы `Base` / `Dark` в референсах диаграмм
292
  - `Color` — необязательный маркер, присутствует только при наличии цветовых акцентов
293
 
 
 
294
  Примеры (по одному на диапазон номеров, каждый показывает разные необязательные маркеры):
295
 
296
  - `00001_Roza on SkateBoard_DarkTheme_Color.webp` — главный персонаж с маркерами темы и цвета
297
  - `10004_Sport-fitness_BaseTheme.webp` — иконка без цветовых акцентов
298
  - `20003_Donut_Crayon-style_Dark.webp` — референс стиля с маркером художественного стиля
299
  - `30001_SpiderChart_5axis.webp` — пример диаграммы с маркером варианта
 
300
 
301
  ### 🤝 Участие в проекте
302
 
303
  Чтобы предложить новые примеры или референсные изображения:
304
 
305
- 1. Следуйте [правилам именования файлов](#-правила-именования-файлов) и берите следующий свободный номер в нужном диапазоне.
306
- 2. Соблюдайте [технические требования](#-технические-требования) для соответствующей категории (формат, размер, пропорции).
307
- 3. Кладите файл в соответствующую папку — при необходимости создав новую `Reference_Imgs/MainChar/` или `Reference_Imgs/Icons/`, закрывая [известный пробел](#-структура-репозитория) выше.
308
- 4. Откройте discussion или PR в этом датасете, либо в сопроводительном репозитории [find-project / ImgCreate](https://github.com/find-project-su/find-project/tree/master/ImgCreate) — смотря к чему ближе изменение.
309
 
310
  ### 📄 Лицензия
311
 
312
- MIT — свободное использование, изменение и распространение при условии указания источника.
 
27
  '0': MainChar
28
  '1': Icons
29
  '2': Charts
30
+ '3': Scenarios
31
  ---
32
 
33
  # LS_ImgCreate — Visual Content Image Library 🎨
34
 
35
+ 🇧 English | 🇷🇺 Русский
36
 
37
  ---
38
 
39
  ## English
40
 
41
  **Contents:**
42
+ - 🎯 What This Is
43
+ - 🖼 Examples
44
+ - 📂 Repository Structure
45
+ - 🖼 Image Categories
46
+ - ⚙️ Technical Specifications
47
+ - 🎨 Themes and Color Modes
48
+ - 🏷 File Naming Convention
49
+ - 🤝 Contributing
50
+ - 📄 License
51
 
52
  ### 🎯 What This Is
53
 
54
+ A curated image library of hand-drawn pencil-sketch illustrations created according to the ImgCreate visual style system. The dataset stores example images of the main character Rosa Romashkina, interface icons, chart examples, reference style samples for diagrams, and complete scenario examples.
55
 
56
+ Companion project with detailed style instructions: find-project / ImgCreate.
57
 
58
+ > **This is a style reference gallery, not a labeled training set.** It exists so people writing or reviewing ImgCreate prompts can see what the prompts actually produce. If you open this dataset via the Data Studio viewer, you'll see an automatically generated `label` column with 4 values (`Charts` / `Icons` / `MainChar` / `Scenarios`) — that comes from the Hugging Face `imagefolder` loader, which turns subfolder names into classes automatically. It is **not** a hand-annotated classification task, and this dataset isn't intended for training an image classifier.
59
 
60
  ### 🖼 Examples
61
 
 
70
  </tr>
71
  </table>
72
 
73
+ **Scenario Example:** A complete illustrated short story is available as a PDF — see `Scenarios/img_for_lit/20261015_tale_The_Test.pdf`. This demonstrates the full workflow from the ImgCreate literary illustration instruction.
74
+
75
+ The full and growing set — all themes, artistic styles, and icon packs — is browsable in Files and versions.
76
 
77
  ### 📂 Repository Structure
78
 
 
82
  │ ├── MainChar/ # Illustrations featuring the main character (Rosa)
83
  │ ├── Icons/ # Icon illustrations
84
  │ └── Charts/ # Chart and diagram examples
85
+ ├── Reference_Imgs/
86
+ │ └── Charts/ # Style reference samples for charts and diagrams
87
+ └── Scenarios/
88
+ └── img_for_lit/ # Complete scenario examples (e.g., illustrated stories)
89
  ```
90
 
91
+ > **Known gap:** `Reference_Imgs/` currently only covers `Charts/`. There are no dedicated style-reference sheets yet for `MainChar` or `Icons` — those categories currently only have `Example_Imgs/`. This is a coverage gap to fill, not a documentation error. See Contributing if you'd like to add them.
92
 
93
  ### 🖼 Image Categories
94
 
 
96
  | ------------------------ | ------------------------ | -------- | --------------------------------------------- |
97
  | Main character | `Example_Imgs/MainChar/` | 0xxxx | Rosa Romashkina illustrations |
98
  | Icons | `Example_Imgs/Icons/` | 1xxxx | Interface and concept icons |
99
+ | Chart references (style) | `Reference_Imgs/Charts/` | 2xxxx | Style samples for diagrams (Donut, Histogram) |
100
  | Chart examples | `Example_Imgs/Charts/` | 3xxxx | Ready-made chart examples (Spider charts) |
101
+ | Scenarios | `Scenarios/img_for_lit/` | — | Complete use case examples (illustrated stories, articles) |
102
 
103
  ### ⚙️ Technical Specifications
104
 
 
137
  - Ready-made examples demonstrating the final output
138
  - Current types: Spider chart (5-axis, 6-axis)
139
 
140
+ **Scenarios**
141
+
142
+ - Complete use case examples demonstrating full workflows
143
+ - Stored as PDF documents with embedded illustrations
144
+ - Current scenarios: Illustrated literary works (stories, novels, poems, articles)
145
+ - Format: PDF with text and embedded illustrations following ImgCreate style guidelines
146
+
147
  ### 🎨 Themes and Color Modes
148
 
149
  - **BaseTheme** — black pencil sketch on a clean white background
 
165
  - `Theme` — `BaseTheme` / `DarkTheme` for illustrations, short `Base` / `Dark` in chart references
166
  - `Color` — optional marker, present only when the image contains color accents
167
 
168
+ **Scenario files** use date-based naming: `YYYYMMDD_scenario-type_title.ext`
169
+
170
  Examples (one per ID range, each showing different optional markers):
171
 
172
  - `00001_Roza on SkateBoard_DarkTheme_Color.webp` — main character with theme and color markers
173
  - `10004_Sport-fitness_BaseTheme.webp` — icon without color accents
174
  - `20003_Donut_Crayon-style_Dark.webp` — style reference with artistic style marker
175
  - `30001_SpiderChart_5axis.webp` — chart example with variant marker
176
+ - `20261015_tale_The_Test.pdf` — scenario example (illustrated story)
177
 
178
  ### 🤝 Contributing
179
 
180
  To propose new example or reference images:
181
 
182
+ 1. Follow the file naming convention and pick the next free ID in the right range.
183
+ 2. Match the technical specifications for that category (format, size, aspect ratio).
184
+ 3. Place the file in the matching folder — including a new `Reference_Imgs/MainChar/` or `Reference_Imgs/Icons/` folder if you're closing the known gap above.
185
+ 4. Open a discussion or PR on this dataset, or on the companion find-project / ImgCreate repository, whichever the change relates to more closely.
186
 
187
  ### 📄 License
188
 
 
193
  ## Русский
194
 
195
  **Содержание:**
196
+ - 🎯 Что это
197
+ - 🖼 Примеры
198
+ - 📂 Структура репозитория
199
+ - 🖼 Категории изображений
200
+ - ⚙️ Технические требования
201
+ - 🎨 Темы и цветовые режимы
202
+ - 🏷 Правила именования файлов
203
+ - 🤝 Участие в проекте
204
+ - 📄 Лицензия
205
 
206
  ### 🎯 Что это
207
 
208
+ Подборка иллюстраций в технике карандашного наброска, созданных по правилам визуальной системы ImgCreate. Набор данных хранит примеры изображений главного персонажа Розы Ромашкиной, иконок интерфейса, готовых диаграмм, эталонных образцов стиля и полных примеров сценариев использования.
209
 
210
+ Сопроводительный проект с подробными инструкциями по стилю: find-project / ImgCreate.
211
 
212
+ > **Это референс-галерея стиля, а не размеченный тренировочный датасет.** Она существует, чтобы те, кто пишет или проверяет промты ImgCreate, могли увидеть, что эти промты реально производят. Если вы откроете датасет через Data Studio, увидите автоматически сгенерированную колонку `label` с 4 значениями (`Charts` / `Icons` / `MainChar` / `Scenarios`) — это результат работы загрузчика `imagefolder` Hugging Face, который автоматически превращает названия подпапок в классы. Это **не** вручную размеченная задача классификации, и датасет не предназначен для обучения классификатора изображений.
213
 
214
  ### 🖼 Примеры
215
 
 
224
  </tr>
225
  </table>
226
 
227
+ **Пример сценария:** Полный иллюстрированный рассказ доступен в формате PDF — см. `Scenarios/img_for_lit/20261015_tale_The_Test.pdf`. Это демонстрирует полный рабочий процесс из инструкции ImgCreate по созданию литературных иллюстраций.
228
+
229
+ Полный и растущий набор — все темы, художественные стили и паки иконок — во вкладке Files and versions.
230
 
231
  ### 📂 Структура репозитория
232
 
 
236
  │ ├── MainChar/ # Иллюстрации с главным персонажем (Розой)
237
  │ ├── Icons/ # Иконки
238
  │ └── Charts/ # Примеры диаграмм и графиков
239
+ ├── Reference_Imgs/
240
+ │ └── Charts/ # Эталонные образцы стиля для диаграмм
241
+ └── Scenarios/
242
+ └── img_for_lit/ # Полные примеры сценариев (иллюстрированные рассказы)
243
  ```
244
 
245
+ > **Известный пробел:** `Reference_Imgs/` сейчас покрывает только `Charts/`. Эталонных образцов стиля для `MainChar` и `Icons` пока нет — у этих категорий ��сть только `Example_Imgs/`. Это пробел в покрытии, а не ошибка документации. Если хотите его закрыть — см. раздел Участие в проекте.
246
 
247
  ### 🖼 Категории изображений
248
 
 
252
  | Иконки | `Example_Imgs/Icons/` | 1xxxx | Иконки интерфейса и понятий |
253
  | Референсы диаграмм (стиль) | `Reference_Imgs/Charts/` | 2xxxx | Образцы стиля (кольцевая диаграмма, гистограмма) |
254
  | Примеры диаграмм | `Example_Imgs/Charts/` | 3xxxx | Готовые примеры диаграмм (лепестковые) |
255
+ | Сценарии | `Scenarios/img_for_lit/` | — | Полные примеры использования (иллюстрированные рассказы, статьи) |
256
 
257
  ### ⚙️ Технические требования
258
 
 
291
  - Готовые примеры, демонстрирующие итоговый результат
292
  - Текущие типы: лепестковая диаграмма (5 осей, 6 осей)
293
 
294
+ **Сценарии**
295
+
296
+ - Полные примеры использования, демонстрирующие полные рабочие процессы
297
+ - Хранятся как PDF-документы со встроенными иллюстрациями
298
+ - Текущие сценарии: иллюстрированные литературные произведения (рассказы, романы, стихи, статьи)
299
+ - Формат: PDF с текстом и встроенными иллюстрациями, следующими правилам стиля ImgCreate
300
+
301
  ### 🎨 Темы и цветовые режимы
302
 
303
  - **BaseTheme** — чёрный карандашный набросок на чистом белом фоне
 
319
  - `Theme` — `BaseTheme` / `DarkTheme` для иллюстраций, короткие формы `Base` / `Dark` в референсах диаграмм
320
  - `Color` — необязательный маркер, присутствует только при наличии цветовых акцентов
321
 
322
+ **Файлы сценариев** используют именование по дате: `ГГГГММДД_тип-сценария_название.расширение`
323
+
324
  Примеры (по одному на диапазон номеров, каждый показывает разные необязательные маркеры):
325
 
326
  - `00001_Roza on SkateBoard_DarkTheme_Color.webp` — главный персонаж с маркерами темы и цвета
327
  - `10004_Sport-fitness_BaseTheme.webp` — иконка без цветовых акцентов
328
  - `20003_Donut_Crayon-style_Dark.webp` — референс стиля с маркером художественного стиля
329
  - `30001_SpiderChart_5axis.webp` — пример диаграммы с маркером варианта
330
+ - `20261015_tale_The_Test.pdf` — пример сценария (иллюстрированный рассказ)
331
 
332
  ### 🤝 Участие в проекте
333
 
334
  Чтобы предложить новые примеры или референсные изображения:
335
 
336
+ 1. Следуйте правилам именования файлов и берите следующий свободный номер в нужном диапазоне.
337
+ 2. Соблюдайте технические требования для соответствующей категории (формат, размер, пропорции).
338
+ 3. Кладите файл в соответствующую папку — при необходимости создав новую `Reference_Imgs/MainChar/` или `Reference_Imgs/Icons/`, закрывая известный пробел выше.
339
+ 4. Откройте discussion или PR в этом датасете, либо в сопроводительном репозитории find-project / ImgCreate — смотря к чему ближе изменение.
340
 
341
  ### 📄 Лицензия
342
 
343
+ MIT — свободное использование, изменение и распространение при условии указания источника.