Update README.md

README.md

@@ -9,20 +9,36 @@ tags:
 - dvilasuero/DistilabelBeagle14-7B
 - beowolx/CodeNinja-1.0-OpenChat-7B
 - WizardLM/WizardMath-7B-V1.1
+- Maths
+- Code
+- Python
 base_model:
 - dvilasuero/DistilabelBeagle14-7B
 - beowolx/CodeNinja-1.0-OpenChat-7B
 - WizardLM/WizardMath-7B-V1.1
+language:
+- en
+library_name: transformers
 ---
 
-# Pearl-3x7B
+<center><img src='https://i.imgur.com/0xFTuAX.png' width='450px'></center>
 
-Pearl-3x7B is a Mixure of Experts (MoE) made with the following models using [LazyMergekit](https://colab.research.google.com/drive/1obulZ1ROXHjYLn6PPZJwRR6GzgQogxxb?usp=sharing):
+# Pearl-3x7B, an xtraordinary Mixure of Experts (MoE) for data science
+
+Pearl-3x7B is a Mixure of Experts (MoE) made with the following models :
 * [dvilasuero/DistilabelBeagle14-7B](https://huggingface.co/dvilasuero/DistilabelBeagle14-7B)
 * [beowolx/CodeNinja-1.0-OpenChat-7B](https://huggingface.co/beowolx/CodeNinja-1.0-OpenChat-7B)
 * [WizardLM/WizardMath-7B-V1.1](https://huggingface.co/WizardLM/WizardMath-7B-V1.1)
 
-## 🧩 Configuration
+A Mixture of Experts (MoE) model represents a sophisticated architecture that amalgamates the capabilities of multiple specialized models to address a wide array of tasks within a unified framework. Within the realm of a MoE model tailored for a chat application, the integration of expertise spanning three distinct domains - chat, code, and mathematics - substantially enhances its capacity to furnish nuanced and precise responses to a diverse spectrum of user inquiries.
+
+The initial expert model, honed for chat applications, exhibits prowess in comprehending natural language nuances, conversational dynamics, and contextual cues. Drawing upon extensive conversational data, it adeptly generates engaging and contextually pertinent responses, thereby fostering meaningful interactions with users.
+
+The subsequent expert model, centered on code, brings to the fore proficiency in programming languages, algorithms, and software engineering principles. Possessing a deep-seated understanding of syntax, logical constructs, and problem-solving methodologies, it deftly tackles queries spanning coding challenges, debugging assistance, and software development inquiries.
+
+Lastly, the third expert model, specializing in mathematics, boasts expertise in mathematical reasoning, problem-solving strategies, and analytical techniques. Armed with a breadth of knowledge encompassing arithmetic, algebra, calculus, and beyond, it offers precise solutions, lucid explanations, and profound insights for mathematical queries, equations, and proofs.
+  
+## Configuration
 
 ```yaml
 base_model: argilla/CapybaraHermes-2.5-Mistral-7B
@@ -87,7 +103,7 @@ experts:
       - "integral"
 ```
 
-## 💻 Usage
+## Usage
 
 ```python
 !pip install -qU transformers bitsandbytes accelerate
@@ -109,4 +125,21 @@ messages = [{"role": "user", "content": "Explain what a Mixture of Experts is in
 prompt = pipeline.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
 outputs = pipeline(prompt, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
 print(outputs[0]["generated_text"])
-```
+```
+
+## Citing & Authors
+
+If you use this code in your research, please use the following BibTeX entry.
+
+```BibTeX
+@misc{louisbrulenaudet2023,
+  author =       {Louis Brulé Naudet},
+  title =        {Pearl-3x7B, an xtraordinary Mixure of Experts (MoE) for data science},
+  year =         {2023}
+  howpublished = {\url{https://huggingface.co/louisbrulenaudet/Pearl-3x7B}},
+}
+```
+
+## Feedback
+
+If you have any feedback, please reach out at [louisbrulenaudet@icloud.com](mailto:louisbrulenaudet@icloud.com).