Instructions to use Axway/Rukopys-OCR-4B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Notebooks
Google Colab
Kaggle
Local Apps Settings

How to use Axway/Rukopys-OCR-4B-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 Axway/Rukopys-OCR-4B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf Axway/Rukopys-OCR-4B-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 Axway/Rukopys-OCR-4B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf Axway/Rukopys-OCR-4B-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 Axway/Rukopys-OCR-4B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf Axway/Rukopys-OCR-4B-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 Axway/Rukopys-OCR-4B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf Axway/Rukopys-OCR-4B-GGUF:Q4_K_M

Use Docker

docker model run hf.co/Axway/Rukopys-OCR-4B-GGUF:Q4_K_M

LM Studio
Jan
Ollama
How to use Axway/Rukopys-OCR-4B-GGUF with Ollama:
```
ollama run hf.co/Axway/Rukopys-OCR-4B-GGUF:Q4_K_M
```
Unsloth Desktop

How to use Axway/Rukopys-OCR-4B-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Axway/Rukopys-OCR-4B-GGUF:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @earendil-works/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "Axway/Rukopys-OCR-4B-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use Axway/Rukopys-OCR-4B-GGUF with Docker Model Runner:
```
docker model run hf.co/Axway/Rukopys-OCR-4B-GGUF:Q4_K_M
```

Lemonade

How to use Axway/Rukopys-OCR-4B-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull Axway/Rukopys-OCR-4B-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Rukopys-OCR-4B-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use Axway/Rukopys-OCR-4B-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 Axway/Rukopys-OCR-4B-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 Axway/Rukopys-OCR-4B-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use Axway/Rukopys-OCR-4B-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Axway/Rukopys-OCR-4B-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 "Axway/Rukopys-OCR-4B-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"

Rukopys-OCR-4B - GGUF (Q4_K_M)

English | Українська | Русский

🇬🇧 English

This repository contains a quantized version of the original model ebinan92/Rukopys-OCR-4B in GGUF format (Q4_K_M).

The original model is designed for optical character recognition (OCR) of handwritten and printed text, with a strong focus on Ukrainian and Cyrillic script languages.

📌 Quantization Details

Base Model: ebinan92/Rukopys-OCR-4B
Quantization Type: Q4_K_M (Medium 4-bit quantization, optimal balance between speed, RAM/VRAM usage, and quality retention)
Format: GGUF (compatible with llama.cpp, LM Studio, Ollama, etc.)

💻 Usage

In LM Studio / llama.cpp

Working with GGUF Multimodal/Vision models requires downloading both the main .gguf model file and the corresponding mmproj (multimodal projector) file, or using a compatible version of llama.cpp supporting vision architectures.

Download the .gguf model file from the Files and versions tab.
Load it in LM Studio or run via llama.cpp:

./llama-cli -m rukopys-ocr-4b-q4_k_m.gguf   --mmproj mmproj-model-f16.gguf   --image /path/to/your/handwritten_image.png   -p "Recognize the text in this image:"

🇺🇦 Українська

Цей репозиторій містить квантовану версію оригінальної моделі ebinan92/Rukopys-OCR-4B у форматі GGUF (Q4_K_M).

Оригінальна модель призначена для розпізнавання рукописного та друкованого тексту (OCR), з особливим акцентом на українську та кириличні мови.

📌 Інформація про квантування

Оригінальна модель: ebinan92/Rukopys-OCR-4B
Тип квантування: Q4_K_M (Medium 4-bit quantization, оптимальний баланс між швидкістю, використанням пам'яті та збереженням якості)
Формат: GGUF (для використання в llama.cpp, LM Studio, Ollama тощо)

💻 Використання

У LM Studio / llama.cpp

Для роботи з Multimodal/Vision моделями у форматі GGUF необхідно завантажити як основний .gguf файл моделі, так і відповідний mmproj (multimodal projector) файл, або використовувати сумісну версію llama.cpp із підтримкою vision-архітектур.

Завантажте файл моделі .gguf із вкладки Files and versions.
Завантажте модель у LM Studio або запустіть через llama.cpp:

./llama-cli -m rukopys-ocr-4b-q4_k_m.gguf   --mmproj mmproj-model-f16.gguf   --image /path/to/your/handwritten_image.png   -p "Розпізнай текст на цьому зображенні:"

🇷🇺 Русский

Данный репозиторий содержит квантованную версию оригинальной модели ebinan92/Rukopys-OCR-4B в формате GGUF (Q4_K_M).

Оригинальная модель предназначена для распознавания рукописного и печатного текста (OCR), с особым упором на украинский и кириллические языки.

📌 Информация о квантовании

Исходная модель: ebinan92/Rukopys-OCR-4B
Тип квантования: Q4_K_M (Medium 4-bit quantization, идеальный баланс между скоростью, потреблением памяти и сохранением качества)
Формат: GGUF (для использования в llama.cpp, LM Studio, Ollama и др.)

💻 Использование

В LM Studio / llama.cpp

Для работы с Multimodal/Vision моделями в формате GGUF требуется загрузить как основной .gguf файл модели, так и соответствующий mmproj (multimodal projector) файл, либо использовать совместимую версию llama.cpp с поддержкой vision-архитектур.

Скачайте файл модели .gguf из вкладки Files and versions.
Загрузите модель в LM Studio или запустите через llama.cpp:

./llama-cli -m rukopys-ocr-4b-q4_k_m.gguf   --mmproj mmproj-model-f16.gguf   --image /path/to/your/handwritten_image.png   -p "Распознай текст на этом изображении:"