"Update README.md"

README.md

@@ -0,0 +1,287 @@
+---
+language:
+- en
+library_name: transformers
+tags:
+- gpt
+- llm
+- large language model
+- h2o-llmstudio
+inference: false
+thumbnail: >-
+  https://h2o.ai/etc.clientlibs/h2o/clientlibs/clientlib-site/resources/images/favicon.ico
+license: apache-2.0
+datasets:
+- OpenAssistant/oasst1
+---
+[![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
+
+# h2ogpt-gm-oasst1-multilang-2048-falcon-7b - GGUF
+- Model creator: [h2oai](https://huggingface.co/h2oai)
+- Original model: [h2ogpt-gm-oasst1-multilang-2048-falcon-7b](https://huggingface.co/h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b)
+
+# K-Quants in Falcon 7b models
+
+New releases of Llama.cpp now support K-quantization for previously incompatible models, in particular all Falcon 7B models. This is achieved by employing a fallback solution for model layers that cannot be quantized with real K-quants.
+
+For Falcon 7B models, although only a quarter of the layers can be quantized with true K-quants, this approach still benefits from utilizing *different* legacy quantization types Q4_0, Q4_1, Q5_0, and Q5_1. As a result, it offers better quality at the same file size or smaller file sizes with comparable performance.
+
+So this solution ensures improved performance and efficiency over legacy Q4_0, Q4_1, Q5_0 and Q5_1 Quantizations.
+
+
+# Important Update for Falcon Models in llama.cpp Versions After October 18, 2023
+
+As previously noted on the [Llama.cpp GitHub repository](https://github.com/ggerganov/llama.cpp#hot-topics), all new Llama.cpp releases after October 18, 2023, required re-quantization due to the implementation of the new BPE tokenizer.
+
+This re-quantization process for Falcon Models is now complete, the latest quantized models are available here for download. To ensure continued compatibility with recent llama.cpp software, You need to update your Falcon models.
+
+- **Stay Informed:** Keep an eye on software application release schedules using llama.cpp libraries.
+- **Monitor Upload Times:** Re-quantization is complete. Watch for updates on my Hugging Face Model pages.
+
+This change only affects **Falcon** and **Starcoder** models, with other models remaining unaffected.
+
+
+
+
+# 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:
+# Model Card
+## Summary
+
+This model was trained using [H2O LLM Studio](https://github.com/h2oai/h2o-llmstudio).
+- Base model: [tiiuae/falcon-7b](https://huggingface.co/tiiuae/falcon-7b)
+- Dataset preparation: [OpenAssistant/oasst1](https://github.com/h2oai/h2o-llmstudio/blob/1935d84d9caafed3ee686ad2733eb02d2abfce57/app_utils/utils.py#LL1896C5-L1896C28)
+
+
+## Usage
+
+To use the model with the `transformers` library on a machine with GPUs, first make sure you have the `transformers`, `accelerate`, `torch` and `einops` libraries installed.
+
+```bash
+pip install transformers==4.29.2
+pip install accelerate==0.19.0
+pip install torch==2.0.0
+pip install einops==0.6.1
+```
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
+
+
+tokenizer = AutoTokenizer.from_pretrained(
+    "h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b",
+    use_fast=False,
+    padding_side="left",
+    trust_remote_code=True,
+)
+
+generate_text = pipeline(
+    model="h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b",
+    tokenizer=tokenizer,
+    torch_dtype=torch.float16,
+    trust_remote_code=True,
+    use_fast=False,
+    device_map={"": "cuda:0"},
+)
+
+res = generate_text(
+    "Why is drinking water so healthy?",
+    min_new_tokens=2,
+    max_new_tokens=1024,
+    do_sample=False,
+    num_beams=1,
+    temperature=float(0.3),
+    repetition_penalty=float(1.2),
+    renormalize_logits=True
+)
+print(res[0]["generated_text"])
+```
+
+You can print a sample prompt after the preprocessing step to see how it is feed to the tokenizer:
+
+```python
+print(generate_text.preprocess("Why is drinking water so healthy?")["prompt_text"])
+```
+
+```bash
+<|prompt|>Why is drinking water so healthy?<|endoftext|><|answer|>
+```
+
+Alternatively, you can download [h2oai_pipeline.py](h2oai_pipeline.py), store it alongside your notebook, and construct the pipeline yourself from the loaded model and tokenizer:
+
+
+```python
+import torch
+from h2oai_pipeline import H2OTextGenerationPipeline
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+tokenizer = AutoTokenizer.from_pretrained(
+    "h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b",
+    use_fast=False,
+    padding_side="left",
+    trust_remote_code=True,
+)
+model = AutoModelForCausalLM.from_pretrained(
+    "h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b",
+    torch_dtype=torch.bfloat16,
+    device_map={"": "cuda:0"},
+    trust_remote_code=True,
+)
+generate_text = H2OTextGenerationPipeline(model=model, tokenizer=tokenizer)
+
+res = generate_text(
+    "Why is drinking water so healthy?",
+    min_new_tokens=2,
+    max_new_tokens=1024,
+    do_sample=False,
+    num_beams=1,
+    temperature=float(0.3),
+    repetition_penalty=float(1.2),
+    renormalize_logits=True
+)
+print(res[0]["generated_text"])
+```
+
+You may also construct the pipeline from the loaded model and tokenizer yourself and consider the preprocessing steps:
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b"  # either local folder or huggingface model name
+# Important: The prompt needs to be in the same format the model was trained with.
+# You can find an example prompt in the experiment logs.
+prompt = "<|prompt|>How are you?<|endoftext|><|answer|>"
+
+tokenizer = AutoTokenizer.from_pretrained(
+    model_name,
+    use_fast=False,
+    trust_remote_code=True,
+)
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype=torch.bfloat16,
+    device_map={"": "cuda:0"},
+    trust_remote_code=True,
+)
+model.cuda().eval()
+inputs = tokenizer(prompt, return_tensors="pt", add_special_tokens=False).to("cuda")
+
+# generate configuration can be modified to your needs
+tokens = model.generate(
+    **inputs,
+    min_new_tokens=2,
+    max_new_tokens=1024,
+    do_sample=False,
+    num_beams=1,
+    temperature=float(0.3),
+    repetition_penalty=float(1.2),
+    renormalize_logits=True
+)[0]
+
+tokens = tokens[inputs["input_ids"].shape[1]:]
+answer = tokenizer.decode(tokens, skip_special_tokens=True)
+print(answer)
+```
+
+## Model Architecture
+
+```
+RWForCausalLM(
+  (transformer): RWModel(
+    (word_embeddings): Embedding(65024, 4544)
+    (h): ModuleList(
+      (0-31): 32 x DecoderLayer(
+        (input_layernorm): LayerNorm((4544,), eps=1e-05, elementwise_affine=True)
+        (self_attention): Attention(
+          (maybe_rotary): RotaryEmbedding()
+          (query_key_value): Linear(in_features=4544, out_features=4672, bias=False)
+          (dense): Linear(in_features=4544, out_features=4544, bias=False)
+          (attention_dropout): Dropout(p=0.0, inplace=False)
+        )
+        (mlp): MLP(
+          (dense_h_to_4h): Linear(in_features=4544, out_features=18176, bias=False)
+          (act): GELU(approximate='none')
+          (dense_4h_to_h): Linear(in_features=18176, out_features=4544, bias=False)
+        )
+      )
+    )
+    (ln_f): LayerNorm((4544,), eps=1e-05, elementwise_affine=True)
+  )
+  (lm_head): Linear(in_features=4544, out_features=65024, bias=False)
+)
+```
+
+## Model Configuration
+
+This model was trained using H2O LLM Studio and with the configuration in [cfg.yaml](cfg.yaml). Visit [H2O LLM Studio](https://github.com/h2oai/h2o-llmstudio) to learn how to train your own large language models.
+
+
+## Model Validation
+
+Model validation results using [EleutherAI lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness).
+
+```bash
+CUDA_VISIBLE_DEVICES=0 python main.py --model hf-causal-experimental --model_args pretrained=h2oai/h2ogpt-gm-oasst1-multilang-2048-falcon-7b --tasks openbookqa,arc_easy,winogrande,hellaswag,arc_challenge,piqa,boolq --device cuda &> eval.log
+```
+
+
+## Disclaimer
+
+Please read this disclaimer carefully before using the large language model provided in this repository. Your use of the model signifies your agreement to the following terms and conditions.
+
+- Biases and Offensiveness: The large language model is trained on a diverse range of internet text data, which may contain biased, racist, offensive, or otherwise inappropriate content. By using this model, you acknowledge and accept that the generated content may sometimes exhibit biases or produce content that is offensive or inappropriate. The developers of this repository do not endorse, support, or promote any such content or viewpoints.
+- Limitations: The large language model is an AI-based tool and not a human. It may produce incorrect, nonsensical, or irrelevant responses. It is the user's responsibility to critically evaluate the generated content and use it at their discretion.
+- Use at Your Own Risk: Users of this large language model must assume full responsibility for any consequences that may arise from their use of the tool. The developers and contributors of this repository shall not be held liable for any damages, losses, or harm resulting from the use or misuse of the provided model.
+- Ethical Considerations: Users are encouraged to use the large language model responsibly and ethically. By using this model, you agree not to use it for purposes that promote hate speech, discrimination, harassment, or any form of illegal or harmful activities.
+- Reporting Issues: If you encounter any biased, offensive, or otherwise inappropriate content generated by the large language model, please report it to the repository maintainers through the provided channels. Your feedback will help improve the model and mitigate potential issues.
+- Changes to this Disclaimer: The developers of this repository reserve the right to modify or update this disclaimer at any time without prior notice. It is the user's responsibility to periodically review the disclaimer to stay informed about any changes.
+
+By using the large language model provided in this repository, you agree to accept and comply with the terms and conditions outlined in this disclaimer. If you do not agree with any part of this disclaimer, you should refrain from using the model and any content generated by it.
+
+***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>