huggingartists

README.md

@@ -1,43 +1,76 @@
 ---
-language: en
-datasets:
-- huggingartists/ciggy-blacc
+languages:
+- en
 tags:
 - huggingartists
 - lyrics
-- lm-head
-- causal-lm
-widget:
-- text: "I am"
 ---
 
-<div class="inline-flex flex-col" style="line-height: 1.5;">
+# Dataset Card for "huggingartists/ciggy-blacc"
+
+## 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)
+- [About](#about)
+
+## 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:** 4014.257119 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/7ba8a81d32ea254df43b31447958e85f.500x500x1.png&#39;)">
+        <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/7ba8a81d32ea254df43b31447958e85f.500x500x1.png&#39;)">
         </div>
     </div>
-    <div style="text-align: center; margin-top: 3px; font-size: 16px; font-weight: 800">🤖 HuggingArtists Model 🤖</div>
+    <a href="https://huggingface.co/huggingartists/ciggy-blacc">
+      <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">Ciggy Blacc</div>
     <a href="https://genius.com/artists/ciggy-blacc">
     	<div style="text-align: center; font-size: 14px;">@ciggy-blacc</div>
     </a>
 </div>
 
-I was made with [huggingartists](https://github.com/AlekseyKorshuk/huggingartists).
+### 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/ciggy-blacc).
 
-Create your own bot based on your favorite artist with [the demo](https://colab.research.google.com/github/AlekseyKorshuk/huggingartists/blob/master/huggingartists-demo.ipynb)!
+### Supported Tasks and Leaderboards
 
-## How does it work?
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-To understand how the model was developed, check the [W&B report](https://wandb.ai/huggingartists/huggingartists/reportlist).
+### Languages
 
-## Training data
+en
 
-The model was trained on lyrics from Ciggy Blacc.
+## How to use
 
-Dataset is available [here](https://huggingface.co/datasets/huggingartists/ciggy-blacc).
-And can be used with:
+How to load this dataset directly with the datasets library:
 
 ```python
 from datasets import load_dataset
@@ -45,42 +78,116 @@ from datasets import load_dataset
 dataset = load_dataset("huggingartists/ciggy-blacc")
 ```
 
-[Explore the data](https://wandb.ai/huggingartists/huggingartists/runs/ei5jqzy8/artifacts), which is tracked with [W&B artifacts](https://docs.wandb.com/artifacts) at every step of the pipeline.
+## Dataset Structure
 
-## Training procedure
+An example of 'train' looks as follows.
+```
+This example was too long and was cropped:
 
-The model is based on a pre-trained [GPT-2](https://huggingface.co/gpt2) which is fine-tuned on Ciggy Blacc's lyrics.
+{
+    "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..."
+}
+```
 
-Hyperparameters and metrics are recorded in the [W&B training run](https://wandb.ai/huggingartists/huggingartists/runs/1xsvugxq) for full transparency and reproducibility.
+### Data Fields
 
-At the end of training, [the final model](https://wandb.ai/huggingartists/huggingartists/runs/1xsvugxq/artifacts) is logged and versioned.
+The data fields are the same among all splits.
 
-## How to use
+- `text`: a `string` feature.
 
-You can use this model directly with a pipeline for text generation:
 
-```python
-from transformers import pipeline
-generator = pipeline('text-generation',
-                     model='huggingartists/ciggy-blacc')
-generator("I am", num_return_sequences=5)
-```
+### Data Splits
+
+| train |validation|test|
+|------:|---------:|---:|
+|23|         -|   -|
 
-Or with Transformers library:
+'Train' can be easily divided into 'train' & 'validation' & 'test' with few lines of code:
 
 ```python
-from transformers import AutoTokenizer, AutoModelWithLMHead
-  
-tokenizer = AutoTokenizer.from_pretrained("huggingartists/ciggy-blacc")
+from datasets import load_dataset, Dataset, DatasetDict
+import numpy as np
+
+datasets = load_dataset("huggingartists/ciggy-blacc")
+
+train_percentage = 0.9
+validation_percentage = 0.07
+test_percentage = 0.03
 
-model = AutoModelWithLMHead.from_pretrained("huggingartists/ciggy-blacc")
+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)})
+    }
+)
 ```
 
-## Limitations and bias
+## 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
 
-The model suffers from [the same limitations and bias as GPT-2](https://huggingface.co/gpt2#limitations-and-bias).
+[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=2022
+}
+```
 
-In addition, the data present in the user's tweets further affects the text generated by the model.
 
 ## About