Instructions to use vonjack/bge-m3-gguf with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use vonjack/bge-m3-gguf with sentence-transformers:

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("vonjack/bge-m3-gguf")

sentences = [
    "That is a happy person",
    "That is a happy dog",
    "That is a very happy person",
    "Today is a sunny day"
]
embeddings = model.encode(sentences)

similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]

llama-cpp-python

How to use vonjack/bge-m3-gguf with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="vonjack/bge-m3-gguf",
	filename="bge-m3-f16.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 vonjack/bge-m3-gguf with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf vonjack/bge-m3-gguf:F16
# Run inference directly in the terminal:
llama-cli -hf vonjack/bge-m3-gguf:F16

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf vonjack/bge-m3-gguf:F16
# Run inference directly in the terminal:
llama-cli -hf vonjack/bge-m3-gguf:F16

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 vonjack/bge-m3-gguf:F16
# Run inference directly in the terminal:
./llama-cli -hf vonjack/bge-m3-gguf:F16

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 vonjack/bge-m3-gguf:F16
# Run inference directly in the terminal:
./build/bin/llama-cli -hf vonjack/bge-m3-gguf:F16

Use Docker

docker model run hf.co/vonjack/bge-m3-gguf:F16

LM Studio
Jan
Ollama
How to use vonjack/bge-m3-gguf with Ollama:
```
ollama run hf.co/vonjack/bge-m3-gguf:F16
```

Unsloth Studio

How to use vonjack/bge-m3-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 vonjack/bge-m3-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 vonjack/bge-m3-gguf to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for vonjack/bge-m3-gguf to start chatting

Docker Model Runner
How to use vonjack/bge-m3-gguf with Docker Model Runner:
```
docker model run hf.co/vonjack/bge-m3-gguf:F16
```

Lemonade

How to use vonjack/bge-m3-gguf with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull vonjack/bge-m3-gguf:F16

Run and chat with the model

lemonade run user.bge-m3-gguf-F16

List all available models

lemonade list

vonjack commited on May 9, 2024

Commit

642fb83

verified ·

1 Parent(s): cc42855

Upload 2 files

Browse files

Files changed (3) hide show

.gitattributes +1 -0
bge-m3-f16_bert_cpp.gguf +3 -0
bge-m3-q8_0-bert_cpp.gguf +2 -2

.gitattributes CHANGED Viewed

@@ -36,3 +36,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 bge-m3-f16.gguf filter=lfs diff=lfs merge=lfs -text
 bge-m3-q8_0.gguf filter=lfs diff=lfs merge=lfs -text
 bge-m3-q8_0-bert_cpp.gguf filter=lfs diff=lfs merge=lfs -text

 bge-m3-f16.gguf filter=lfs diff=lfs merge=lfs -text
 bge-m3-q8_0.gguf filter=lfs diff=lfs merge=lfs -text
 bge-m3-q8_0-bert_cpp.gguf filter=lfs diff=lfs merge=lfs -text
+bge-m3-f16_bert_cpp.gguf filter=lfs diff=lfs merge=lfs -text

bge-m3-f16_bert_cpp.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:f7b5b14dcca834c32d4367b580d797bc09b73eb103e90e05410ac00f5de92afc
+size 1138657824

bge-m3-q8_0-bert_cpp.gguf CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:86010e67476e36681c4bc2f3d98c29a908c5953786b01770ca204e7006a0b0db
-size 608798912

 version https://git-lfs.github.com/spec/v1
+oid sha256:a9944e380c82415e701d46b24c262f6f6ece1b615c9548bca049d705949f2d82
+size 615540416