Instructions to use sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF with sentence-transformers:
from sentence_transformers import SentenceTransformer model = SentenceTransformer("sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF") sentences = [ "The weather is lovely today.", "It's so sunny outside!", "He drove to the stadium." ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [3, 3] - llama-cpp-python
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF", filename="user-bge-m3-q5_k_m.gguf", )
output = llm( "Once upon a time,", max_tokens=512, echo=True ) print(output)
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-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 sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M # Run inference directly in the terminal: llama cli -hf sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama serve -hf sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M # Run inference directly in the terminal: llama cli -hf sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_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 sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M # Run inference directly in the terminal: ./llama-cli -hf sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_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 sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M
Use Docker
docker model run hf.co/sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M
- LM Studio
- Jan
- Ollama
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF with Ollama:
ollama run hf.co/sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M
- Unsloth Studio
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-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 sparkhonyuk/USER-bge-m3-Q5_K_M-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 sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF to start chatting
- Atomic Chat new
- Docker Model Runner
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF with Docker Model Runner:
docker model run hf.co/sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M
- Lemonade
How to use sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF:Q5_K_M
Run and chat with the model
lemonade run user.USER-bge-m3-Q5_K_M-GGUF-Q5_K_M
List all available models
lemonade list
File size: 2,075 Bytes
f613abd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | ---
language:
- ru
library_name: sentence-transformers
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- llama-cpp
- gguf-my-repo
widget: []
pipeline_tag: sentence-similarity
license: apache-2.0
datasets:
- deepvk/ru-HNP
- deepvk/ru-WANLI
- Shitao/bge-m3-data
- RussianNLP/russian_super_glue
- reciTAL/mlsum
- Milana/russian_keywords
- IlyaGusev/gazeta
- d0rj/gsm8k-ru
- bragovo/dsum_ru
- CarlBrendt/Summ_Dialog_News
base_model: deepvk/USER-bge-m3
---
# sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF
This model was converted to GGUF format from [`deepvk/USER-bge-m3`](https://huggingface.co/deepvk/USER-bge-m3) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
Refer to the [original model card](https://huggingface.co/deepvk/USER-bge-m3) for more details on the model.
## Use with llama.cpp
Install llama.cpp through brew (works on Mac and Linux)
```bash
brew install llama.cpp
```
Invoke the llama.cpp server or the CLI.
### CLI:
```bash
llama-cli --hf-repo sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF --hf-file user-bge-m3-q5_k_m.gguf -p "The meaning to life and the universe is"
```
### Server:
```bash
llama-server --hf-repo sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF --hf-file user-bge-m3-q5_k_m.gguf -c 2048
```
Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
Step 1: Clone llama.cpp from GitHub.
```
git clone https://github.com/ggerganov/llama.cpp
```
Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
```
cd llama.cpp && LLAMA_CURL=1 make
```
Step 3: Run inference through the main binary.
```
./llama-cli --hf-repo sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF --hf-file user-bge-m3-q5_k_m.gguf -p "The meaning to life and the universe is"
```
or
```
./llama-server --hf-repo sparkhonyuk/USER-bge-m3-Q5_K_M-GGUF --hf-file user-bge-m3-q5_k_m.gguf -c 2048
```
|