Linaqruf commited on
Commit
0928e7d
Β·
1 Parent(s): 3a45a5c

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +128 -0
README.md ADDED
@@ -0,0 +1,128 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-4.0
3
+ ---
4
+ # Bandori Card Dataset
5
+
6
+ This dataset contains a collection of cards from the game "BanG Dream! Girls Band Party!" (Bandori). It includes card metadata such as ID, rarity, name, and artwork URLs. The dataset is organized based on card rarity and includes corresponding artwork images.
7
+
8
+ ## Dataset Structure
9
+
10
+ The dataset follows the following file structure:
11
+ ```
12
+ /
13
+ β”œβ”€β”€ images/
14
+ β”‚ β”œβ”€β”€ rarity1/
15
+ β”‚ β”‚ β”œβ”€β”€ Bushido%21.png
16
+ β”‚ β”‚ β”œβ”€β”€ Cat-Eared_Producer.png
17
+ β”‚ β”‚ β”œβ”€β”€ Cool_%26_Fierce_Singer.png
18
+ β”‚ β”‚ └── ...
19
+ β”‚ β”œβ”€β”€ rarity2/
20
+ β”‚ β”‚ β”œβ”€β”€ %E2%99%A1For_you.png
21
+ β”‚ β”‚ β”œβ”€β”€ A_Caring_Princess.png
22
+ β”‚ β”‚ β”œβ”€β”€ A_Crucial_Member.png
23
+ β”‚ β”‚ └── ...
24
+ β”‚ β”œβ”€β”€ rarity3/
25
+ β”‚ β”‚ β”œβ”€β”€ %22Just_a_Bite%22_Surprise.png
26
+ β”‚ β”‚ β”œβ”€β”€ 1%2C_2%2C_3%2C_to_the_Light.png
27
+ β”‚ β”‚ β”œβ”€β”€ 180_Degrees%2C_12_Minutes.png
28
+ β”‚ β”‚ └── ...
29
+ β”‚ β”œβ”€β”€ rarity4/
30
+ β”‚ β”‚ β”œβ”€β”€ %22Dramatic%22_Daily_Life.png
31
+ β”‚ β”‚ β”œβ”€β”€ %22The_School_Prince%22.png
32
+ β”‚ β”‚ β”œβ”€β”€ %E2%88%9ESurprise%21.png
33
+ β”‚ β”‚ └── ...
34
+ β”‚ └── rarity5/
35
+ β”‚ β”œβ”€β”€ Afternoon_Coffee_T.png
36
+ β”‚ β”œβ”€β”€ Autumn_Dream_T.png
37
+ β”‚ β”œβ”€β”€ Blue-Tinted_Stroll_T.png
38
+ β”‚ └── ...
39
+ └── metadata/
40
+ β”œβ”€β”€ rarity1.json
41
+ β”œβ”€β”€ rarity2.json
42
+ β”œβ”€β”€ rarity3.json
43
+ β”œβ”€β”€ rarity4.json
44
+ └── rarity5.json
45
+ ```
46
+
47
+ The `images` folder contains subfolders for each rarity level (rarity1, rarity2, etc.), and within each rarity folder, you can find the corresponding card artwork images.
48
+
49
+ The `metadata` folder contains JSON files for each rarity level, containing card metadata in the following format:
50
+
51
+ ```json
52
+ [
53
+ {
54
+ "id": 1,
55
+ "rarity": 1,
56
+ "name": "Bushido!",
57
+ "art_url": "https://example.com/images/rarity1/Bushido%21.png"
58
+ },
59
+ {
60
+ "id": 2,
61
+ "rarity": 1,
62
+ "name": "Cat-Eared Producer",
63
+ "art_url": "https://example.com/images/rarity1/Cat-Eared_Producer.png"
64
+ },
65
+ ...
66
+ ]
67
+ ```
68
+
69
+ ## Usage
70
+ To use this dataset, you can download a zipfile from this [direct link](https://huggingface.co/datasets/Linaqruf/bandori-card-dataset/resolve/main/bandori-card-dataset.zip) or download the artwork images and access the metadata for each card by using [Bandori Wiki Scraper](https://colab.research.google.com/github/Linaqruf/Scraper/blob/main/Bandori_Wiki_Scraper.ipynb) notebook. The metadata provides information such as card ID, rarity level, name, and the URL of the artwork image.
71
+
72
+ ## Image Count
73
+ The total number of image files is `1454`, distributed across the different rarity levels as follows:
74
+ ```
75
+ Rarity1: 35 images
76
+ Rarity2: 404 images
77
+ Rarity3: 448 images
78
+ Rarity4: 546 images
79
+ Rarity5: 21 images
80
+ ```
81
+ Please note that the numbers may vary based on the dataset version.
82
+
83
+ # License
84
+ The Bandori Card Dataset is provided under the [Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/) license.
85
+
86
+ # Acknowledgments
87
+ We would like to acknowledge the [BanG Dream! Girls Band Party! Fandom](https://bandori.fandom.com/) website for providing the card data and artwork used in this dataset.
88
+
89
+ ## Limitations
90
+
91
+ While the Bandori Card Dataset strives to provide comprehensive card data and artwork from the BanG Dream! Girls Band Party! game, there are a few limitations to be aware of:
92
+
93
+ 1. **Incomplete Image Coverage**: The dataset includes card data and artwork from a range of card rarities and IDs up to an index of 1-1800. However, it's important to note that only 1453 images are available in the dataset. This means that there might be gaps in the image coverage for certain card IDs within the specified index range.
94
+
95
+ 2. **Incomplete Coverage**: Additionally, the dataset covers a range of card rarities and IDs up to a specific maximum index. However, there may be newer cards or updates to the game that are not included in the dataset. It's advisable to cross-reference the dataset with the latest game data for the most up-to-date information.
96
+
97
+ 3. **Website Structure Dependency**: The scraper code relies on the specific HTML structure of the BanG Dream! Girls Band Party! Fandom website. Any changes to the website structure may impact the scraper's ability to extract card data accurately. It's important to monitor and adjust the scraper code accordingly if there are changes to the website.
98
+
99
+ 4. **Data Integrity**: While efforts have been made to ensure the accuracy and completeness of the dataset, errors or discrepancies in the card data and artwork may exist. Users are encouraged to verify and validate the dataset independently for their specific use cases.
100
+
101
+ ## Data Quality
102
+
103
+ The Bandori Card Dataset aims to provide high-quality card data and artwork. Here are a few considerations regarding the dataset's organization and image files:
104
+
105
+ 1. **Image File Separation by Rarity**: The artwork images in the dataset are organized and stored in separate folders based on the card rarity, rather than the index. Each rarity level has its own folder in the `images` directory, making it easier to locate images based on their rarity. Please refer to the directory structure provided in the repository for more details.
106
+
107
+ 2. **Data Source**: The card data and artwork are sourced from the BanG Dream! Girls Band Party! Fandom website. The dataset quality is dependent on the accuracy and consistency of the information available on the website. It's advisable to refer to official game sources for authoritative data.
108
+
109
+ 3. **Artwork Resolution**: The artwork images in the dataset are obtained from the website and may vary in resolution and quality. The provided images are the best available representations within the limitations of the source material.
110
+
111
+ 4. **Metadata Accuracy**: The metadata provided in the dataset, including card ID, rarity, and name, is extracted from the website. While efforts have been made to ensure accuracy, there may be instances of typographical errors or discrepancies between the dataset and the actual game data.
112
+
113
+ If you encounter any significant issues with the dataset's quality or have suggestions for improvement, please feel free to contribute or reach out to us using the contact information provided below.
114
+
115
+
116
+
117
+ # Citation
118
+ If you use this dataset in your research or any other work, please consider citing it as:
119
+ ```
120
+ @dataset{linaqruf/bandori-card-dataset,
121
+ author = {Your Name},
122
+ title = {Bandori Card Dataset},
123
+ year = {2023},
124
+ publisher = {Hugging Face},
125
+ version = {1.0},
126
+ url = {https://huggingface.co/datasets/Linaqruf/bandori-card-dataset}
127
+ }
128
+ ```