Update README.md

README.md

@@ -1,199 +1,134 @@
 ---
 library_name: transformers
-tags: []
+model_name: Vikhr-Qwen-2.5-1.5b-Instruct
+base_model:
+- Qwen/Qwen2.5-1.5B-Instruct
+language:
+- ru
+- en
+license: apache-2.0
+datasets:
+- Vikhrmodels/GrandMaster-PRO-MAX
 ---
 
-# Model Card for Model ID
+# 💨📟 Vikhr-Qwen-2.5-0.5B-Instruct
 
-<!-- Provide a quick summary of what the model is/does. -->
+#### RU
 
+Инструктивная модель на основе **Qwen-2.5-1.5B-Instruct**, обученная на русскоязычном датасете **GrandMaster-PRO-MAX**. В **4 раза эффективнее** базовой модели, и идеально подходит для запуска на слабых мобильных устройствах.
 
+#### EN
 
-## Model Details
+Instructive model based on **Qwen-2.5-1.5B-Instruct**, trained on the Russian-language dataset **GrandMaster-PRO-MAX**. It is **4 times more efficient** than the base model, making it perfect for deployment on low-end mobile devices.
 
-### Model Description
+## GGUF
 
-<!-- Provide a longer summary of what this model is. -->
+- [Vikhrmodels/Vikhr-Qwen-2.5-0.5B-instruct-GGUF](https://huggingface.co/Vikhrmodels/Vikhr-Qwen-2.5-0.5B-instruct-GGUF)
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+## Особенности:
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- 📚 Основа / Base: [Qwen-2.5-1.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct)
+- 🇷🇺 Специализация / Specialization: **RU**
+- 💾 Датасет / Dataset: [GrandMaster-PRO-MAX](https://huggingface.co/datasets/Vikhrmodels/GrandMaster-PRO-MAX)
 
-### Model Sources [optional]
+## Попробовать / Try now:
 
-<!-- Provide the basic links for the model. -->
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1bJpLmplDGkMbfOLO2CH6IO-2uUZEaknf?usp=sharing)
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+## Описание:
 
-## Uses
+#### RU
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+**Vikhr-Qwen-2.5-1.5B-instruct** — это компактная языковая модель, обученная на датасете **GrandMaster-PRO-MAX**, специально доученная для обработки русского языка. Эффективность модели **в 4 раза** превышает базовую модель, а её размер составляет **1ГБ** , что делает её отличным выбором для запуска на слабых мобильных устройствах.
 
-### Direct Use
+#### EN
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+**Vikhr-Qwen-2.5-1.5B-instruct** is a compact language model trained on the **GrandMaster-PRO-MAX** dataset, specifically designed for processing the Russian language. Its efficiency is **4 times** higher than the base model, and its size is **1GB**, making it an excellent choice for deployment on low-end mobile devices.
 
-[More Information Needed]
+## Обучение / Train:
 
-### Downstream Use [optional]
+#### RU
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+Для создания **Vikhr-Qwen-2.5-1.5B-Instruct** использовался метод SFT (Supervised Fine-Tuning). Мы обучили модель на синтетическом датасете **Vikhrmodels/GrandMaster-PRO-MAX** (150k инструкций) с поддержкой CoT (Chain-Of-Thought), используя промпты для GPT-4-turbo.  
 
-[More Information Needed]
+#### EN
 
-### Out-of-Scope Use
+To create **Vikhr-Qwen-2.5-1.5B-Instruct**, the SFT (Supervised Fine-Tuning) method was used. We trained the model on a synthetic dataset **Vikhrmodels/GrandMaster-PRO-MAX** (150k instructions) with support for CoT (Chain-Of-Thought), utilizing prompts for GPT-4-turbo.  
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+## Пример кода для запуска / Sample code to run:
 
-[More Information Needed]
+**Рекомендуемая температура для генерации: 0.3** / **Recommended generation temperature: 0.3**.
 
-## Bias, Risks, and Limitations
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+# Загрузка модели и токенизатора
+model_name = "Vikhrmodels/Vikhr-Qwen-2.5-1.5B-Instruct"
+model = AutoModelForCausalLM.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
 
-[More Information Needed]
+# Подготовка входного текста
+input_text = "Напиши очень краткую рецензию о книге Гарри Поттер."
 
-### Recommendations
+messages = [
+    {"role": "system", "content": "Вы - Vikhr, помощник с искусственным интеллектом, созданный компанией Vikhr models, чтобы быть полезным, безобидным и честным."},
+    {"role": "user", "content": input_text},
+]
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+# Токенизация и генерация текста
+input_ids = tokenizer.apply_chat_template(messages, truncation=True, add_generation_prompt=True, return_tensors="pt")
+output = model.generate(
+    input_ids,
+    max_length=1512,
+    temperature=0.3,
+    num_return_sequences=1,
+    no_repeat_ngram_size=2,
+    top_k=50,
+    top_p=0.95,
+)
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+# Декодирование и вывод результата
+generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
+print(generated_text)
+```
 
-## How to Get Started with the Model
+#### Ответ модели / Model response:
 
-Use the code below to get started with the model.
+>Книга "Гарри Поттер" – это серия книг, написанных британским писателем Джоан Роулинг. Это одно из самых известных произведений в мире литературы и популярного детского творчества.
+>
+>**Основные черты серии:**
+>
+>1. **Сюжет:** События разворачиваются вокруг мальчика по имени Гарри Поттер, который учится в Школе волшебства и философии в Университете Хогвартс. Он сталкивается с различными препятствиями, включая борьбу со злом, поиск друзей и самопознание.
+>
+>2. **Персонажи:** В книге представлены множество персонажей, каждый из которых имеет свои уникальные черты характера, мотивации и прошлое. Главный герой, Гарри Поттер, является примером доброго и смелого человека, а также необычной личностью.
+>
+>3. **Темы и идеи:** Рассказы книги затрагивают темы любви, дружбы, справедливости, морали, человеческой неповиновенности и важности обучения через приключения.
+>
+>4. **История и развитие персонажей:** Через события и взаимодействие с другими персонажами книга исследует глубокие психологические и философские вопросы.
+>
+>5. **Влияние на культуру:** "Гарри Поттер" оказал огромное влияние на мировую литературу, превратившись в культовый жанр и символ знаний и мудрости.
+>
+>6. **Доступность:** Книги серии доступны для широкой аудитории и пользуются большим спросом, что делает их популярным выбором среди читателей всех возрастов.
+>
+>7. **Развитие жанра:** Несмотря на то что "Гарри Поттер" является частью серии, он продолжает быть любимым и актуальным, так как продолжает удивлять читателей новыми историями и персонажами.
+>
+>Эта серия книг остается одной из самых значительных и влиятельных в истории литературы, оказав влияние на развитие мировой культуры и образование.
 
-[More Information Needed]
 
-## Training Details
+### Авторы / Authors
 
-### Training Data
+- Sergei Bratchikov, [NLP Wanderer](https://t.me/nlpwanderer), [Vikhr Team](https://t.me/vikhrlabs)
+- Nikolay Kompanets, [LakoMoor](https://t.me/lakomoordev), [Vikhr Team](https://t.me/vikhrlabs)
+- Konstantin Korolev, [Vikhr Team](https://t.me/vikhrlabs)
+- Aleksandr Nikolich, [Vikhr Team](https://t.me/vikhrlabs)
 
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+```
+@inproceedings{nikolich2024vikhr,
+  title={Vikhr: Constructing a State-of-the-art Bilingual Open-Source Instruction-Following Large Language Model for {Russian}},
+  author={Aleksandr Nikolich and Konstantin Korolev and Sergei Bratchikov and Nikolay Kompanets and Igor Kiselev and Artem Shelmanov },
+  booktitle = {Proceedings of the 4rd Workshop on Multilingual Representation Learning (MRL) @ EMNLP-2024}
+  year={2024},
+  publisher = {Association for Computational Linguistics},
+  url={https://arxiv.org/pdf/2405.13929}
+}
+```