Update README.md

README.md

@@ -1,37 +1,38 @@
 ---
-license: apache-2.0
+license: mit
 tags:
 - generated_from_trainer
 metrics:
 - accuracy
 model-index:
-- name: training\
+- name: e621TagAutocomplete
   results: []
+co2_eq_emissions: 100
+language:
+- en
+library_name: transformers
+pipeline_tag: text-generation
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+## Model description
+
+This is a fine-tuned version of [distilgpt2](https://huggingface.co/distilgpt2) which is intended to be used with the [promptgen](https://github.com/AUTOMATIC1111/stable-diffusion-webui-promptgen) extension inside the AUTOMATIC1111 WebUI.
+It is trained on the raw tags of e621 with underscores and spaces
 
-# training\
 
-This model is a fine-tuned version of [distilgpt2](https://huggingface.co/distilgpt2) on an unknown dataset.
+# Training
+
+This model is a fine-tuned version of [distilgpt2](https://huggingface.co/distilgpt2) on a dataset of the tags of 116k random posts of e621.net.
 It achieves the following results on the evaluation set:
 - Loss: 4.3983
 - Accuracy: 0.3865
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
 
 ## Training and evaluation data
 
-More information needed
 
-## Training procedure
+Use this collab notebook to train your own model. Also used to train this model
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/0Tick/stable-diffusion-tools/blob/main/distilgpt2train.ipynb)
 
 ### Training hyperparameters
 
@@ -44,7 +45,25 @@ The following hyperparameters were used during training:
 - lr_scheduler_type: linear
 - num_epochs: 3.0
 
-### Training results
+## Intended uses & limitations
+
+Since DistilGPT2 is a distilled version of GPT-2, it is intended to be used for similar use cases with the increased functionality of being smaller and easier to run than the base model. 
+
+The developers of GPT-2 state in their [model card](https://github.com/openai/gpt-2/blob/master/model_card.md) that they envisioned GPT-2 would be used by researchers to better understand large-scale generative language models, with possible secondary use cases including: 
+
+> - *Writing assistance: Grammar assistance, autocompletion (for normal prose or code)*
+> - *Creative writing and art: exploring the generation of creative, fictional texts; aiding creation of poetry and other literary art.*
+> - *Entertainment: Creation of games, chat bots, and amusing generations.*
+
+Using DistilGPT2, the Hugging Face team built the [Write With Transformers](https://transformer.huggingface.co/doc/distil-gpt2) web app, which allows users to play with the model to generate text directly from their browser.
+
+#### Out-of-scope Uses
+
+OpenAI states in the GPT-2 [model card](https://github.com/openai/gpt-2/blob/master/model_card.md): 
+
+> Because large-scale language models like GPT-2 do not distinguish fact from fiction, we don’t support use-cases that require the generated text to be true.
+>
+> Additionally, language models like GPT-2 reflect the biases inherent to the systems they were trained on, so we do not recommend that they be deployed into systems that interact with humans unless the deployers first carry out a study of biases relevant to the intended use-case.
 
 
 
@@ -53,4 +72,4 @@ The following hyperparameters were used during training:
 - Transformers 4.27.0.dev0
 - Pytorch 1.13.1+cu116
 - Datasets 2.9.0
-- Tokenizers 0.13.2
+- Tokenizers 0.13.2