Instructions to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="OpenResearcher/OpenResearcher-30B-A3B-GGUF", filename="OpenResearcher-30B-A3B-BF16.gguf", )
llm.create_chat_completion( messages = "No input example has been defined for this model task." )
- Notebooks
- Google Colab
- Kaggle
- Local Apps
- llama.cpp
How to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M
Use Docker
docker model run hf.co/OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M
- LM Studio
- Jan
- Ollama
How to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with Ollama:
ollama run hf.co/OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M
- Unsloth Studio new
How to use OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-GGUF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for OpenResearcher/OpenResearcher-30B-A3B-GGUF to start chatting
- Pi new
How to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with Pi:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama-server -hf OpenResearcher/OpenResearcher-30B-A3B-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": "OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Hermes Agent new
How to use OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-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 OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M
Run Hermes
hermes
- Docker Model Runner
How to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with Docker Model Runner:
docker model run hf.co/OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M
- Lemonade
How to use OpenResearcher/OpenResearcher-30B-A3B-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull OpenResearcher/OpenResearcher-30B-A3B-GGUF:Q4_K_M
Run and chat with the model
lemonade run user.OpenResearcher-30B-A3B-GGUF-Q4_K_M
List all available models
lemonade list
Add pipeline tag, library name and sample usage
Hi! I'm Niels from the Hugging Face community science team. I'm opening this PR to improve the model card for OpenResearcher.
I've added the text-generation pipeline tag to the metadata to make the model more discoverable on the Hub. I've also added library_name: llama.cpp as this repository contains GGUF files. Additionally, I've included a "Sample Usage" section with a code snippet derived from the official GitHub repository to help users get started with the agentic research pipeline.