Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,197 @@
+---
+base_model: microsoft/phi-2
+inference: false
+language:
+- en
+license: other
+license_link: https://huggingface.co/microsoft/phi-2/resolve/main/LICENSE
+license_name: microsoft-research-license
+model_creator: microsoft
+model_name: phi-2
+pipeline_tag: text-generation
+quantized_by: afrideva
+tags:
+- nlp
+- code
+- gguf
+- ggml
+- quantized
+- q2_k
+- q3_k_m
+- q4_k_m
+- q5_k_m
+- q6_k
+- q8_0
+---
+# microsoft/phi-2-GGUF
+
+Quantized GGUF model files for [phi-2](https://huggingface.co/microsoft/phi-2) from [microsoft](https://huggingface.co/microsoft)
+
+
+| Name | Quant method | Size |
+| ---- | ---- | ---- |
+| [phi-2.fp16.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.fp16.gguf) | fp16 | 5.56 GB  |
+| [phi-2.q2_k.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.q2_k.gguf) | q2_k | 1.17 GB  |
+| [phi-2.q3_k_m.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.q3_k_m.gguf) | q3_k_m | 1.48 GB  |
+| [phi-2.q4_k_m.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.q4_k_m.gguf) | q4_k_m | 1.79 GB  |
+| [phi-2.q5_k_m.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.q5_k_m.gguf) | q5_k_m | 2.07 GB  |
+| [phi-2.q6_k.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.q6_k.gguf) | q6_k | 2.29 GB  |
+| [phi-2.q8_0.gguf](https://huggingface.co/afrideva/phi-2-GGUF/resolve/main/phi-2.q8_0.gguf) | q8_0 | 2.96 GB  |
+
+
+
+## Original Model Card:
+## Model Summary
+
+Phi-2 is a Transformer with **2.7 billion** parameters. It was trained using the same data sources as [Phi-1.5](https://huggingface.co/microsoft/phi-1.5), augmented with a new data source that consists of various NLP synthetic texts and filtered websites (for safety and educational value). When assessed against benchmarks testing common sense, language understanding, and logical reasoning, Phi-2 showcased a nearly state-of-the-art performance among models with less than 13 billion parameters.
+
+Our model hasn't been fine-tuned 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.
+
+## Intended Uses
+
+Phi-2 is intended for research purposes only. Given the nature of the training data, the Phi-2 model is best suited for prompts using the QA format, the chat format, and the code format.
+
+### QA Format:
+
+You can provide the prompt as a standalone question as follows:
+
+```markdown
+Write a detailed analogy between mathematics and a lighthouse.
+```
+where the model generates the text after "." . 
+To encourage the model to write more concise answers, you can also try the following QA format using "Instruct: \<prompt\>\nOutput:"
+```markdown
+Instruct: Write a detailed analogy between mathematics and a lighthouse.
+Output: Mathematics is like a lighthouse. Just as a lighthouse guides ships safely to shore, mathematics provides a guiding light in the world of numbers and logic. It helps us navigate through complex problems and find solutions. Just as a lighthouse emits a steady beam of light, mathematics provides a consistent framework for reasoning and problem-solving. It illuminates the path to understanding and helps us make sense of the world around us.
+```
+where the model generates the text after "Output:".
+
+### Chat Format:
+
+```markdown
+Alice: I don't know why, I'm struggling to maintain focus while studying. Any suggestions?
+Bob: Well, have you tried creating a study schedule and sticking to it?
+Alice: Yes, I have, but it doesn't seem to help much.
+Bob: Hmm, maybe you should try studying in a quiet environment, like the library.
+Alice: ...
+```
+
+where the model generates the text after the first "Bob:".
+
+### Code Format:
+
+```python
+def print_prime(n):
+   """
+   Print all primes between 1 and n
+   """
+   primes = []
+   for num in range(2, n+1):
+       is_prime = True
+       for i in range(2, int(math.sqrt(num))+1):
+           if num % i == 0:
+               is_prime = False
+               break
+       if is_prime:
+           primes.append(num)
+   print(primes)
+```
+where the model generates the text after the comments.
+
+**Notes:**
+* Phi-2 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, the Phi-2 model 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.
+* If you are using `transformers>=4.36.0`, always load the model with `trust_remote_code=True` to prevent side-effects.
+
+## Sample Code
+
+There are four types of execution mode:
+
+1. FP16 / Flash-Attention / CUDA:
+   ```python
+   model = AutoModelForCausalLM.from_pretrained("microsoft/phi-2", torch_dtype="auto", flash_attn=True, flash_rotary=True, fused_dense=True, device_map="cuda", trust_remote_code=True)
+   ```
+2. FP16 / CUDA:
+   ```python
+   model = AutoModelForCausalLM.from_pretrained("microsoft/phi-2", torch_dtype="auto", device_map="cuda", trust_remote_code=True)
+   ```
+3. FP32 / CUDA:
+   ```python
+   model = AutoModelForCausalLM.from_pretrained("microsoft/phi-2", torch_dtype=torch.float32, device_map="cuda", trust_remote_code=True)
+   ```
+4. FP32 / CPU:
+   ```python
+   model = AutoModelForCausalLM.from_pretrained("microsoft/phi-2", torch_dtype=torch.float32, device_map="cpu", trust_remote_code=True)
+   ```
+
+To ensure the maximum compatibility, we recommend using the second execution mode (FP16 / CUDA), as follows:
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+torch.set_default_device("cuda")
+
+model = AutoModelForCausalLM.from_pretrained("microsoft/phi-2", torch_dtype="auto", trust_remote_code=True)
+tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-2", trust_remote_code=True)
+
+inputs = tokenizer('''def print_prime(n):
+   """
+   Print all primes between 1 and n
+   """''', return_tensors="pt", return_attention_mask=False)
+
+outputs = model.generate(**inputs, max_length=200)
+text = tokenizer.batch_decode(outputs)[0]
+print(text)
+```
+
+**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.
+
+## Limitations of Phi-2
+
+* Generate Inaccurate Code and Facts: The model may produce 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: Majority of Phi-2 training data is based in Python and use common packages such as "typing, math, random, collections, datetime, itertools". If the model generates Python scripts that utilize other 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 languages might pose challenges to its comprehension, leading to potential misinterpretations or errors in response.
+
+* Potential Societal Biases: Phi-2 is not entirely free from societal biases despite efforts in assuring trainig data safety. 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 being 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.
+
+* Verbosity: Phi-2 being a base model often produces irrelevant or extra text and responses following its first answer to user prompts within a single turn. This is due to its training dataset being primarily textbooks, which results in textbook-like responses.
+
+## Training
+
+### Model
+
+* Architecture: a Transformer-based model with next-word prediction objective
+
+* Context length: 2048 tokens
+
+* Dataset size: 250B tokens, combination of NLP synthetic data created by AOAI GPT-3.5 and filtered web data from Falcon RefinedWeb and SlimPajama, which was assessed by AOAI GPT-4.
+
+* Training tokens: 1.4T tokens
+
+* GPUs: 96xA100-80G
+
+* Training time: 14 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 [microsoft-research-license](https://huggingface.co/microsoft/phi-2/resolve/main/LICENSE).
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.