"Update README.md"

README.md

@@ -0,0 +1,215 @@
+---
+license: apache-2.0
+datasets:
+- tiiuae/falcon-refinedweb
+- bigcode/starcoderdata
+- togethercomputer/RedPajama-Data-1T
+library_name: transformers
+---
+[![banner](https://maddes8cht.github.io/assets/buttons/Huggingface-banner.jpg)]()
+
+I'm constantly enhancing these model descriptions to provide you with the most relevant and comprehensive information
+
+# open_llama_7b_v2 - GGUF
+- Model creator: [openlm-research](https://huggingface.co/openlm-research)
+- Original model: [open_llama_7b_v2](https://huggingface.co/openlm-research/open_llama_7b_v2)
+
+OpenLlama is a free reimplementation of the original Llama Model.
+
+
+
+# About GGUF format
+
+`gguf` is the current file format used by the [`ggml`](https://github.com/ggerganov/ggml) library.
+A growing list of Software is using it and can therefore use this model.
+The core project making use of the ggml library is the [llama.cpp](https://github.com/ggerganov/llama.cpp) project by Georgi Gerganov
+
+# Quantization variants
+
+There is a bunch of quantized files available to cater to your specific needs. Here's how to choose the best option for you:
+
+# Legacy quants
+
+Q4_0, Q4_1, Q5_0, Q5_1 and Q8 are `legacy` quantization types.
+Nevertheless, they are fully supported, as there are several circumstances that cause certain model not to be compatible with the modern K-quants.
+## Note:
+Now there's a new option to use K-quants even for previously 'incompatible' models, although this involves some fallback solution that makes them not *real* K-quants. More details can be found in affected model descriptions.
+(This mainly refers to Falcon 7b and Starcoder models)
+
+# K-quants
+
+K-quants are designed with the idea that different levels of quantization in specific parts of the model can optimize performance, file size, and memory load.
+So, if possible, use K-quants.
+With a Q6_K, you'll likely find it challenging to discern a quality difference from the original model - ask your model two times the same question and you may encounter bigger quality differences.
+
+
+
+
+---
+
+# Original Model Card:
+# OpenLLaMA: An Open Reproduction of LLaMA
+
+**TL;DR**: we are releasing our public preview of OpenLLaMA, a permissively licensed open source reproduction of Meta AI’s LLaMA. We are releasing a series of 3B, 7B and 13B models trained on different data mixtures. Our model weights can serve as the drop in replacement of LLaMA in existing implementations.
+
+In this repo, we present a permissively licensed open source reproduction of Meta AI's [LLaMA](https://ai.facebook.com/blog/large-language-model-llama-meta-ai/) large language model. We are releasing a series of 3B, 7B and 13B models trained on 1T tokens. We provide PyTorch and JAX weights of pre-trained OpenLLaMA models, as well as evaluation results and comparison against the original LLaMA models. The v2 model is better than the old v1 model trained on a different data mixture. Please see the [project homepage of OpenLLaMA](https://github.com/openlm-research/open_llama) for more details.
+
+
+
+## Weights Release, License and Usage
+
+We release the weights in two formats: an EasyLM format to be use with our [EasyLM framework](https://github.com/young-geng/EasyLM), and a PyTorch format to be used with the [Hugging Face transformers](https://huggingface.co/docs/transformers/index) library. Both our training framework EasyLM and the checkpoint weights are licensed permissively under the Apache 2.0 license.
+
+### Loading the Weights with Hugging Face Transformers
+Preview checkpoints can be directly loaded from Hugging Face Hub. **Please note that it is advised to avoid using the Hugging Face fast tokenizer for now, as we’ve observed that** [**the auto-converted fast tokenizer sometimes gives incorrect tokenizations**](https://github.com/huggingface/transformers/issues/24233)**.** This can be achieved by directly using the `LlamaTokenizer` class, or passing in the `use_fast=False` option for the `AutoTokenizer` class. See the following example for usage.
+
+```python
+import torch
+from transformers import LlamaTokenizer, LlamaForCausalLM
+
+## v2 models
+model_path = 'openlm-research/open_llama_7b_v2'
+
+## v1 models
+# model_path = 'openlm-research/open_llama_3b'
+# model_path = 'openlm-research/open_llama_7b'
+# model_path = 'openlm-research/open_llama_13b'
+
+tokenizer = LlamaTokenizer.from_pretrained(model_path)
+model = LlamaForCausalLM.from_pretrained(
+    model_path, torch_dtype=torch.float16, device_map='auto',
+)
+
+prompt = 'Q: What is the largest animal?\nA:'
+input_ids = tokenizer(prompt, return_tensors="pt").input_ids
+
+generation_output = model.generate(
+    input_ids=input_ids, max_new_tokens=32
+)
+print(tokenizer.decode(generation_output[0]))
+```
+
+For more advanced usage, please follow the [transformers LLaMA documentation](https://huggingface.co/docs/transformers/main/model_doc/llama).
+
+### Evaluating with LM-Eval-Harness
+The model can be evaluated with [lm-eval-harness](https://github.com/EleutherAI/lm-evaluation-harness). However, due to the aforementioned tokenizer issue, we need to avoid using the fast tokenizer to obtain the correct results. This can be achieved by passing in `use_fast=False` to [this part of lm-eval-harness](https://github.com/EleutherAI/lm-evaluation-harness/blob/4b701e228768052cfae9043dca13e82052ca5eea/lm_eval/models/huggingface.py#LL313C9-L316C10), as shown in the example below:
+
+```python
+tokenizer = self.AUTO_TOKENIZER_CLASS.from_pretrained(
+    pretrained if tokenizer is None else tokenizer,
+    revision=revision + ("/" + subfolder if subfolder is not None else ""),
+    use_fast=False
+)
+```
+
+### Loading the Weights with EasyLM
+For using the weights in our EasyLM framework, please refer to the [LLaMA documentation of EasyLM](https://github.com/young-geng/EasyLM/blob/main/docs/llama.md). Note that unlike the original LLaMA model, our OpenLLaMA tokenizer and weights are trained completely from scratch so it is no longer needed to obtain the original LLaMA tokenizer and weights.
+
+
+
+## Dataset and Training
+
+The v1 models are trained on the [RedPajama dataset](https://huggingface.co/datasets/togethercomputer/RedPajama-Data-1T). The v2 models are trained on a mixture of the [Falcon refined-web dataset](https://huggingface.co/datasets/tiiuae/falcon-refinedweb), the [StarCoder dataset](https://huggingface.co/datasets/bigcode/starcoderdata) and the wikipedia, arxiv, book and stackexchange part of the [RedPajama dataset](https://huggingface.co/datasets/togethercomputer/RedPajama-Data-1T).  We follow the exactly same preprocessing steps and training hyperparameters as the original LLaMA paper, including model architecture, context length, training steps, learning rate schedule, and optimizer.  The only difference between our setting and the original one is the dataset used: OpenLLaMA employs open datasets rather than the one utilized by the original LLaMA.
+
+We train the models on cloud TPU-v4s using [EasyLM](https://github.com/young-geng/EasyLM), a JAX based training pipeline we developed for training and fine-tuning large language models. We employ a combination of normal data parallelism and [fully sharded data parallelism (also know as ZeRO stage 3)](https://engineering.fb.com/2021/07/15/open-source/fsdp/) to balance the training throughput and memory usage. Overall we reach a throughput of over 2200 tokens / second / TPU-v4 chip for our 7B model.
+
+
+## Evaluation
+
+We evaluated OpenLLaMA on a wide range of tasks using [lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness).  The LLaMA results are generated by running the original LLaMA model on the same evaluation metrics. We note that our results for the LLaMA model differ slightly from the original LLaMA paper, which we believe is a result of different evaluation protocols. Similar differences have been reported in [this issue of lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness/issues/443). Additionally, we present the results of GPT-J, a 6B parameter model trained on the [Pile](https://pile.eleuther.ai/) dataset by [EleutherAI](https://www.eleuther.ai/).
+
+The original LLaMA model was trained for 1 trillion tokens and GPT-J was trained for 500 billion tokens.  We present the results in the table below. OpenLLaMA exhibits comparable performance to the original LLaMA and GPT-J across a majority of tasks, and outperforms them in some tasks.
+
+
+| **Task/Metric**        | GPT-J 6B | LLaMA 7B | LLaMA 13B | OpenLLaMA 7Bv2 | OpenLLaMA 3B | OpenLLaMA 7B | OpenLLaMA 13B |
+| ---------------------- | -------- | -------- | --------- | -------------- | ------------ | ------------ | ------------- |
+| anli_r1/acc            | 0.32     | 0.35     | 0.35      | 0.34           | 0.33         | 0.33         | 0.33          |
+| anli_r2/acc            | 0.34     | 0.34     | 0.36      | 0.35           | 0.32         | 0.36         | 0.33          |
+| anli_r3/acc            | 0.35     | 0.37     | 0.39      | 0.39           | 0.35         | 0.38         | 0.40          |
+| arc_challenge/acc      | 0.34     | 0.39     | 0.44      | 0.39           | 0.34         | 0.37         | 0.41          |
+| arc_challenge/acc_norm | 0.37     | 0.41     | 0.44      | 0.41           | 0.37         | 0.38         | 0.44          |
+| arc_easy/acc           | 0.67     | 0.68     | 0.75      | 0.73           | 0.69         | 0.72         | 0.75          |
+| arc_easy/acc_norm      | 0.62     | 0.52     | 0.59      | 0.70           | 0.65         | 0.68         | 0.70          |
+| boolq/acc              | 0.66     | 0.75     | 0.71      | 0.72           | 0.68         | 0.71         | 0.75          |
+| hellaswag/acc          | 0.50     | 0.56     | 0.59      | 0.56           | 0.49         | 0.53         | 0.56          |
+| hellaswag/acc_norm     | 0.66     | 0.73     | 0.76      | 0.75           | 0.67         | 0.72         | 0.76          |
+| openbookqa/acc         | 0.29     | 0.29     | 0.31      | 0.30           | 0.27         | 0.30         | 0.31          |
+| openbookqa/acc_norm    | 0.38     | 0.41     | 0.42      | 0.41           | 0.40         | 0.40         | 0.43          |
+| piqa/acc               | 0.75     | 0.78     | 0.79      | 0.79           | 0.75         | 0.76         | 0.77          |
+| piqa/acc_norm          | 0.76     | 0.78     | 0.79      | 0.80           | 0.76         | 0.77         | 0.79          |
+| record/em              | 0.88     | 0.91     | 0.92      | 0.89           | 0.88         | 0.89         | 0.91          |
+| record/f1              | 0.89     | 0.91     | 0.92      | 0.89           | 0.89         | 0.90         | 0.91          |
+| rte/acc                | 0.54     | 0.56     | 0.69      | 0.57           | 0.58         | 0.60         | 0.64          |
+| truthfulqa_mc/mc1      | 0.20     | 0.21     | 0.25      | 0.23           | 0.22         | 0.23         | 0.25          |
+| truthfulqa_mc/mc2      | 0.36     | 0.34     | 0.40      | 0.35           | 0.35         | 0.35         | 0.38          |
+| wic/acc                | 0.50     | 0.50     | 0.50      | 0.50           | 0.48         | 0.51         | 0.47          |
+| winogrande/acc         | 0.64     | 0.68     | 0.70      | 0.66           | 0.62         | 0.67         | 0.70          |
+| Average                | 0.52     | 0.55     | 0.57      | 0.56           | 0.53         | 0.55         | 0.57          |
+
+
+We removed the task CB and WSC from our benchmark, as our model performs suspiciously high on these two tasks. We hypothesize that there could be a benchmark data contamination in the training set.
+
+
+## Contact
+
+We would love to get feedback from the community. If you have any questions, please open an issue or contact us.
+
+OpenLLaMA is developed by:
+[Xinyang Geng](https://young-geng.xyz/)* and [Hao Liu](https://www.haoliu.site/)* from Berkeley AI Research.
+*Equal Contribution
+
+
+
+## Acknowledgment
+
+We thank the [Google TPU Research Cloud](https://sites.research.google/trc/about/) program for providing part of the computation resources. We’d like to specially thank Jonathan Caton from TPU Research Cloud for helping us organizing compute resources, Rafi Witten from the Google Cloud team and James Bradbury from the Google JAX team for helping us optimizing our training throughput. We’d also want to thank Charlie Snell, Gautier Izacard, Eric Wallace, Lianmin Zheng and our user community for the discussions and feedback.
+
+The OpenLLaMA 13B v1 model is trained in collaboration with [Stability AI](https://stability.ai/), and we thank Stability AI for providing the computation resources. We’d like to especially thank David Ha and Shivanshu Purohit for the coordinating the logistics and providing engineering support.
+
+
+## Reference
+
+If you found OpenLLaMA useful in your research or applications, please cite using the following BibTeX:
+```
+@software{openlm2023openllama,
+  author = {Geng, Xinyang and Liu, Hao},
+  title = {OpenLLaMA: An Open Reproduction of LLaMA},
+  month = May,
+  year = 2023,
+  url = {https://github.com/openlm-research/open_llama}
+}
+```
+```
+@software{together2023redpajama,
+  author = {Together Computer},
+  title = {RedPajama-Data: An Open Source Recipe to Reproduce LLaMA training dataset},
+  month = April,
+  year = 2023,
+  url = {https://github.com/togethercomputer/RedPajama-Data}
+}
+```
+```
+@article{touvron2023llama,
+  title={Llama: Open and efficient foundation language models},
+  author={Touvron, Hugo and Lavril, Thibaut and Izacard, Gautier and Martinet, Xavier and Lachaux, Marie-Anne and Lacroix, Timoth{\'e}e and Rozi{\`e}re, Baptiste and Goyal, Naman and Hambro, Eric and Azhar, Faisal and others},
+  journal={arXiv preprint arXiv:2302.13971},
+  year={2023}
+}
+```
+
+***End of original Model File***
+---
+
+
+## Please consider to support my work
+**Coming Soon:** I'm in the process of launching a sponsorship/crowdfunding campaign for my work. I'm evaluating Kickstarter, Patreon, or the new GitHub Sponsors platform, and I am hoping for some support and contribution to the continued availability of these kind of models. Your support will enable me to provide even more valuable resources and maintain the models you rely on. Your patience and ongoing support are greatly appreciated as I work to make this page an even more valuable resource for the community.
+
+<center>
+
+[![GitHub](https://maddes8cht.github.io/assets/buttons/github-io-button.png)](https://maddes8cht.github.io)
+[![Stack Exchange](https://stackexchange.com/users/flair/26485911.png)](https://stackexchange.com/users/26485911)
+[![GitHub](https://maddes8cht.github.io/assets/buttons/github-button.png)](https://github.com/maddes8cht)
+[![HuggingFace](https://maddes8cht.github.io/assets/buttons/huggingface-button.png)](https://huggingface.co/maddes8cht)
+[![Twitter](https://maddes8cht.github.io/assets/buttons/twitter-button.png)](https://twitter.com/maddes1966)
+
+</center>