Update README.md

README.md

@@ -4,26 +4,39 @@ datasets:
 ---
 Original Model Card: 
 
-Model Summary
-The language model phi-1.5 is a Transformer with 1.3 billion parameters. It was trained using the same data sources as phi-1, augmented with a new data source that consists of various NLP synthetic texts. When assessed against benchmarks testing common sense, language understanding, and logical reasoning, phi-1.5 demonstrates a nearly state-of-the-art performance among models with less than 10 billion parameters.
+---
+license: other
+license_name: microsoft-research-license
+license_link: https://huggingface.co/microsoft/phi-1_5/resolve/main/Research%20License.docx
+language:
+- en
+pipeline_tag: text-generation
+---
+## Model Summary
+
+The language model phi-1.5 is a Transformer with **1.3 billion** parameters. It was trained using the same data sources as [phi-1](https://huggingface.co/microsoft/phi-1), augmented with a new data source that consists of various NLP synthetic texts. When assessed against benchmarks testing common sense, language understanding, and logical reasoning, phi-1.5 demonstrates a nearly state-of-the-art performance among models with less than 10 billion parameters.
 
-We did not fine-tune phi-1.5 either for instruction following or through reinforcement learning from human feedback. The intention behind crafting this open-source model is to provide the research community with a non-restricted small model to explore vital safety challenges, such as reducing toxicity, understanding societal biases, enhancing controllability, and more.
+We **did not** fine-tune phi-1.5 either for **instruction following or through reinforcement learning from human feedback**. The intention behind crafting this open-source model is to provide the research community with a non-restricted small model to explore vital safety challenges, such as reducing toxicity, understanding societal biases, enhancing controllability, and more.
 
 For a safer model release, we exclude generic web-crawl data sources such as common-crawl from the training. This strategy prevents direct exposure to potentially harmful online content, enhancing the model's safety without RLHF. However, the model is still vulnerable to generating harmful content. We hope the model can help the research community to further study the safety of language models.
 
 phi-1.5 can write poems, draft emails, create stories, summarize texts, write Python code (such as downloading a Hugging Face transformer model), etc.
 
-Intended Uses
+## Intended Uses
 Given the nature of the training data, phi-1.5 is best suited for prompts using the QA format, the chat format, and the code format. Note that phi-1.5, being a base model, often produces irrelevant text following the main answer. In the following example, we've truncated the answer for illustrative purposes only.
 
-QA format:
+#### QA format:
+
+```markdown
 Write a detailed analogy between mathematics and a lighthouse.
 
 Answer: Mathematics is like a lighthouse, guiding us through the vast ocean of numbers and calculations. Just as a lighthouse illuminates the darkness, mathematics provides us with a clear path to navigate through complex problems. It helps us make sense of the world around us, just like a lighthouse helps ships find their way home.
-
+```
 where the model generates the text after "Answer:".
 
-Chat format:
+#### Chat format:
+
+```markdown
 Alice: I don't know why, I'm struggling to maintain focus while studying. Any suggestions?
 
 Bob: Have you tried using a timer? It can help you stay on track and avoid distractions.
@@ -41,10 +54,11 @@ Alice: Thanks for the advice, guys. I feel more motivated now.
 Charlie: No problem, Alice. We're all in this together.
 
 Bob: Yeah, and remember that it's okay to ask for help if you need it. We're here to support each other.
-
+```
 where the model generates the text after the first "Bob:".
 
-Code format:
+#### Code format:
+```python
 def print_prime(n):
    """
    Print all primes between 1 and n
@@ -59,36 +73,42 @@ def print_prime(n):
        if is_prime:
            primes.append(num)
    print(primes)
-
+```
 where the model generates the text after the comments.
 
-Notes
-
-phi-1.5 is intended for research purposes. The model-generated text/code should be treated as a starting point rather than a definitive solution for potential use cases. Users should be cautious when employing these models in their applications.
-Direct adoption for production tasks is out of the scope of this research project. As a result, phi-1.5 has not been tested to ensure that it performs adequately for any production-level application. Please refer to the limitation sections of this document for more details.
-Limitations of phi-1.5
-Generate Inaccurate Code and Facts: The model often produces incorrect code snippets and statements. Users should treat these outputs as suggestions or starting points, not as definitive or accurate solutions.
-Limited Scope for code: If the model generates Python scripts that utilize uncommon packages or scripts in other languages, we strongly recommend users manually verify all API uses.
-Unreliable Responses to Instruction: The model has not undergone instruction fine-tuning. As a result, it may struggle or fail to adhere to intricate or nuanced instructions provided by users.
-Language Limitations: The model is primarily designed to understand standard English. Informal English, slang, or any other language outside of English might pose challenges to its comprehension, leading to potential misinterpretations or errors in response.
-Potential Societal Biases: Regardless of the safe data used for its training, the model is not entirely free from societal biases. There's a possibility it may generate content that mirrors these societal biases, particularly if prompted or instructed to do so. We urge users to be aware of this and to exercise caution and critical thinking when interpreting model outputs.
-Toxicity: Despite that the model is trained with carefully selected data, the model can still produce harmful content if explicitly prompted or instructed to do so. We chose to release the model for research purposes only -- We hope to help the open-source community develop the most effective ways to reduce the toxicity of a model directly after pretraining.
-Training
-Model
-Architecture: a Transformer-based model with next-word prediction objective
-Dataset size: 30B tokens
-Training tokens: 150B tokens
-Precision: fp16
-GPUs: 32xA100-40G
-Training time: 8 days
-Software
-PyTorch
-DeepSpeed
-flash-attention
-License
-The model is licensed under the Research License.
-
-Sample Code
+**Notes**
+* phi-1.5 is intended for research purposes. The model-generated text/code should be treated as a starting point rather than a definitive solution for potential use cases. Users should be cautious when employing these models in their applications.
+* Direct adoption for production tasks is out of the scope of this research project. As a result, phi-1.5 has not been tested to ensure that it performs adequately for any production-level application. Please refer to the limitation sections of this document for more details. 
+
+## Limitations of phi-1.5
+
+* Generate Inaccurate Code and Facts: The model often produces incorrect code snippets and statements. Users should treat these outputs as suggestions or starting points, not as definitive or accurate solutions.
+* Limited Scope for code: If the model generates Python scripts that utilize uncommon packages or scripts in other languages, we strongly recommend users manually verify all API uses.
+* Unreliable Responses to Instruction: The model has not undergone instruction fine-tuning. As a result, it may struggle or fail to adhere to intricate or nuanced instructions provided by users.
+* Language Limitations: The model is primarily designed to understand standard English.  Informal English, slang, or any other language outside of English might pose challenges to its comprehension, leading to potential misinterpretations or errors in response.
+* Potential Societal Biases: Regardless of the safe data used for its training, the model is not entirely free from societal biases. There's a possibility it may generate content that mirrors these societal biases, particularly if prompted or instructed to do so. We urge users to be aware of this and to exercise caution and critical thinking when interpreting model outputs.
+* Toxicity: Despite that the model is trained with carefully selected data, the model can still produce harmful content if explicitly prompted or instructed to do so. We chose to release the model for research purposes only -- We hope to help the open-source community develop the most effective ways to reduce the toxicity of a model directly after pretraining.
+
+## Training
+
+### Model
+* Architecture: a Transformer-based model with next-word prediction objective
+* Dataset size: 30B tokens
+* Training tokens: 150B tokens
+* Precision: fp16
+* GPUs: 32xA100-40G
+* Training time: 8 days
+
+### Software
+* [PyTorch](https://github.com/pytorch/pytorch)
+* [DeepSpeed](https://github.com/microsoft/DeepSpeed)
+* [flash-attention](https://github.com/HazyResearch/flash-attention)
+
+### License
+The model is licensed under the [Research License](https://huggingface.co/microsoft/phi-1_5/resolve/main/Research%20License.docx).
+
+### Sample Code
+```python
 import torch
 from transformers import AutoModelForCausalLM, AutoTokenizer
 
@@ -104,21 +124,26 @@ def print_prime(n):
 outputs = model.generate(**inputs, max_length=200)
 text = tokenizer.batch_decode(outputs)[0]
 print(text)
+```
 
-If you need to use the model in a lower precision (e.g., FP16), please wrap the model's forward pass with torch.autocast(), as follows:
-
+If you need to use the model in a lower precision (e.g., FP16), please wrap the model's forward pass with `torch.autocast()`, as follows:
+```python
 with torch.autocast(model.device.type, dtype=torch.float16, enabled=True):
     outputs = model.generate(**inputs, max_length=200)
+```
 
-Remark. In the generation function, our model currently does not support beam search (num_beams > 1). Furthermore, in the forward pass of the model, we currently do not support outputting hidden states or attention values, or using custom input embeddings (instead of the model's).
+**Remark.** In the generation function, our model currently does not support beam search (`num_beams` > 1). 
+Furthermore, in the forward pass of the model, we currently do not support outputting hidden states or attention values, or using custom input embeddings (instead of the model's).
+
+### Citation
 
-Citation
 You can find the paper at https://arxiv.org/abs/2309.05463
 
+```bib
 @article{textbooks2,
   title={Textbooks Are All You Need II: \textbf{phi-1.5} technical report},
   author={Li, Yuanzhi and Bubeck, S{\'e}bastien and Eldan, Ronen and Del Giorno, Allie and Gunasekar, Suriya and Lee, Yin Tat},
   journal={arXiv preprint arXiv:2309.05463},
   year={2023}
 }
-
+```