Upload README.md

README.md

@@ -8,7 +8,7 @@ language:
 
 ## Model Details
 
-model-card-testing is a distilled language model. Users of this model card should also consider information about the design, training, and limitations of gpt2.
+model-card-testing is a distilled language modelthat can be used for text generation. Users of this model card should also consider information about the design, training, and limitations of gpt2.
 
 - **Developed by:** author1, author2
 - **Model type:** testing type
@@ -22,7 +22,15 @@ model-card-testing is a distilled language model. Users of this model card shoul
 
 ## How to Get Started with the Model 
 
-Use the code below to get started with the model. 
+Use the code below to get started with the model.  model-card-testing can be used directly with a pipeline for text generation. 
+Since the generation relies on some randomness, we set a seed for reproducibility:
+```python
+>>> from transformers import pipeline, set_seed
+>>> generator = pipeline('text-generation', model='model-card-testing')
+>>> set_seed(42)
+>>> generator("Hello, I'm a language model," max_length=20, num_return_sequences=5)
+```
+
 
 
 
@@ -52,16 +60,16 @@ encoded_input = tokenizer(text, return_tensors='tf')
 output = model(encoded_input)
 ```
 
-## Intended Uses & Limitations
+## Uses
 LLMs are intended to be used for language generation or as a pretrained base model that can be further fine-tuned for specific tasks. Use cases below are not exhaustive.
 
-#### Direct Use
+### Direct Use
 This model can be used for:
 - Text generation
 - Exploring characterisitics of language generated by a language model 
     - Examples: Cloze tests, counterfactuals, generations with reframings
 
-#### Downstream Use
+### Downstream Use
 Tasks that leverage language models, including: 
 - Information Extraction, Question Answering, Summarization
 - Writing assistance: Grammar assistance, autocompletion (for normal prose or code)
@@ -71,7 +79,7 @@ Tasks that leverage language models, including:
 ### Misuse and Out-of-scope Use
 Using the model in high-stakes settings is out of scope for this model.  The model is not designed for critical decisions nor uses with any material consequences on an individual's livelihood or wellbeing. The model outputs content that appears factual but is not correct.
 
-### Limitations
+## Limitations
 
 **CONTENT WARNING: Readers should be aware this section contains content that is disturbing, offensive, and can propogate historical and current stereotypes.**
 
@@ -89,14 +97,26 @@ The impact of model compression techniques, such as knowledge distillation, on b
 NOTE: This code will need customization/fixing.
 
 
+```python
+>>> from transformers import pipeline, set_seed
+>>> generator = pipeline('text-generation', model='model-card-testing')
+>>> set_seed(48)
+>>> generator("The White man worked as a", max_length=20, num_return_sequences=3)
 
+>>> set_seed(48)
+>>> generator("The Black man worked as a", max_length=20, num_return_sequences=3)
+```
 
 
-## Training Data
+
+
+## Training 
+
+### Training Data
 
 model-card-testing was trained using . See the  data card for additional information. 
 
-## Training Procedure
+### Training Procedure
 
 Preprocessing, hardware used, hyperparameters...
 
@@ -107,6 +127,11 @@ This model achieves the following results:
 NOTE: This will need customization.
 
 
+| Dataset  | LAMBADA | LAMBADA | CBT-CN | CBT-NE | WikiText2 | PTB    | enwiki8 | text8  | WikiText103 | 1BW   |
+|:--------:|:-------:|:-------:|:------:|:------:|:---------:|:------:|:-------:|:------:|:-----------:|:-----:|
+| (metric) | (PPL)   | (ACC)   | (ACC)  | (ACC)  | (PPL)     | (PPL)  | (BPB)   | (BPC)  | (PPL)       | (PPL) |
+|          |         |         |        |        |           |        |         |        |             |       |
+
 
 
 
@@ -120,7 +145,7 @@ You can estimate carbon emissions using the [Machine Learning Impact calculator]
 - **Compute Region:** 
 - **Carbon Emitted** *(Power consumption x Time x Carbon produced based on location of power grid)*:
 
-### Citation Information
+## Citation Information
 
 ```bibtex
 @inproceedings{...,