Create README.md

README.md

@@ -0,0 +1,110 @@
+---
+license: apache-2.0
+inference: false
+tags:
+- generated_from_trainer
+- text-generation-inference
+model-index:
+- name: Mistral-7B-Telco
+  results: []
+model_type: mistral
+pipeline_tag: text-generation
+widget:
+- messages:
+  - role: user
+    content: I would like to deactivate a cell phone, where could I do it?
+---
+
+# Mistral-7B-Telco
+
+## Model Description
+
+This model, "Mistral-7B-Telco", is a fine-tuned version of the [mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2), specifically tailored for the Telco domain. It is optimized to answer questions and assist users with various Telco-related procedures. It has been trained using hybrid synthetic data generated using our NLP/NLG technology and our automated Data Labeling (DAL) tools.
+ 
+The goal of this model is to show that a generic verticalized model makes customization for a final use case much easier. An overview of this approach can be found at: [From General-Purpose LLMs to Verticalized Enterprise Models](https://www.bitext.com/blog/general-purpose-models-verticalized-enterprise-genai/)
+
+## Intended Use
+
+- **Recommended applications**: This model is designed to be used as the first step in Bitext’s two-step approach to LLM fine-tuning for the creation of chatbots, virtual assistants and copilots for the Telco domain, providing customers with fast and accurate answers about their needs.
+- **Out-of-scope**: This model is not suited for non-telco related questions and should not be used for providing health, legal, or critical safety advice.
+
+## Usage Example
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
+
+device = 'cuda' if torch.cuda.is_available() else 'cpu'
+
+model = AutoModelForCausalLM.from_pretrained("bitext/Mistral-7B-Telco")
+tokenizer = AutoTokenizer.from_pretrained("bitext/Mistral-7B-Telco")
+
+messages = [
+    {"role": "system", "content": "You are an expert in customer support for Telco."},
+    {"role": "user", "content": "I would like to deactivate a cell phone, where could I do it?"},
+]
+
+encoded = tokenizer.apply_chat_template(messages, return_tensors="pt")
+
+model_inputs = encoded.to(device)
+model.to(device)
+
+generated_ids = model.generate(model_inputs, max_new_tokens=1000, do_sample=True)
+decoded = tokenizer.batch_decode(generated_ids)
+print(decoded[0])
+```
+
+## Model Architecture
+
+This model utilizes the `MistralForCausalLM` architecture with a `LlamaTokenizer`, ensuring it retains the foundational capabilities of the base model while being specifically enhanced for telco-related interactions.
+
+## Training Data
+
+The model was fine-tuned on the [Bitext Telco Dataset](https://huggingface.co/datasets/bitext/Bitext-telco-llm-chatbot-training-dataset) comprising various telco-related intents, including: set_usage_limits, activate_phone, check_mobile_payments, check_signal_coverage, invoices, and more. Totaling 25 intents, and each intent is represented by approximately 1000 examples.
+
+This comprehensive training helps the model address a broad spectrum of telco-related questions effectively. The dataset follows the same structured approach as our dataset published on Hugging Face as [bitext/Bitext-customer-support-llm-chatbot-training-dataset](https://huggingface.co/datasets/bitext/Bitext-customer-support-llm-chatbot-training-dataset), but with a focus on telco.
+
+## Training Procedure
+
+### Hyperparameters
+
+- **Optimizer**: AdamW
+- **Learning Rate**: 0.0002 with a cosine learning rate scheduler
+- **Epochs**: 3
+- **Batch Size**: 4
+- **Gradient Accumulation Steps**: 4
+- **Maximum Sequence Length**: 8192 tokens
+
+### Environment
+
+- **Transformers Version**: 4.43.4
+- **Framework**: PyTorch 2.3.1+cu121
+- **Tokenizers**: Tokenizers 0.19.1
+
+## Limitations and Bias
+
+- The model is trained for telco-specific contexts but may underperform in unrelated areas.
+- Potential biases in the training data could affect the neutrality of the responses; users are encouraged to evaluate responses critically.
+
+## Ethical Considerations
+
+It is important to use this technology thoughtfully, ensuring it does not substitute for human judgment where necessary, especially in sensitive situations.
+
+## Acknowledgments
+
+This model was developed and trained by Bitext using proprietary data and technology.
+
+## License
+
+This model, "Mistral-7B-Telco", is licensed under the Apache License 2.0 by Bitext Innovations International, Inc. This open-source license allows for free use, modification, and distribution of the model but requires that proper credit be given to Bitext.
+
+### Key Points of the Apache 2.0 License
+
+- **Permissibility**: Users are allowed to use, modify, and distribute this software freely.
+- **Attribution**: You must provide proper credit to Bitext Innovations International, Inc. when using this model, in accordance with the original copyright notices and the license.
+- **Patent Grant**: The license includes a grant of patent rights from the contributors of the model.
+- **No Warranty**: The model is provided "as is" without warranties of any kind.
+
+You may view the full license text at [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+This licensing ensures the model can be used widely and freely while respecting the intellectual contributions of Bitext. For more detailed information or specific legal questions about using this license, please refer to the official license documentation linked above.