"Update README.md"

README.md

@@ -0,0 +1,142 @@
+---
+license: apache-2.0
+language: fr
+pipeline_tag: text-generation
+inference:
+  parameters:
+    temperature: 0.7
+tags:
+- LLM
+- finetuned
+---
+[![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
+
+# vigogne-stablelm-3b-4e1t-chat - GGUF
+- Model creator: [bofenghuang](https://huggingface.co/bofenghuang)
+- Original model: [vigogne-stablelm-3b-4e1t-chat](https://huggingface.co/bofenghuang/vigogne-stablelm-3b-4e1t-chat)
+
+# StableLM
+This is a Model based on StableLM. 
+Stablelm is a familiy of Language Models by Stability AI.
+
+## Note:
+Current (as of 2023-11-15) implementations of Llama.cpp only support GPU offloading up to 34 Layers with these StableLM Models.
+The model will crash immediately if -ngl is larger than 34.
+The model works fine however without any gpu acceleration.
+
+
+
+# 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:
+# Vigogne-Stablelm-3B-4E1T-Chat
+
+An attempt to fine-tune the [stablelm-3b-4e1t](https://huggingface.co/stabilityai/stablelm-3b-4e1t) model to explore the feasibility of adapting a "smaller-scale" language model, primarily pretrained on English datasets, for French chat.
+
+**License**: A significant portion of the training data is distilled from GPT-3.5-Turbo and GPT-4, kindly use it cautiously to avoid any violations of OpenAI's [terms of use](https://openai.com/policies/terms-of-use).
+
+## Usage
+
+```python
+from typing import Dict, List, Optional
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, GenerationConfig, TextStreamer
+
+model_name_or_path = "bofenghuang/vigogne-stablelm-3b-4e1t-chat"
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, padding_side="right", use_fast=False)
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path, torch_dtype=torch.float16, device_map="auto", trust_remote_code=True)
+
+streamer = TextStreamer(tokenizer, timeout=10.0, skip_prompt=True, skip_special_tokens=True)
+
+
+def chat(
+    query: str,
+    history: Optional[List[Dict]] = None,
+    temperature: float = 0.7,
+    top_p: float = 1.0,
+    top_k: float = 0,
+    repetition_penalty: float = 1.1,
+    max_new_tokens: int = 1024,
+    **kwargs,
+):
+    if history is None:
+        history = []
+
+    history.append({"role": "user", "content": query})
+
+    input_ids = tokenizer.apply_chat_template(history, return_tensors="pt").to(model.device)
+    input_length = input_ids.shape[1]
+
+    generated_outputs = model.generate(
+        input_ids=input_ids,
+        generation_config=GenerationConfig(
+            temperature=temperature,
+            do_sample=temperature > 0.0,
+            top_p=top_p,
+            top_k=top_k,
+            repetition_penalty=repetition_penalty,
+            max_new_tokens=max_new_tokens,
+            pad_token_id=tokenizer.eos_token_id,
+            **kwargs,
+        ),
+        streamer=streamer,
+        return_dict_in_generate=True,
+    )
+
+    generated_tokens = generated_outputs.sequences[0, input_length:]
+    generated_text = tokenizer.decode(generated_tokens, skip_special_tokens=True)
+
+    history.append({"role": "assistant", "content": generated_text})
+
+    return generated_text, history
+
+
+# 1st round
+response, history = chat("Un escargot parcourt 100 mètres en 5 heures. Quelle est sa vitesse ?", history=None)
+```
+
+***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>