huggingartists

README.md

@@ -1,76 +1,43 @@
 ---
-languages:
-- en
+language: en
+datasets:
+- huggingartists/ciggy-blacc
 tags:
 - huggingartists
 - lyrics
+- lm-head
+- causal-lm
+widget:
+- text: "I am"
 ---
 
-# 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:** 0.175239 MB
-
-
- <div class="inline-flex flex-col" style="line-height: 1.5;">
+<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>
-    <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; margin-top: 3px; font-size: 16px; font-weight: 800">🤖 HuggingArtists Model 🤖</div>
     <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>
 
-### 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).
+I was made with [huggingartists](https://github.com/AlekseyKorshuk/huggingartists).
 
-### Supported Tasks and Leaderboards
+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)!
 
-[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+## How does it work?
 
-### Languages
+To understand how the model was developed, check the [W&B report](https://wandb.ai/huggingartists/huggingartists/reportlist).
 
-en
+## Training data
 
-## How to use
+The model was trained on lyrics from Ciggy Blacc.
 
-How to load this dataset directly with the datasets library:
+Dataset is available [here](https://huggingface.co/datasets/huggingartists/ciggy-blacc).
+And can be used with:
 
 ```python
 from datasets import load_dataset
@@ -78,116 +45,42 @@ from datasets import load_dataset
 dataset = load_dataset("huggingartists/ciggy-blacc")
 ```
 
-## Dataset Structure
+[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.
 
-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..."
-}
-```
+## Training procedure
 
-### Data Fields
+The model is based on a pre-trained [GPT-2](https://huggingface.co/gpt2) which is fine-tuned on Ciggy Blacc's lyrics.
 
-The data fields are the same among all splits.
+Hyperparameters and metrics are recorded in the [W&B training run](https://wandb.ai/huggingartists/huggingartists/runs/1xsvugxq) for full transparency and reproducibility.
 
-- `text`: a `string` feature.
+At the end of training, [the final model](https://wandb.ai/huggingartists/huggingartists/runs/1xsvugxq/artifacts) is logged and versioned.
 
+## How to use
 
-### Data Splits
-
-| train |validation|test|
-|------:|---------:|---:|
-|23|         -|   -|
-
-'Train' can be easily divided into 'train' & 'validation' & 'test' with few lines of code:
+You can use this model directly with a pipeline for text generation:
 
 ```python
-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
-
-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)})
-    }
-)
+from transformers import pipeline
+generator = pipeline('text-generation',
+                     model='huggingartists/ciggy-blacc')
+generator("I am", num_return_sequences=5)
 ```
 
-## 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
+Or with Transformers library:
 
-#### 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
+```python
+from transformers import AutoTokenizer, AutoModelWithLMHead
+  
+tokenizer = AutoTokenizer.from_pretrained("huggingartists/ciggy-blacc")
 
-[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+model = AutoModelWithLMHead.from_pretrained("huggingartists/ciggy-blacc")
+```
 
-### Citation Information
+## Limitations and bias
 
-```
-@InProceedings{huggingartists,
-    author={Aleksey Korshuk}
-    year=2022
-}
-```
+The model suffers from [the same limitations and bias as GPT-2](https://huggingface.co/gpt2#limitations-and-bias).
 
+In addition, the data present in the user's tweets further affects the text generated by the model.
 
 ## About
 

config.json

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

evaluation.txt

@@ -0,0 +1 @@
+{"eval_loss": 4.902784824371338, "eval_runtime": 0.1191, "eval_samples_per_second": 75.591, "eval_steps_per_second": 16.798, "epoch": 5.0}

flax_model.msgpack

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

optimizer.pt

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

pytorch_model.bin

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

rng_state.pth

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

scheduler.pt

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

special_tokens_map.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6f50ab5a5a509a1c309d6171f339b196a900dc9c99ad0408ff23bb615fdae7ad
+size 99

tokenizer.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:86f12f9648802a0c45c4b87ef2ab235e9bfdf1a43cc40571291507c81e35c4c3
+size 2107625

tokenizer_config.json

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

trainer_state.json

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

training_args.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:064dbbf5562739d669c7c4893b5b81f65048954db9773f39f2597a7cc84a3aa6
+size 3311

vocab.json

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