tooni commited on
Commit
e3d193a
·
1 Parent(s): 99e3a20

docs: add readme

Browse files
Files changed (1) hide show
  1. README.md +137 -0
README.md ADDED
@@ -0,0 +1,137 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Dataset Card for Pokemon Cards TCG
2
+
3
+ ## Dataset Description
4
+
5
+ - **Repository:** [tooniez/pokemoncards_tcg](https://huggingface.co/datasets/tooniez/pokemoncards_tcg)
6
+ - **Point of Contact:** [Your contact information or GitHub profile]
7
+
8
+ ### Dataset Summary
9
+
10
+ This dataset contains information about Pokemon Trading Card Game (TCG) cards, decks, and sets. It is designed to be used for training machine learning models to classify and analyze Pokemon cards.
11
+
12
+ ### Supported Tasks and Leaderboards
13
+
14
+ - **Tasks:**
15
+ - Image Classification
16
+ - Text Classification
17
+ - Information Retrieval
18
+
19
+ ### Languages
20
+
21
+ The dataset is primarily in English.
22
+
23
+ ## Dataset Structure
24
+
25
+ ### Data Instances
26
+
27
+ The dataset consists of three main components:
28
+
29
+ 1. Cards: Detailed information about individual Pokemon cards.
30
+ 2. Decks: Collections of cards forming playable decks.
31
+ 3. Sets: Information about different Pokemon card sets.
32
+
33
+ ### Data Fields
34
+
35
+ - Cards:
36
+ - id: Unique identifier for the card
37
+ - name: Name of the Pokemon or card
38
+ - supertype: Type of card (e.g., Pokemon, Trainer, Energy)
39
+ - subtypes: Subtypes of the card
40
+ - hp: Hit points (for Pokemon cards)
41
+ - types: Element types of the Pokemon
42
+ - evolves_from: Name of the Pokemon this card evolves from
43
+ - abilities: Special abilities of the Pokemon
44
+ - attacks: Attacks the Pokemon can use
45
+ - weaknesses: Elemental weaknesses
46
+ - resistances: Elemental resistances
47
+ - retreat_cost: Cost to retreat the Pokemon
48
+ - converted_retreat_cost: Numeric value of retreat cost
49
+ - set: Set the card belongs to
50
+ - number: Card number within the set
51
+ - artist: Name of the card artist
52
+ - rarity: Rarity of the card
53
+ - flavor_text: Descriptive text on the card
54
+ - national_pokedex_numbers: Pokedex numbers for the Pokemon
55
+ - legalities: Legal status in different game formats
56
+ - images: URLs to card images
57
+ <!-- - tcgplayer: Price information from TCGPlayer
58
+ - cardmarket: Price information from Cardmarket -->
59
+
60
+ - Decks:
61
+ - id: Unique identifier for the deck
62
+ - name: Name of the deck
63
+ - types: Types of cards in the deck
64
+ - card_id: Unique identifier for each card in the deck
65
+ - card_name: Name of each card in the deck
66
+ - card_rarity: Rarity of each card in the deck
67
+ - card_count: Number of copies of each card in the deck
68
+
69
+ - Sets:
70
+ - id: Unique identifier for the set
71
+ - name: Name of the set
72
+ - series: Series the set belongs to
73
+ - printedTotal: Total number of cards printed in the set
74
+ - total: Total number of cards in the set
75
+ - legalities: Legal status in different game formats
76
+ - ptcgoCode: Code used in the Pokemon Trading Card Game Online
77
+ - releaseDate: Date the set was released
78
+ - updatedAt: Date the set information was last updated
79
+ - symbol_image_source: URL to the set symbol image
80
+ - logo_image_source: URL to the set logo image
81
+
82
+
83
+ ## Dataset Creation
84
+
85
+ ### Curation Rationale
86
+
87
+ This dataset was created to provide a comprehensive resource for Pokemon TCG enthusiasts, collectors, and researchers. It aims to facilitate machine learning projects related to card classification, price prediction, and deck analysis.
88
+
89
+ ### Source Data
90
+
91
+ #### Initial Data Collection and Normalization
92
+
93
+ [Describe the process of data collection and any normalization steps]
94
+
95
+ #### Who are the source language producers?
96
+
97
+ The data is sourced from official Pokemon TCG information and community-contributed data.
98
+
99
+ ### Annotations
100
+
101
+ [If there are any annotations in the dataset, describe them here]
102
+
103
+ ### Personal and Sensitive Information
104
+
105
+ This dataset does not contain personal or sensitive information.
106
+
107
+ ## Considerations for Using the Data
108
+
109
+ ### Social Impact of Dataset
110
+
111
+ This dataset can contribute to the Pokemon TCG community by enabling research and tool development for card analysis and deck building.
112
+
113
+ ### Discussion of Biases
114
+
115
+ [Discuss any potential biases in the dataset, if applicable]
116
+
117
+ ### Other Known Limitations
118
+
119
+ [Mention any known limitations of the dataset]
120
+
121
+ ## Additional Information
122
+
123
+ ### Dataset Curators
124
+
125
+ [Information about the dataset curators]
126
+
127
+ ### Licensing Information
128
+
129
+ [Specify the license under which the dataset is released]
130
+
131
+ ### Citation Information
132
+
133
+ [If there's a specific way to cite this dataset, include it here]
134
+
135
+ ### Contributions
136
+
137
+ [Information about how to contribute to the dataset, if applicable]