Instructions to use xu1998hz/InstructScore with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use xu1998hz/InstructScore with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="xu1998hz/InstructScore")# Load model directly from transformers import AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("xu1998hz/InstructScore") model = AutoModelForCausalLM.from_pretrained("xu1998hz/InstructScore") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use xu1998hz/InstructScore with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "xu1998hz/InstructScore" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "xu1998hz/InstructScore", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/xu1998hz/InstructScore
- SGLang
How to use xu1998hz/InstructScore 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 "xu1998hz/InstructScore" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "xu1998hz/InstructScore", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'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 "xu1998hz/InstructScore" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "xu1998hz/InstructScore", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use xu1998hz/InstructScore with Docker Model Runner:
docker model run hf.co/xu1998hz/InstructScore
File size: 3,652 Bytes
e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 338afc4 e31eb42 | 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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | import torch
from typing import Dict
import transformers
from transformers import LlamaForCausalLM, LlamaTokenizer
DEFAULT_PAD_TOKEN = "[PAD]"
DEFAULT_EOS_TOKEN = "</s>"
DEFAULT_BOS_TOKEN = "</s>"
DEFAULT_UNK_TOKEN = "</s>"
MAX_SOURCE_LENGTH = 512
MAX_TARGET_LENGTH = 512
print("Max source length: ", MAX_SOURCE_LENGTH)
print("MAX target length: ", MAX_TARGET_LENGTH)
def smart_tokenizer_and_embedding_resize(
special_tokens_dict: Dict,
tokenizer: transformers.PreTrainedTokenizer,
):
"""Resize tokenizer and embedding.
Note: This is the unoptimized version that may make your embedding size not be divisible by 64.
"""
tokenizer.add_special_tokens(special_tokens_dict)
tokenizer.add_special_tokens(
{
"eos_token": DEFAULT_EOS_TOKEN,
"bos_token": DEFAULT_BOS_TOKEN,
"unk_token": DEFAULT_UNK_TOKEN,
}
)
device_id = torch.device("cuda") if torch.cuda.is_available() else torch.device("cpu")
class InstructScore:
def __init__(self):
self.tokenizer = LlamaTokenizer.from_pretrained(
"xu1998hz/InstructScore", model_max_length=MAX_SOURCE_LENGTH, use_fast=False
)
# enable batch inference by left padding
self.tokenizer.padding_side = "left"
smart_tokenizer_and_embedding_resize(
special_tokens_dict=dict(pad_token=DEFAULT_PAD_TOKEN),
tokenizer=self.tokenizer,
)
self.model = LlamaForCausalLM.from_pretrained("xu1998hz/InstructScore").to(
device_id
)
self.model.eval()
def score(self, ref_ls, out_ls):
prompt_ls = [
f'You are evaluating Chinese-to-English Machine translation task. The correct translation is "{ref}". The model generated translation is "{out}". Please identify all errors within each model output, up to a maximum of five. For each error, please give me the corresponding error type, major/minor label, error location of the model generated translation and explanation for the error. Major errors can confuse or mislead the reader due to significant change in meaning, while minor\
errors don\'t lead to loss of meaning but will be noticed.'
for ref, out in zip(ref_ls, out_ls)
]
with torch.no_grad():
inputs = self.tokenizer(
prompt_ls,
return_tensors="pt",
padding=True,
truncation=True,
max_length=MAX_SOURCE_LENGTH,
)
outputs = self.model.generate(
inputs["input_ids"].to(device_id),
attention_mask=inputs["attention_mask"].to(device_id),
max_new_tokens=MAX_TARGET_LENGTH,
)
batch_outputs = self.tokenizer.batch_decode(
outputs,
skip_special_tokens=True,
clean_up_tokenization_spaces=True,
)
scores_ls = [
(-1) * output.count("Major/minor: Minor")
+ (-5) * output.count("Major/minor: Major")
for output in batch_outputs
]
return batch_outputs, scores_ls
def main():
refs = [
"SEScore is a simple but effective next generation text generation evaluation metric",
"SEScore it really works",
]
outs = [
"SEScore is a simple effective text evaluation metric for next generation",
"SEScore is not working",
]
scorer = InstructScore()
batch_outputs, scores_ls = scorer.score(refs, outs)
print(batch_outputs)
print(scores_ls)
if __name__ == "__main__":
main()
|