Instructions to use QuantFactory/NuExtract-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use QuantFactory/NuExtract-GGUF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="QuantFactory/NuExtract-GGUF", filename="NuExtract.Q2_K.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 QuantFactory/NuExtract-GGUF with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf QuantFactory/NuExtract-GGUF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf QuantFactory/NuExtract-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 QuantFactory/NuExtract-GGUF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf QuantFactory/NuExtract-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 QuantFactory/NuExtract-GGUF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf QuantFactory/NuExtract-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 QuantFactory/NuExtract-GGUF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf QuantFactory/NuExtract-GGUF:Q4_K_M
Use Docker
docker model run hf.co/QuantFactory/NuExtract-GGUF:Q4_K_M
- LM Studio
- Jan
- Ollama
How to use QuantFactory/NuExtract-GGUF with Ollama:
ollama run hf.co/QuantFactory/NuExtract-GGUF:Q4_K_M
- Unsloth Studio new
How to use QuantFactory/NuExtract-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 QuantFactory/NuExtract-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 QuantFactory/NuExtract-GGUF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for QuantFactory/NuExtract-GGUF to start chatting
- Docker Model Runner
How to use QuantFactory/NuExtract-GGUF with Docker Model Runner:
docker model run hf.co/QuantFactory/NuExtract-GGUF:Q4_K_M
- Lemonade
How to use QuantFactory/NuExtract-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull QuantFactory/NuExtract-GGUF:Q4_K_M
Run and chat with the model
lemonade run user.NuExtract-GGUF-Q4_K_M
List all available models
lemonade list
QuantFactory/NuExtract-GGUF
This is quantized version of numind/NuExtract created using llama.cpp
Original Model Card
โ ๏ธ NOTE: This model is out-dated. Find the updated version here
Structure Extraction Model by NuMind ๐ฅ
NuExtract is a version of phi-3-mini, fine-tuned on a private high-quality synthetic dataset for information extraction. To use the model, provide an input text (less than 2000 tokens) and a JSON template describing the information you need to extract.
Note: This model is purely extractive, so all text output by the model is present as is in the original text. You can also provide an example of output formatting to help the model understand your task more precisely.
Try it here: https://huggingface.co/spaces/numind/NuExtract
We also provide a tiny(0.5B) and large(7B) version of this model: NuExtract-tiny and NuExtract-large
Checkout other models by NuMind:
- SOTA Zero-shot NER Model NuNER Zero
- SOTA Multilingual Entity Recognition Foundation Model: link
- SOTA Sentiment Analysis Foundation Model: English, Multilingual
Benchmark
Benchmark 0 shot (will release soon):
Benchmark fine-tunning (see blog post):
Usage
To use the model:
import json
from transformers import AutoModelForCausalLM, AutoTokenizer
def predict_NuExtract(model, tokenizer, text, schema, example=["", "", ""]):
schema = json.dumps(json.loads(schema), indent=4)
input_llm = "<|input|>\n### Template:\n" + schema + "\n"
for i in example:
if i != "":
input_llm += "### Example:\n"+ json.dumps(json.loads(i), indent=4)+"\n"
input_llm += "### Text:\n"+text +"\n<|output|>\n"
input_ids = tokenizer(input_llm, return_tensors="pt",truncation = True, max_length=4000).to("cuda")
output = tokenizer.decode(model.generate(**input_ids)[0], skip_special_tokens=True)
return output.split("<|output|>")[1].split("<|end-output|>")[0]
# We recommend using bf16 as it results in negligable performance loss
model = AutoModelForCausalLM.from_pretrained("numind/NuExtract", torch_dtype=torch.bfloat16, trust_remote_code=True)
tokenizer = AutoTokenizer.from_pretrained("numind/NuExtract", trust_remote_code=True)
model.to("cuda")
model.eval()
text = """We introduce Mistral 7B, a 7โbillion-parameter language model engineered for
superior performance and efficiency. Mistral 7B outperforms the best open 13B
model (Llama 2) across all evaluated benchmarks, and the best released 34B
model (Llama 1) in reasoning, mathematics, and code generation. Our model
leverages grouped-query attention (GQA) for faster inference, coupled with sliding
window attention (SWA) to effectively handle sequences of arbitrary length with a
reduced inference cost. We also provide a model fine-tuned to follow instructions,
Mistral 7B โ Instruct, that surpasses Llama 2 13B โ chat model both on human and
automated benchmarks. Our models are released under the Apache 2.0 license.
Code: https://github.com/mistralai/mistral-src
Webpage: https://mistral.ai/news/announcing-mistral-7b/"""
schema = """{
"Model": {
"Name": "",
"Number of parameters": "",
"Number of max token": "",
"Architecture": []
},
"Usage": {
"Use case": [],
"Licence": ""
}
}"""
prediction = predict_NuExtract(model, tokenizer, text, schema, example=["","",""])
print(prediction)
- Downloads last month
- 152
2-bit
3-bit
4-bit
5-bit
6-bit
8-bit
Model tree for QuantFactory/NuExtract-GGUF
Base model
microsoft/Phi-3-mini-4k-instruct