Text Generation
Transformers
Safetensors
English
qwen3_5
image-text-to-text
user-representation
user-simulation
simulation
multi-turn
conversational
Instructions to use microsoft/UserRepGen-4B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use microsoft/UserRepGen-4B with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="microsoft/UserRepGen-4B") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] pipe(text=messages)# pip install -U transformers accelerate # Load model directly from transformers import AutoProcessor, AutoModelForMultimodalLM processor = AutoProcessor.from_pretrained("microsoft/UserRepGen-4B") model = AutoModelForMultimodalLM.from_pretrained("microsoft/UserRepGen-4B", device_map="auto") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=256) print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use microsoft/UserRepGen-4B with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "microsoft/UserRepGen-4B" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "microsoft/UserRepGen-4B", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/microsoft/UserRepGen-4B
- SGLang
How to use microsoft/UserRepGen-4B 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 "microsoft/UserRepGen-4B" \ --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": "microsoft/UserRepGen-4B", "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 "microsoft/UserRepGen-4B" \ --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": "microsoft/UserRepGen-4B", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Docker Model Runner
How to use microsoft/UserRepGen-4B with Docker Model Runner:
docker model run hf.co/microsoft/UserRepGen-4B
Download example.py from microsoft/UserRepGen-4B: direct link, hf CLI and curl.
- Browser
- Download file 5.64 kB
-
https://huggingface.co/microsoft/UserRepGen-4B/resolve/main/example.py
- Command line
-
hf download hf://microsoft/UserRepGen-4B/example.py
-
curl -L -o example.py https://huggingface.co/microsoft/UserRepGen-4B/resolve/main/example.py
5.64 kB
| """Generate a task and behavior representation from a conversation.""" | |
| import argparse | |
| import json | |
| import sys | |
| import time | |
| from pathlib import Path | |
| import torch | |
| from huggingface_hub import hf_hub_download | |
| from transformers import AutoModelForImageTextToText, AutoTokenizer | |
| # An authored, simplified example inspired by an Excel-help WildChat conversation. | |
| EXAMPLE_CONVERSATION = [ | |
| { | |
| "role": "user", | |
| "content": "I need an Excel formula to count dates in A2:A100 before today plus B1.", | |
| }, | |
| { | |
| "role": "assistant", | |
| "content": 'Try =COUNTIF(A2:A100,"<"&TODAY()+B1).', | |
| }, | |
| { | |
| "role": "user", | |
| "content": "That didn't work. The dates come from another formula.", | |
| }, | |
| { | |
| "role": "assistant", | |
| "content": "Are those results actual Excel dates, or text that looks like dates?", | |
| }, | |
| {"role": "user", "content": "They're text. Some cells are empty too."}, | |
| { | |
| "role": "assistant", | |
| "content": "Convert the nonempty text values with DATEVALUE, then count the resulting dates.", | |
| }, | |
| { | |
| "role": "user", | |
| "content": "Can you show the steps using a helper column?", | |
| }, | |
| { | |
| "role": "assistant", | |
| "content": 'In C2 enter =IF(A2="","",DATEVALUE(A2)), fill down to C100, then use =COUNTIFS(C2:C100,"<"&TODAY()+B1,C2:C100,">0").', | |
| }, | |
| ] | |
| def format_prompt(conversation: list[dict[str, str]], template: str) -> str: | |
| if not isinstance(conversation, list) or not conversation: | |
| raise ValueError("The conversation must be a nonempty list of messages.") | |
| for message in conversation: | |
| if not isinstance(message, dict): | |
| raise ValueError("Each message must be an object with role and content.") | |
| if message.get("role") not in ("user", "assistant"): | |
| raise ValueError("Message roles must be 'user' or 'assistant'.") | |
| if not isinstance(message.get("content"), str) or not message["content"].strip(): | |
| raise ValueError("Each message must contain nonempty text.") | |
| history = "\n".join(f"[{m['role']}]: {m['content']}" for m in conversation) | |
| return template.format(conversation_history=history) | |
| def parse_representation(text: str) -> dict[str, str]: | |
| representation = json.loads(text) | |
| if not isinstance(representation, dict) or set(representation) != {"task", "user_behavior"}: | |
| raise ValueError(f"Expected exactly task and user_behavior fields; received: {text}") | |
| if not all(isinstance(value, str) and value.strip() for value in representation.values()): | |
| raise ValueError(f"Both representation fields must be nonempty strings; received: {text}") | |
| return representation | |
| def main() -> None: | |
| parser = argparse.ArgumentParser(description=__doc__) | |
| parser.add_argument("--model", default="microsoft/UserRepGen-4B", help="Hub ID or local model directory.") | |
| parser.add_argument("--conversation", type=Path, help="JSON list of role/content messages; otherwise use the built-in example.") | |
| parser.add_argument("--device", choices=["cpu", "cuda"], default="cuda" if torch.cuda.is_available() else "cpu") | |
| args = parser.parse_args() | |
| conversation = ( | |
| json.loads(args.conversation.read_text(encoding="utf-8")) | |
| if args.conversation is not None | |
| else EXAMPLE_CONVERSATION | |
| ) | |
| if Path(args.model).is_dir(): | |
| prompt_path = Path(args.model) / "representation_prompt.txt" | |
| else: | |
| prompt_path = Path(hf_hub_download(args.model, "representation_prompt.txt")) | |
| prompt = format_prompt(conversation, prompt_path.read_text(encoding="utf-8").strip()) | |
| tokenizer = AutoTokenizer.from_pretrained(args.model) | |
| inputs = tokenizer.apply_chat_template( | |
| [{"role": "user", "content": prompt}], | |
| tokenize=True, | |
| add_generation_prompt=True, | |
| enable_thinking=False, | |
| return_tensors="pt", | |
| return_dict=True, | |
| ) | |
| prompt_tokens = inputs["input_ids"].shape[1] | |
| if prompt_tokens > 8192: | |
| raise ValueError(f"Prompt has {prompt_tokens} tokens; the supported maximum is 8192.") | |
| if args.device == "cpu": | |
| torch.set_num_threads(8) | |
| print(f"Loading {args.model} on {args.device}; prompt: {prompt_tokens} tokens.", file=sys.stderr, flush=True) | |
| model, loading_info = AutoModelForImageTextToText.from_pretrained( | |
| args.model, | |
| dtype=torch.float32 if args.device == "cpu" else torch.bfloat16, | |
| device_map=args.device, | |
| output_loading_info=True, | |
| ) | |
| for key in ("missing_keys", "unexpected_keys", "mismatched_keys", "error_msgs"): | |
| if loading_info.get(key): | |
| raise RuntimeError(f"Checkpoint loading failed ({key}): {loading_info[key]}") | |
| model.eval() | |
| inputs = inputs.to(args.device) | |
| started = time.monotonic() | |
| print("Generating representation...", file=sys.stderr, flush=True) | |
| with torch.inference_mode(): | |
| output = model.generate( | |
| **inputs, | |
| max_new_tokens=1024, | |
| do_sample=False, | |
| temperature=None, | |
| top_p=None, | |
| top_k=None, | |
| eos_token_id=tokenizer.eos_token_id, | |
| pad_token_id=tokenizer.pad_token_id, | |
| ) | |
| generated_ids = output[0, prompt_tokens:] | |
| text = tokenizer.decode(generated_ids, skip_special_tokens=True).strip() | |
| representation = parse_representation(text) | |
| print(json.dumps(representation, indent=2, ensure_ascii=False)) | |
| print( | |
| f"Validated JSON; generated {len(generated_ids)} tokens in {time.monotonic() - started:.1f}s.", | |
| file=sys.stderr, | |
| ) | |
| if __name__ == "__main__": | |
| main() | |