Instructions to use Keyven/german-ocr-3 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use Keyven/german-ocr-3 with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("image-text-to-text", model="Keyven/german-ocr-3")
messages = [
    {
        "role": "user",
        "content": [
            {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"},
            {"type": "text", "text": "What animal is on the candy?"}
        ]
    },
]
pipe(text=messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("Keyven/german-ocr-3", dtype="auto")

llama-cpp-python

How to use Keyven/german-ocr-3 with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="Keyven/german-ocr-3",
	filename="german-ocr-3-Q4_K_M.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": [
				{
					"type": "text",
					"text": "Describe this image in one sentence."
				},
				{
					"type": "image_url",
					"image_url": {
						"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
					}
				}
			]
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use Keyven/german-ocr-3 with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf Keyven/german-ocr-3:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf Keyven/german-ocr-3:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf Keyven/german-ocr-3:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf Keyven/german-ocr-3: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 Keyven/german-ocr-3:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf Keyven/german-ocr-3: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 Keyven/german-ocr-3:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf Keyven/german-ocr-3:Q4_K_M

Use Docker

docker model run hf.co/Keyven/german-ocr-3:Q4_K_M

LM Studio
Jan

vLLM

How to use Keyven/german-ocr-3 with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "Keyven/german-ocr-3"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Keyven/german-ocr-3",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker

docker model run hf.co/Keyven/german-ocr-3:Q4_K_M

SGLang

How to use Keyven/german-ocr-3 with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "Keyven/german-ocr-3" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Keyven/german-ocr-3",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "Keyven/german-ocr-3" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Keyven/german-ocr-3",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Ollama
How to use Keyven/german-ocr-3 with Ollama:
```
ollama run hf.co/Keyven/german-ocr-3:Q4_K_M
```

Unsloth Studio new

How to use Keyven/german-ocr-3 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 Keyven/german-ocr-3 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 Keyven/german-ocr-3 to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for Keyven/german-ocr-3 to start chatting

Pi new

How to use Keyven/german-ocr-3 with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf Keyven/german-ocr-3: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": "german-ocr-3"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use Keyven/german-ocr-3 with Docker Model Runner:
```
docker model run hf.co/Keyven/german-ocr-3:Q4_K_M
```

Lemonade

How to use Keyven/german-ocr-3 with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull Keyven/german-ocr-3:Q4_K_M

Run and chat with the model

lemonade run user.german-ocr-3-Q4_K_M

List all available models

lemonade list

german-ocr-3 / schemas /invoice.json

Keyven

Upload schemas/invoice.json with huggingface_hub

8527a08 verified 18 days ago

raw

history blame contribute delete

3.48 kB

	{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "german-ocr-3/schemas/invoice.json",
	"title": "GermanOCR3 Invoice (Rechnung)",
	"description": "Schema fuer deutsche Rechnungen. Pflichtangaben gemaess UStG § 14 sind beruecksichtigt; nicht erkennbare Felder bleiben null.",
	"type": "object",
	"additionalProperties": false,
	"required": ["document_type", "language", "invoice_number", "invoice_date", "amount_total", "currency"],
	"properties": {
	"document_type": {"const": "invoice"},
	"language": {"type": "string", "default": "de"},

	"invoice_number": {"type": ["string", "null"]},
	"invoice_date": {
	"description": "Rechnungsdatum YYYY-MM-DD",
	"type": ["string", "null"]
	},
	"delivery_date": {
	"description": "Liefer-/Leistungsdatum YYYY-MM-DD",
	"type": ["string", "null"]
	},
	"due_date": {
	"description": "Faelligkeitsdatum YYYY-MM-DD",
	"type": ["string", "null"]
	},

	"sender": {
	"type": ["object", "null"],
	"additionalProperties": false,
	"properties": {
	"name": {"type": ["string", "null"]},
	"address": {"type": ["string", "null"]},
	"email": {"type": ["string", "null"]},
	"phone": {"type": ["string", "null"]},
	"tax_id": {"description": "Steuernummer", "type": ["string", "null"]},
	"vat_id": {"description": "USt-IdNr / VAT ID (DE...)", "type": ["string", "null"]},
	"iban": {"type": ["string", "null"]},
	"bic": {"type": ["string", "null"]},
	"bank": {"type": ["string", "null"]}
	}
	},
	"recipient": {
	"type": ["object", "null"],
	"additionalProperties": false,
	"properties": {
	"name": {"type": ["string", "null"]},
	"address": {"type": ["string", "null"]},
	"customer_id": {"type": ["string", "null"]},
	"vat_id": {"type": ["string", "null"]}
	}
	},

	"line_items": {
	"type": "array",
	"default": [],
	"items": {
	"type": "object",
	"additionalProperties": false,
	"required": ["description", "amount_net"],
	"properties": {
	"position": {"type": ["integer", "null"]},
	"article_number": {"type": ["string", "null"]},
	"description": {"type": "string"},
	"quantity": {"type": ["number", "null"]},
	"unit": {"type": ["string", "null"]},
	"unit_price_net": {"type": ["number", "null"]},
	"amount_net": {"type": ["number", "null"]},
	"vat_rate": {"description": "Prozent, z.B. 19 oder 7", "type": ["number", "null"]}
	}
	}
	},

	"amount_net": {"type": ["number", "null"]},
	"amount_vat": {"type": ["number", "null"]},
	"amount_total": {"type": ["number", "null"]},
	"currency": {
	"type": ["string", "null"],
	"description": "ISO-4217, typisch EUR"
	},

	"vat_breakdown": {
	"type": "array",
	"default": [],
	"items": {
	"type": "object",
	"additionalProperties": false,
	"required": ["rate", "net", "vat"],
	"properties": {
	"rate": {"type": "number"},
	"net": {"type": "number"},
	"vat": {"type": "number"}
	}
	}
	},

	"payment_terms": {"type": ["string", "null"]},
	"notes": {"type": "array", "items": {"type": "string"}, "default": []},
	"raw_text": {"type": ["string", "null"]},
	"confidence": {"type": ["number", "null"], "minimum": 0, "maximum": 1}
	}
	}