ppierzc commited on
Commit
d9204fb
1 Parent(s): f286d50

update(docs): improve readme

Browse files
Files changed (1) hide show
  1. README.md +46 -15
README.md CHANGED
@@ -1,23 +1,54 @@
1
- # App Icons Dataset
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
  ## Overview
4
 
5
- The App Icons Dataset is a collection of app icons along with their corresponding captions generated using the Salesforce BLIP image captioning model. This dataset is designed for tasks related to image captioning, particularly the generation of descriptive captions for iOS app icons.
 
 
 
 
 
 
 
 
 
 
 
 
 
6
 
7
- ## Contents
8
 
9
- - `image_path`: Local file paths to app icon images in PNG format.
10
- - `caption`: Descriptive captions generated for each app icon.
11
 
12
- ## Dataset Format
 
13
 
14
- The dataset is stored in Hugging Face datasets format, with the following structure:
15
 
16
- ```plaintext
17
- dataset/
18
- ├── data/
19
- │ ├── image_0.png
20
- │ ├── image_1.png
21
- │ ├── ...
22
- │ └── image_n.png
23
- └── dataset.arrow
 
1
+ ---
2
+ id: ios-app-icons
3
+ title: IOS App Icons
4
+ description: |
5
+ This dataset contains images and captions of iOS app icons collected from the iOS Icon Gallery. The images have been processed using a Blip Image Captioning model to generate captions.
6
+
7
+ tasks:
8
+ - image-captioning
9
+
10
+ license: openrail
11
+
12
+ # Add any relevant tags
13
+ tags:
14
+ - image-captioning
15
+ - ios-icons
16
+
17
+ # Add the date the dataset was created or last updated
18
+ created: December 20, 2023
19
+
20
+ # Add the dataset citation, if applicable
21
+ citation: |
22
+ Author, A. et al. (2023). Your Dataset Name. [Hugging Face Datasets](https://huggingface.co/datasets/your_dataset_name).
23
+
24
+ ---
25
+
26
+ # IOS App Icons
27
 
28
  ## Overview
29
 
30
+ This dataset contains images and captions of iOS app icons obtained from the iOS Icon Gallery. Each image is paired with a generated caption using a Blip Image Captioning model. The dataset is suitable for image captioning tasks and can be used to train and evaluate models for generating captions for iOS app icons.
31
+
32
+ ## Images
33
+
34
+ The images are stored in the 'images' directory, and each image is uniquely identified with a filename (e.g., 'image_0.png'). The images have a resolution of 512x512 pixels.
35
+
36
+ ## Data Format
37
+
38
+ The dataset is provided in the Hugging Face datasets format, with each sample containing the following information:
39
+
40
+ - `image_path`: Local file path to the image.
41
+ - `caption`: Generated caption for the corresponding image.
42
+
43
+ ## Usage
44
 
45
+ You can use this dataset for training, fine-tuning, and evaluating image captioning models. The captions can be leveraged for tasks such as generating natural language descriptions for iOS app icons.
46
 
47
+ ## Acknowledgments
 
48
 
49
+ - iOS Icon Gallery: [https://www.iosicongallery.com](https://www.iosicongallery.com)
50
+ - Blip Image Captioning model: [Salesforce/blip-image-captioning-large](https://huggingface.co/Salesforce/blip-image-captioning-large)
51
 
52
+ ## License
53
 
54
+ This dataset is released under the [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0). Please review the license for details.