Create README

README.md

@@ -0,0 +1,148 @@
+---
+language:
+- multilingual
+license:
+- cc-by-nc-sa-4.0
+multilinguality:
+- multilingual
+size_categories:
+- 100M<n<1B
+source_datasets:
+- original
+task_categories:
+- text-generation
+- structure-prediction
+- object-detection
+- text-mining
+- information-retrieval
+- other
+task_ids:
+- other
+pretty_name: Mario Maker 2 user badges
+---
+
+# Mario Maker 2 user badges
+Part of the [Mario Maker 2 Dataset Collection](https://tgrcode.com/posts/mario_maker_2_datasets)
+
+## Dataset Description
+The Mario Maker 2 user badges dataset consists of 9328 user badges (they are capped to 10k globally) from Nintendo's online service and adds onto `TheGreatRambler/mm2_user`. The dataset was created using the self-hosted [Mario Maker 2 api](https://tgrcode.com/posts/mario_maker_2_api) over the course of 1 month in February 2022.
+
+### How to use it
+You can load and iterate through the dataset with the following code:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("TheGreatRambler/mm2_user_badges", split="train")
+print(next(iter(ds)))
+
+#OUTPUT:
+{
+ 'pid': '1779763691699286988',
+ 'type': 4,
+ 'rank': 6
+}
+```
+Each row is a badge awarded to the player denoted by `pid`. `TheGreatRambler/mm2_user` contains these players.
+
+## Data Structure
+
+### Data Instances
+
+```python
+{
+ 'pid': '1779763691699286988',
+ 'type': 4,
+ 'rank': 6
+}
+```
+
+### Data Fields
+
+|Field|Type|Description|
+|---|---|---|
+|pid|string|Player ID|
+|type|int|The kind of badge, enum below|
+|rank|int|The rank of badge, enum below|
+
+### Data Splits
+
+The dataset only contains a train split.
+
+## Enums
+
+The dataset contains some enum integer fields. This can be used to convert back to their string equivalents:
+
+```python
+BadgeTypes = {
+	0: "Maker Points (All-Time)",
+	1: "Endless Challenge (Easy)",
+	2: "Endless Challenge (Normal)",
+	3: "Endless Challenge (Expert)",
+	4: "Endless Challenge (Super Expert)",
+	5: "Multiplayer Versus",
+	6: "Number of Clears",
+	7: "Number of First Clears",
+	8: "Number of World Records",
+	9: "Maker Points (Weekly)"
+}
+
+BadgeRanks = {
+	6: "Bronze",
+	5: "Silver",
+	4: "Gold",
+	3: "Bronze Ribbon",
+	2: "Silver Ribbon",
+	1: "Gold Ribbon"
+}
+```
+
+<!-- TODO create detailed statistics -->
+<!--
+## Dataset Statistics
+
+The dataset contains 115M files and the sum of all the source code file sizes is 873 GB (note that the size of the dataset is larger due to the extra fields). A breakdown per language is given in the plot and table below:
+
+![dataset-statistics](https://huggingface.co/datasets/codeparrot/github-code/resolve/main/github-code-stats-alpha.png)
+
+|    | Language     |File Count| Size (GB)|
+|---:|:-------------|---------:|-------:|
+|  0 | Java         | 19548190 | 107.70 |
+|  1 | C            | 14143113 | 183.83 |
+|  2 | JavaScript   | 11839883 |  87.82 |
+|  3 | HTML         | 11178557 | 118.12 |
+|  4 | PHP          | 11177610 |  61.41 |
+|  5 | Markdown     |  8464626 |  23.09 |
+|  6 | C++          |  7380520 |  87.73 |
+|  7 | Python       |  7226626 |  52.03 |
+|  8 | C#           |  6811652 |  36.83 |
+|  9 | Ruby         |  4473331 |  10.95 |
+| 10 | GO           |  2265436 |  19.28 |
+| 11 | TypeScript   |  1940406 |  24.59 |
+| 12 | CSS          |  1734406 |  22.67 |
+| 13 | Shell        |  1385648 |   3.01 |
+| 14 | Scala        |   835755 |   3.87 |
+| 15 | Makefile     |   679430 |   2.92 |
+| 16 | SQL          |   656671 |   5.67 |
+| 17 | Lua          |   578554 |   2.81 |
+| 18 | Perl         |   497949 |   4.70 |
+| 19 | Dockerfile   |   366505 |   0.71 |
+| 20 | Haskell      |   340623 |   1.85 |
+| 21 | Rust         |   322431 |   2.68 |
+| 22 | TeX          |   251015 |   2.15 |
+| 23 | Batchfile    |   236945 |   0.70 |
+| 24 | CMake        |   175282 |   0.54 |
+| 25 | Visual Basic |   155652 |   1.91 |
+| 26 | FORTRAN      |   142038 |   1.62 |
+| 27 | PowerShell   |   136846 |   0.69 |
+| 28 | Assembly     |    82905 |   0.78 |
+| 29 | Julia        |    58317 |   0.29 |
+-->
+
+## Dataset Creation
+
+The dataset was created over a little more than a month in Febuary 2022 using the self hosted [Mario Maker 2 api](https://tgrcode.com/posts/mario_maker_2_api). As requests made to Nintendo's servers require authentication the process had to be done with upmost care and limiting download speed as to not overload the API and risk a ban. There are no intentions to create an updated release of this dataset.
+
+## Considerations for Using the Data
+
+The dataset contains no harmful language or depictions.