Instructions to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Transformers:

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Use Docker

docker model run hf.co/QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

LM Studio
Jan
Ollama
How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Ollama:
```
ollama run hf.co/QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M
```

Unsloth Studio

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF to start chatting

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Docker Model Runner:
```
docker model run hf.co/QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M
```

Lemonade

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Vikhr-Qwen-2.5-0.5b-Instruct-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF:Q4_K_M" \
  --custom-provider-id llama-cpp \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF

This is quantized version of Vikhrmodels/Vikhr-Qwen-2.5-0.5b-Instruct created using llama.cpp

Original Model Card

💨📟 Vikhr-Qwen-2.5-0.5B-Instruct

RU

Инструктивная модель на основе Qwen-2.5-0.5B-Instruct, обученная на русскоязычном датасете GrandMaster-PRO-MAX. В 4 раза эффективнее базовой модели, и идеально подходит для запуска на слабых мобильных устройствах.

EN

Instructive model based on Qwen-2.5-0.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.

GGUF

Vikhrmodels/Vikhr-Qwen-2.5-0.5B-instruct-GGUF

Особенности:

📚 Основа / Base: Qwen-2.5-0.5B-Instruct
🇷🇺 Специализация / Specialization: RU
💾 Датасет / Dataset: GrandMaster-PRO-MAX

Попробовать / Try now:

Описание:

RU

Vikhr-Qwen-2.5-0.5B-instruct — это компактная языковая модель, обученная на датасете GrandMaster-PRO-MAX, специально доученная для обработки русского языка. Эффективность модели в 4 раза превышает базовую модель, а её размер составляет 1ГБ , что делает её отличным выбором для запуска на слабых мобильных устройствах.

EN

Vikhr-Qwen-2.5-0.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.

Обучение / Train:

RU

Для создания Vikhr-Qwen-2.5-0.5B-Instruct использовался метод SFT (Supervised Fine-Tuning). Мы обучили модель на синтетическом датасете Vikhrmodels/GrandMaster-PRO-MAX (150k инструкций) с поддержкой CoT (Chain-Of-Thought), используя промпты для GPT-4-turbo.

EN

To create Vikhr-Qwen-2.5-0.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.

Пример кода для запуска / Sample code to run:

Рекомендуемая температура для генерации: 0.3 / Recommended generation temperature: 0.3.

from transformers import AutoModelForCausalLM, AutoTokenizer

# Загрузка модели и токенизатора
model_name = "Vikhrmodels/Vikhr-Qwen-2.5-0.5B-Instruct"
model = AutoModelForCausalLM.from_pretrained(model_name)
tokenizer = AutoTokenizer.from_pretrained(model_name)

# Подготовка входного текста
input_text = "Напиши очень краткую рецензию о книге Гарри Поттер."

# Токенизация и генерация текста
input_ids = tokenizer.encode(input_text, 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,
  )

# Декодирование и вывод результата
generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
print(generated_text)

Ответ модели / Model response:

Книга "Гарри Поттер" – это серия книг, написанных британским писателем Джоан Роулинг. Это одно из самых известных произведений в мире литературы и популярного детского творчества.

Основные черты серии:

Сюжет: События разворачиваются вокруг мальчика по имени Гарри Поттер, который учится в Школе волшебства и философии в Университете Хогвартс. Он сталкивается с различными препятствиями, включая борьбу со злом, поиск друзей и самопознание.

Персонажи: В книге представлены множество персонажей, каждый из которых имеет свои уникальные черты характера, мотивации и прошлое. Главный герой, Гарри Поттер, является примером доброго и смелого человека, а также необычной личностью.

Темы и идеи: Рассказы книги затрагивают темы любви, дружбы, справедливости, морали, человеческой неповиновенности и важности обучения через приключения.

История и развитие персонажей: Через события и взаимодействие с другими персонажами книга исследует глубокие психологические и философские вопросы.

Влияние на культуру: "Гарри Поттер" оказал огромное влияние на мировую литературу, превратившись в культовый жанр и символ знаний и мудрости.

Доступность: Книги серии доступны для широкой аудитории и пользуются большим спросом, что делает их популярным выбором среди читателей всех возрастов.

Развитие жанра: Несмотря на то что "Гарри Поттер" является частью серии, он продолжает быть любимым и актуальным, так как продолжает удивлять читателей новыми историями и персонажами.

Эта серия книг остается одной из самых значительных и влиятельных в истории литературы, оказав влияние на развитие мировой культуры и образование.

Авторы / Authors

Sergei Bratchikov, NLP Wanderer, Vikhr Team
Nikolay Kompanets, LakoMoor, Vikhr Team
Konstantin Korolev, Vikhr Team
Aleksandr Nikolich, Vikhr Team

@article{nikolich2024vikhr,
  title={Vikhr: The Family of Open-Source Instruction-Tuned Large Language Models for Russian},
  author={Aleksandr Nikolich and Konstantin Korolev and Sergey Bratchikov and Nikolay Kompanets and Artem Shelmanov},
  journal={arXiv preprint arXiv:2405.13929},
  year={2024},
  url={https://arxiv.org/pdf/2405.13929}
}

Downloads last month: 131

GGUF

Model size

0.5B params

Architecture

qwen2

Hardware compatibility

2-bit

3-bit

4-bit

5-bit

6-bit

8-bit

Inference Providers NEW

This model isn't deployed by any Inference Provider. 🙋 Ask for provider support

Model tree for QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF

Base model

Qwen/Qwen2.5-0.5B

Finetuned

Qwen/Qwen2.5-0.5B-Instruct

Quantized

(269)

this model

Dataset used to train QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF

Paper for QuantFactory/Vikhr-Qwen-2.5-0.5b-Instruct-GGUF

Vikhr: The Family of Open-Source Instruction-Tuned Large Language Models for Russian

Paper • 2405.13929 • Published May 22, 2024 • 55