huggingartists

.gitattributes

@@ -14,3 +14,4 @@
 *.pb filter=lfs diff=lfs merge=lfs -text
 *.pt filter=lfs diff=lfs merge=lfs -text
 *.pth filter=lfs diff=lfs merge=lfs -text
+*.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,188 @@
+---
+languages:
+- en
+tags:
+- huggingartists
+- lyrics
+---
+
+# Dataset Card for "huggingartists/nirvana"
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [How to use](#how-to-use)
+- [Dataset Structure](#dataset-structure)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+
+## Dataset Description
+
+- **Homepage:** [https://github.com/AlekseyKorshuk/huggingartists](https://github.com/AlekseyKorshuk/huggingartists)
+- **Repository:** [https://github.com/AlekseyKorshuk/huggingartists](https://github.com/AlekseyKorshuk/huggingartists)
+- **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Point of Contact:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Size of the generated dataset:** 0.336531 MB
+
+
+ <div class="inline-flex flex-col" style="line-height: 1.5;">
+    <div class="flex">
+        <div style="display:DISPLAY_1; margin-left: auto; margin-right: auto; width: 92px; height:92px; border-radius: 50%; background-size: cover; background-image: url(&#39;https://images.genius.com/4c1373962cfc3a668a3e30da9a76a34c.640x640x1.jpg&#39;)">
+        </div>
+    </div>
+    <a href="https://huggingface.co/huggingartists/nirvana">
+      <div style="text-align: center; margin-top: 3px; font-size: 16px; font-weight: 800">🤖 HuggingArtists Model 🤖</div>
+    </a>
+    <div style="text-align: center; font-size: 16px; font-weight: 800">Nirvana</div>
+    <a href="https://genius.com/artists/nirvana">
+    	<div style="text-align: center; font-size: 14px;">@nirvana</div>
+    </a>
+</div>
+
+### Dataset Summary
+
+ The Lyrics dataset parsed from Genius. This dataset is designed to generate lyrics with HuggingArtists.
+ Model is available [here](https://huggingface.co/huggingartists/nirvana).
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Languages
+
+en
+
+## How to use
+
+How to load this dataset directly with the datasets library:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("huggingartists/nirvana")
+```
+
+## Dataset Structure
+
+An example of 'train' looks as follows.
+```
+This example was too long and was cropped:
+
+{
+    "text": "Look, I was gonna go easy on you\nNot to hurt your feelings\nBut I'm only going to get this one chance\nSomething's wrong, I can feel it..."
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+- `text`: a `string` feature.
+
+
+### Data Splits
+
+| train |validation|test|
+|------:|---------:|---:|
+|TRAIN_0.336531|         -|   -|
+
+'Train' can be easily divided into 'train' & 'validation' & 'test' with few lines of code:
+
+```python
+from datasets import load_dataset, Dataset, DatasetDict
+import numpy as np
+
+datasets = load_dataset("huggingartists/nirvana")
+
+train_percentage = 0.9
+validation_percentage = 0.07
+test_percentage = 0.03
+
+train, validation, test = np.split(datasets['train']['text'], [int(len(datasets['train']['text'])*train_percentage), int(len(datasets['train']['text'])*(train_percentage + validation_percentage))])
+
+datasets = DatasetDict(
+    {
+        'train': Dataset.from_dict({'text': list(train)}),
+        'validation': Dataset.from_dict({'text': list(validation)}),
+        'test': Dataset.from_dict({'text': list(test)})
+    }
+)
+```
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the source language producers?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the annotators?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Personal and Sensitive Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Discussion of Biases
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Other Known Limitations
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Licensing Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Citation Information
+
+```
+@InProceedings{huggingartists,
+    author={Aleksey Korshuk}
+    year=2021
+}
+```

datasets.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:36df4cc030f1e60a8122940980cf202dc5ebd7765eca40297d7c5e846dfc8b27
+size 309320

nirvana.py

@@ -0,0 +1,107 @@
+# coding=utf-8
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Lyrics dataset parsed from Genius"""
+
+
+import csv
+import json
+import os
+import gzip
+
+import datasets
+
+
+_CITATION = """\
+@InProceedings{huggingartists:dataset,
+title = {Lyrics dataset},
+author={Aleksey Korshuk
+},
+year={2021}
+}
+"""
+
+
+_DESCRIPTION = """\
+This dataset is designed to generate lyrics with HuggingArtists.
+"""
+
+# Add a link to an official homepage for the dataset here
+_HOMEPAGE = "https://github.com/AlekseyKorshuk/huggingartists"
+
+# Add the licence for the dataset here if you can find it
+_LICENSE = "All rights belong to copyright holders"
+
+_URL = "https://huggingface.co/datasets/huggingartists/nirvana/resolve/main/datasets.json"
+
+# Name of the dataset
+class LyricsDataset(datasets.GeneratorBasedBuilder):
+    """Lyrics dataset"""
+
+    VERSION = datasets.Version("1.0.0")
+
+    def _info(self):
+        # This method specifies the datasets.DatasetInfo object which contains informations and typings for the dataset
+        features = datasets.Features(
+                {
+                    "text": datasets.Value("string"),
+                }
+            )
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=_DESCRIPTION,
+            # This defines the different columns of the dataset and their types
+            features=features,  # Here we define them above because they are different between the two configurations
+            # If there's a common (input, target) tuple from the features,
+            # specify them here. They'll be used if as_supervised=True in
+            # builder.as_dataset.
+            supervised_keys=None,
+            # Homepage of the dataset for documentation
+            homepage=_HOMEPAGE,
+            # License for the dataset if available
+            license=_LICENSE,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        # This method is tasked with downloading/extracting the data and defining the splits depending on the configuration
+        # If several configurations are possible (listed in BUILDER_CONFIGS), the configuration selected by the user is in self.config.name
+
+        # dl_manager is a datasets.download.DownloadManager that can be used to download and extract URLs
+        # It can accept any type or nested list/dict and will give back the same structure with the url replaced with path to local files.
+        # By default the archives will be extracted and a path to a cached folder where they are extracted is returned instead of the archive
+
+        data_dir = dl_manager.download_and_extract(_URL)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": data_dir,
+                    "split": "train",
+                },
+            ),
+        ]
+        
+
+    def _generate_examples(self, filepath, split):
+        """Yields examples as (key, example) tuples."""
+        # This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
+        
+        with open(filepath, encoding="utf-8") as f:
+            data = json.load(f)
+            for id, pred in enumerate(data[split]):
+                yield id, {"text": pred}