Instructions to use ghost-x/ghost-8b-beta-1608-gguf with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use ghost-x/ghost-8b-beta-1608-gguf with Transformers:

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

pipe = pipeline("text-generation", model="ghost-x/ghost-8b-beta-1608-gguf")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("ghost-x/ghost-8b-beta-1608-gguf", dtype="auto")

llama-cpp-python

How to use ghost-x/ghost-8b-beta-1608-gguf with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="ghost-x/ghost-8b-beta-1608-gguf",
	filename="ghost-8b-beta-bf16.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use ghost-x/ghost-8b-beta-1608-gguf with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf ghost-x/ghost-8b-beta-1608-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 ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf ghost-x/ghost-8b-beta-1608-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 ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M

Use Docker

docker model run hf.co/ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M

LM Studio
Jan

vLLM

How to use ghost-x/ghost-8b-beta-1608-gguf with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "ghost-x/ghost-8b-beta-1608-gguf"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "ghost-x/ghost-8b-beta-1608-gguf",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M

SGLang

How to use ghost-x/ghost-8b-beta-1608-gguf 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 "ghost-x/ghost-8b-beta-1608-gguf" \
    --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": "ghost-x/ghost-8b-beta-1608-gguf",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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 "ghost-x/ghost-8b-beta-1608-gguf" \
        --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": "ghost-x/ghost-8b-beta-1608-gguf",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use ghost-x/ghost-8b-beta-1608-gguf with Ollama:
```
ollama run hf.co/ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M
```

Unsloth Studio new

How to use ghost-x/ghost-8b-beta-1608-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 ghost-x/ghost-8b-beta-1608-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 ghost-x/ghost-8b-beta-1608-gguf to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for ghost-x/ghost-8b-beta-1608-gguf to start chatting

Pi new

How to use ghost-x/ghost-8b-beta-1608-gguf with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf ghost-x/ghost-8b-beta-1608-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": "ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use ghost-x/ghost-8b-beta-1608-gguf with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf ghost-x/ghost-8b-beta-1608-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 ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M

Run Hermes

hermes

Docker Model Runner
How to use ghost-x/ghost-8b-beta-1608-gguf with Docker Model Runner:
```
docker model run hf.co/ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M
```

Lemonade

How to use ghost-x/ghost-8b-beta-1608-gguf with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull ghost-x/ghost-8b-beta-1608-gguf:Q4_K_M

Run and chat with the model

lemonade run user.ghost-8b-beta-1608-gguf-Q4_K_M

List all available models

lemonade list

lamhieu commited on Aug 23, 2024

Commit

4f481d7

verified ·

1 Parent(s): fe37b81

chore: update README.md content

Browse files

Files changed (1) hide show

README.md +30 -5

README.md CHANGED Viewed

@@ -48,7 +48,7 @@ The Ghost 8B Beta model outperforms prominent models such as Llama 3.1 8B Instru
 ### Updates
-* **16 Aug 2024**: The model has been released to version 160824, expanding support from 9 languages to 16 languages. The model has improved math, reasoning, and following instructions better than the previous version.
 ### Thoughts
@@ -77,18 +77,19 @@ We believe that it is possible to optimize language models that are not too larg
 We create many distributions to give you the best access options that best suit your needs.
-| Version | Model card                                                          |
-| ------- | ------------------------------------------------------------------- |
 | BF16    | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608)      |
 | GGUF    | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608-gguf) |
 | AWQ     | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608-awq)  |
 ### License
 The Ghost 8B Beta model is released under the [Ghost Open LLMs LICENSE](https://ghost-x.org/ghost-open-llms-license), [Llama 3 LICENSE](https://huggingface.co/meta-llama/Meta-Llama-3-8B/blob/main/LICENSE).
-* For individuals, the model is free to use for personal and research purposes.
-* For commercial use of Ghost 8B Beta, it's also free, but please contact us for confirmation. You can email us at "lamhieu.vk [at] gmail.com" with a brief introduction of your project. If possible, include your logo so we can feature it as a case study. We will confirm your permission to use the model. For commercial use as a service, no email confirmation is needed, but we'd appreciate a notification so we can keep track and potentially recommend your services to partners using the model.
 Additionally, it would be great if you could mention or credit the model when it benefits your work.
@@ -304,6 +305,30 @@ For direct use with `unsloth`, you can easily get started with the following ste
   print(results)
   ```
 ### Instructions
 Here are specific instructions and explanations for each use case.

 ### Updates
+- **16 Aug 2024**: The model has been released to version 160824, expanding support from 9 languages to 16 languages. The model has improved math, reasoning, and following instructions better than the previous version.
 ### Thoughts
 We create many distributions to give you the best access options that best suit your needs.
+| Version | Model card                                                               |
+| ------- | ------------------------------------------------------------------------ |
 | BF16    | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608)      |
 | GGUF    | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608-gguf) |
 | AWQ     | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608-awq)  |
+| MLX     | [🤗 HuggingFace](https://huggingface.co/ghost-x/ghost-8b-beta-1608-mlx)  |
 ### License
 The Ghost 8B Beta model is released under the [Ghost Open LLMs LICENSE](https://ghost-x.org/ghost-open-llms-license), [Llama 3 LICENSE](https://huggingface.co/meta-llama/Meta-Llama-3-8B/blob/main/LICENSE).
+- For individuals, the model is free to use for personal and research purposes.
+- For commercial use of Ghost 8B Beta, it's also free, but please contact us for confirmation. You can email us at "lamhieu.vk [at] gmail.com" with a brief introduction of your project. If possible, include your logo so we can feature it as a case study. We will confirm your permission to use the model. For commercial use as a service, no email confirmation is needed, but we'd appreciate a notification so we can keep track and potentially recommend your services to partners using the model.
 Additionally, it would be great if you could mention or credit the model when it benefits your work.
   print(results)
   ```
+#### Use with MLX
+For direct use with `mlx`, you can easily get started with the following steps.
+- Firstly, you need to install unsloth via the command below with `pip`.
+  ```bash
+  pip install mlx-lm
+  ```
+- Right now, you can start using the model directly.
+  ```python
+  from mlx_lm import load, generate
+  model, tokenizer = load("ghost-x/ghost-8b-beta-1608-mlx")
+  messages = [
+      {"role": "system", "content": ""},
+      {"role": "user", "content": "Why is the sky blue ?"},
+  ]
+  prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+  response = generate(model, tokenizer, prompt=prompt, verbose=True)
+  ```
 ### Instructions
 Here are specific instructions and explanations for each use case.