Create README

README.md

@@ -0,0 +1,169 @@
+---
+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 super worlds
+---
+
+# Mario Maker 2 super worlds
+Part of the [Mario Maker 2 Dataset Collection](https://tgrcode.com/posts/mario_maker_2_datasets)
+
+## Dataset Description
+The Mario Maker 2 super worlds dataset consists of 289 thousand super worlds from Nintendo's online service totaling around 13.5GB of data. 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
+The Mario Maker 2 super worlds dataset is a very large dataset so for most use cases it is recommended to make use of the streaming API of `datasets`. You can load and iterate through the dataset with the following code:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("TheGreatRambler/mm2_world", streaming=True, split="train")
+print(next(iter(ds)))
+
+#OUTPUT:
+{
+ 'pid': '14510618610706594411',
+ 'world_id': 'c96012bef256ba6b_20200513204805563301',
+ 'worlds': 1,
+ 'levels': 5,
+ 'planet_type': 0,
+ 'created': 1589420886,
+ 'unk1': [some binary data],
+ 'unk5': 3,
+ 'unk6': 1,
+ 'unk7': 1,
+ 'thumbnail': [some binary data]
+}
+```
+Each row is a unique super world denoted by the `world_id` created by the player denoted by the `pid`. Thumbnails are binary PNGs.
+
+You can also download the full dataset. Note that this will download ~13.5GB:
+```python
+ds = load_dataset("TheGreatRambler/mm2_world", split="train")
+```
+
+## Data Structure
+
+### Data Instances
+
+```python
+{
+ 'pid': '14510618610706594411',
+ 'world_id': 'c96012bef256ba6b_20200513204805563301',
+ 'worlds': 1,
+ 'levels': 5,
+ 'planet_type': 0,
+ 'created': 1589420886,
+ 'unk1': [some binary data],
+ 'unk5': 3,
+ 'unk6': 1,
+ 'unk7': 1,
+ 'thumbnail': [some binary data]
+}
+```
+
+### Data Fields
+
+|Field|Type|Description|
+|---|---|---|
+|pid|string|The player ID of the user who created this super world|
+|world_id|string|World ID|
+|worlds|int|Number of worlds|
+|levels|int|Number of levels|
+|planet_type|int|Planet type, enum below|
+|created|int|UTC timestamp of when this super world was created|
+|unk1|bytes|Unknown|
+|unk5|int|Unknown|
+|unk6|int|Unknown|
+|unk7|int|Unknown|
+|thumbnail|bytes|The thumbnail, as a JPEG binary|
+|thumbnail_url|string|The old URL of this thumbnail|
+|thumbnail_size|int|The filesize of this thumbnail|
+|thumbnail_filename|string|The filename of this thumbnail|
+
+### 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
+SuperWorldPlanetType = {
+	0: "Earth",
+	1: "Moon",
+	2: "Sand",
+	3: "Green",
+	4: "Ice",
+	5: "Ringed",
+	6: "Red",
+	7: "Spiral"
+}
+```
+
+<!-- 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 consists of super worlds from many different Mario Maker 2 players globally and as such harmful depictions could be present in their super world thumbnails.

example.py

@@ -0,0 +1,4 @@
+from datasets import load_dataset
+
+ds = load_dataset("TheGreatRambler/mm2_world", streaming=True, split="train", use_auth_token=True)
+print(next(iter(ds)))