Instructions to use saik0s/comfy_backup with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use saik0s/comfy_backup with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="saik0s/comfy_backup", filename="ComfyUI/models/text_encoders/gemma-3-12b-it-q2_k.gguf", )
llm.create_chat_completion( messages = "No input example has been defined for this model task." )
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use saik0s/comfy_backup with llama.cpp:
Install (macOS, Linux)
curl -LsSf https://llama.app/install.sh | sh # Start a local OpenAI-compatible server with a web UI: llama serve -hf saik0s/comfy_backup:Q4_K_S # Run inference directly in the terminal: llama cli -hf saik0s/comfy_backup:Q4_K_S
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama serve -hf saik0s/comfy_backup:Q4_K_S # Run inference directly in the terminal: llama cli -hf saik0s/comfy_backup:Q4_K_S
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 saik0s/comfy_backup:Q4_K_S # Run inference directly in the terminal: ./llama-cli -hf saik0s/comfy_backup:Q4_K_S
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 saik0s/comfy_backup:Q4_K_S # Run inference directly in the terminal: ./build/bin/llama-cli -hf saik0s/comfy_backup:Q4_K_S
Use Docker
docker model run hf.co/saik0s/comfy_backup:Q4_K_S
- LM Studio
- Jan
- Ollama
How to use saik0s/comfy_backup with Ollama:
ollama run hf.co/saik0s/comfy_backup:Q4_K_S
- Unsloth Studio
How to use saik0s/comfy_backup 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 saik0s/comfy_backup 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 saik0s/comfy_backup to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for saik0s/comfy_backup to start chatting
- Pi
How to use saik0s/comfy_backup with Pi:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf saik0s/comfy_backup:Q4_K_S
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": "saik0s/comfy_backup:Q4_K_S" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Hermes Agent new
How to use saik0s/comfy_backup with Hermes Agent:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf saik0s/comfy_backup:Q4_K_S
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 saik0s/comfy_backup:Q4_K_S
Run Hermes
hermes
- Atomic Chat new
- Docker Model Runner
How to use saik0s/comfy_backup with Docker Model Runner:
docker model run hf.co/saik0s/comfy_backup:Q4_K_S
- Lemonade
How to use saik0s/comfy_backup with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull saik0s/comfy_backup:Q4_K_S
Run and chat with the model
lemonade run user.comfy_backup-Q4_K_S
List all available models
lemonade list
File size: 34,604 Bytes
8d5e143 | 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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 | import requests
import json
import time
import base64
import io
import numpy as np
import torch
import tiktoken
from PIL import Image
import hashlib # Added for hashing PDF bytes in IS_CHANGED
import os
from .chat_manager import ChatSessionManager
# Define a placeholder type name for PDF data.
# The actual input connection will accept '*' but we check the structure.
# Expecting a dictionary: {"filename": str, "bytes": bytes}
PDF_DATA_TYPE = "*" # Use '*' to accept any type, check structure later
class OpenRouterNode:
"""
A node for interacting with OpenRouter's chat/completion API.
Supports text, images, and PDFs as input.
Returns three outputs:
1) "Output": the text response from the LLM
2) "Stats": a string detailing tokens per second, input tokens, and output tokens
3) "Credits": a string showing your remaining OpenRouter account balance
"""
models_cache = None
last_fetch_time = 0
cache_duration = 3600 # Cache duration in seconds (1 hour)
default_request_timeout = 120
min_request_timeout = 1
max_request_timeout = 3600
reasoning_effort_options = ("auto", "none", "minimal", "low", "medium", "high", "xhigh")
default_reasoning_effort = "auto"
def __init__(self):
self.chat_manager = ChatSessionManager()
@staticmethod
def get_api_key(api_key_ui):
"""
Resolves the API key from:
1. UI input field (if not empty)
2. Environment variable 'LLM_KEY'
3. config file 'openrouter_api_key.json' in node directory
"""
if api_key_ui and api_key_ui.strip():
return api_key_ui.strip()
# Check environment variable
env_key = os.environ.get("LLM_KEY")
if env_key and env_key.strip():
return env_key.strip()
# Check JSON file
config_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "openrouter_api_key.json")
if os.path.exists(config_path):
try:
with open(config_path, 'r') as f:
config = json.load(f)
file_key = config.get("api_key")
if file_key and file_key.strip():
return file_key.strip()
except Exception as e:
print(f"Error reading openrouter_api_key.json: {e}")
return ""
@classmethod
def INPUT_TYPES(cls):
"""
Defines the input specification for this node.
Includes optional inputs for image and PDF data.
"""
return {
"required": {
"api_key": ("STRING", {
"multiline": False,
"default": ""
}),
"system_prompt": ("STRING", {
"multiline": True,
"default": "You are a helpful assistant."
}),
"user_message_box": ("STRING", {
"multiline": True,
"default": "Hello, how are you?"
}),
"model": (cls.fetch_openrouter_models(),),
"web_search": ("BOOLEAN", {"default": False}),
"cheapest": ("BOOLEAN", {"default": True}),
"fastest": ("BOOLEAN", {"default": False}),
"aspect_ratio": ([
"auto",
"1:1 (1024x1024)",
"2:3 (832x1248)",
"3:2 (1248x832)",
"3:4 (864x1184)",
"4:3 (1184x864)",
"4:5 (896x1152)",
"5:4 (1152x896)",
"9:16 (768x1344)",
"16:9 (1344x768)",
"21:9 (1536x672)",
"1:4 (google/gemini-3.1-flash-image-preview (Nano Banana 2) only)",
"4:1 (google/gemini-3.1-flash-image-preview (Nano Banana 2) only)",
"1:8 (google/gemini-3.1-flash-image-preview (Nano Banana 2) only)",
"8:1 (google/gemini-3.1-flash-image-preview (Nano Banana 2) only)",
], {"default": "auto"}),
"image_resolution": (["1K", "2K", "4K"], {"default": "1K"}),
"reasoning_effort": (list(cls.reasoning_effort_options), {"default": cls.default_reasoning_effort}),
"seed": ("INT", {"default": 0, "min": 0, "max": 0xffffffffffffffff, "control_after_generate": "fixed"}),
"temperature": ("FLOAT", {
"default": 1.0,
"min": 0.0,
"max": 2.0,
"step": 0.01,
"display": "slider",
"round": 0.01,
}),
"pdf_engine": (["auto", "mistral-ocr", "pdf-text"], {"default": "auto"}),
"chat_mode": ("BOOLEAN", {"default": False}),
"request_timeout": ("INT", {
"default": cls.default_request_timeout,
"min": cls.min_request_timeout,
"max": cls.max_request_timeout,
"step": 1,
"display": "number",
}),
},
"optional": {
"pdf_data": (PDF_DATA_TYPE,), # Use '*' and check structure in generate_response
"user_message_input": ("STRING", {"forceInput": True}),
}
}
RETURN_TYPES = ("STRING", "IMAGE", "STRING", "STRING",)
RETURN_NAMES = ("Output", "image", "Stats", "Credits")
FUNCTION = "generate_response"
CATEGORY = "LLM"
@classmethod
def fetch_openrouter_models(cls):
"""
Fetches a list of model IDs from the OpenRouter API, caching them.
"""
current_time = time.time()
if (cls.models_cache is None) or (current_time - cls.last_fetch_time > cls.cache_duration):
url = "https://openrouter.ai/api/v1/models"
try:
response = requests.get(url, timeout=cls.default_request_timeout)
response.raise_for_status()
models = response.json()["data"]
# Filter for models that support chat completions if needed, but API handles this
model_list = sorted([model['id'] for model in models])
cls.models_cache = model_list
cls.last_fetch_time = current_time
except requests.exceptions.RequestException as e:
print(f"Error fetching models: {e}")
# Provide a default list or indicate error if cache is empty
if cls.models_cache is None:
cls.models_cache = ["error_fetching_models", "google/gemma-3-27b-it", "openai/gpt-4o"] # Example fallbacks
return cls.models_cache if cls.models_cache else ["error_fetching_models"] # Ensure it's never empty
def validate_temperature(self, temperature):
"""
Validates and converts temperature value to float within acceptable range.
"""
try:
temp = float(temperature)
return max(0.0, min(2.0, temp)) # Clamp between 0.0 and 2.0
except (ValueError, TypeError):
return 1.0 # Return default if conversion fails
def validate_request_timeout(self, request_timeout):
"""
Validates and converts request timeout to seconds within an acceptable range.
"""
try:
timeout = int(request_timeout)
return max(self.min_request_timeout, min(self.max_request_timeout, timeout))
except (ValueError, TypeError):
return self.default_request_timeout
@classmethod
def validate_reasoning_effort(cls, reasoning_effort):
"""
Validates OpenRouter reasoning effort. "auto" means do not send a
reasoning override and let OpenRouter/model defaults apply.
"""
if isinstance(reasoning_effort, str):
normalized_effort = reasoning_effort.strip().lower()
if normalized_effort in cls.reasoning_effort_options:
return normalized_effort
return cls.default_reasoning_effort
def fetch_credits(self, api_key, timeout=None):
"""
Fetches the user's credits information from the OpenRouter API.
Returns a formatted string with remaining credits.
"""
api_key = self.get_api_key(api_key)
if not api_key:
return "API Key not provided."
url = "https://openrouter.ai/api/v1/credits"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json",
"HTTP-Referer": "https://github.com/yourusername/comfyui-openrouter",
"X-Title": "ComfyUI OpenRouter LLM Node",
}
try:
validated_timeout = self.validate_request_timeout(timeout)
response = requests.get(url, headers=headers, timeout=validated_timeout)
response.raise_for_status()
result = response.json()
# Check if 'data' and expected keys exist
if "data" in result and "total_credits" in result["data"] and "total_usage" in result["data"]:
total_credits = result["data"]["total_credits"]
total_usage = result["data"]["total_usage"]
remaining = total_credits - total_usage
credits_text = f"Remaining: ${remaining:.3f}"
else:
credits_text = "Could not parse credit data from response."
return credits_text
except requests.exceptions.RequestException as e:
# Provide more context about the error
error_message = f"Error fetching credits: {str(e)}"
if hasattr(e, 'response') and e.response is not None:
error_message += f" | Status Code: {e.response.status_code} | Response: {e.response.text[:200]}" # Log part of response
return error_message
except json.JSONDecodeError:
return "Error fetching credits: Could not decode JSON response."
def generate_response(self, api_key, system_prompt, user_message_box, model,
web_search, cheapest, fastest, temperature, pdf_engine, chat_mode,
request_timeout=120, aspect_ratio="auto", image_resolution="1K", seed=0,
pdf_data=None, user_message_input=None, reasoning_effort="auto", **kwargs):
"""
Sends a completion request to the OpenRouter chat completion endpoint.
Handles text, optional image, and optional PDF inputs.
Returns four outputs:
(1) Output: the LLM's text response
(2) image: an image tensor if the response contains an image, else empty tensor
(3) Stats: a string with tokens per second, prompt tokens, completion tokens
(4) Credits: a string with the user's credit information
"""
# Create empty placeholder image
placeholder_image = torch.zeros((1, 1, 1, 3), dtype=torch.float32)
# Resolve API key
api_key = self.get_api_key(api_key)
if not api_key:
return ("Error: API Key not provided. Set LLM_KEY env var or use openrouter_api_key.json", placeholder_image, "Stats N/A", "Credits N/A")
url = "https://openrouter.ai/api/v1/chat/completions"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json",
"HTTP-Referer": "https://github.com/yourusername/comfyui-openrouter",
"X-Title": "ComfyUI OpenRouter LLM Node",
}
# Validate and convert temperature
validated_temp = self.validate_temperature(temperature)
validated_timeout = self.validate_request_timeout(request_timeout)
validated_reasoning_effort = self.validate_reasoning_effort(reasoning_effort)
# Decide whether to use user_message_input or user_message_box
user_text = user_message_input if user_message_input is not None and user_message_input.strip() else user_message_box
# Initialize session_path
session_path = None
# Handle chat mode
if chat_mode:
# Get or create a chat session
session_path, messages = self.chat_manager.get_or_create_session(user_text, system_prompt)
# Check if we need to update the system prompt (for existing sessions)
if messages and messages[0]["role"] == "system" and messages[0]["content"] != system_prompt:
# Update system prompt if it has changed
messages[0]["content"] = system_prompt
else:
# Non-chat mode: Build the messages array, starting with a system prompt.
messages = [
{"role": "system", "content": system_prompt},
]
# --- Build the user message content ---
user_content_blocks = []
# 1. Add Text part (always present)
user_content_blocks.append({
"type": "text",
"text": user_text
})
# 2. Add Image parts (optional) - support multiple images from kwargs
# Process all image_N inputs from kwargs
image_keys = sorted([k for k in kwargs.keys() if k.startswith('image_')],
key=lambda x: int(x.split('_')[1]))
for image_key in image_keys:
if kwargs[image_key] is not None:
try:
img_str = self.image_to_base64(kwargs[image_key])
user_content_blocks.append({
"type": "image_url",
"image_url": {
"url": f"data:image/png;base64,{img_str}"
}
})
except Exception as e:
print(f"Error processing {image_key}: {e}")
return (f"Error processing {image_key}: {e}", placeholder_image, "Stats N/A", "Credits N/A")
# 3. Add PDF part (optional)
pdf_filename = "document.pdf" # Default filename if not provided
if pdf_data is not None:
# Validate pdf_data structure (expecting dict with 'filename' and 'bytes')
if isinstance(pdf_data, dict) and "bytes" in pdf_data and isinstance(pdf_data["bytes"], bytes):
pdf_bytes = pdf_data["bytes"]
# Use provided filename if available and valid, otherwise use default
if "filename" in pdf_data and isinstance(pdf_data["filename"], str) and pdf_data["filename"].strip():
pdf_filename = pdf_data["filename"]
try:
base64_pdf = base64.b64encode(pdf_bytes).decode('utf-8')
data_url = f"data:application/pdf;base64,{base64_pdf}"
user_content_blocks.append({
"type": "file",
"file": {
"filename": pdf_filename,
"file_data": data_url
}
})
except Exception as e:
print(f"Error encoding PDF: {e}")
return (f"Error encoding PDF: {e}", placeholder_image, "Stats N/A", "Credits N/A")
else:
# Handle case where pdf_data is not in the expected format
print(f"Warning: pdf_data input is not in the expected format (dict with 'filename' and 'bytes'). PDF not included.")
# Optionally return an error or just proceed without the PDF
# return ("Error: Invalid PDF data format.", "Stats N/A", "Credits N/A")
# Determine message format based on content type
# Use simple string format for text-only requests to ensure compatibility
# Use structured format only when we have multimodal content
has_multimodal_content = len(user_content_blocks) > 1 or any(block.get("type") != "text" for block in user_content_blocks)
if has_multimodal_content:
# Use structured format for multimodal content
new_user_message = {
"role": "user",
"content": user_content_blocks
}
else:
# Use simple string format for text-only requests
new_user_message = {
"role": "user",
"content": user_text
}
if chat_mode:
# In chat mode, append to existing conversation (but don't save yet - wait for response)
messages.append(new_user_message)
else:
# In non-chat mode, messages array already has system prompt, just append user message
messages.append(new_user_message)
# --- Apply model modifiers ---
modified_model = model
# Check if model already has modifiers to avoid duplication
if web_search and ":online" not in modified_model:
modified_model = f"{modified_model}:online"
if ":online" not in modified_model:
if cheapest and ":floor" not in modified_model:
modified_model = f"{modified_model}:floor"
elif fastest and not cheapest and ":nitro" not in modified_model:
modified_model = f"{modified_model}:nitro"
# --- Construct the final payload ---
data = {
"model": modified_model,
"messages": messages,
"temperature": validated_temp,
"seed": seed
}
if validated_reasoning_effort != "auto":
data["reasoning"] = {"effort": validated_reasoning_effort}
print(f"Payload: model={modified_model}")
# Add plugins if a specific PDF engine is selected
if pdf_engine != "auto":
data["plugins"] = [
{
"id": "file-parser",
"pdf": {
"engine": pdf_engine
}
}
]
# --- Pre-calculate text input tokens (rough estimate) ---
# Note: Actual token count depends on the model and includes parsed PDF/image data.
# Rely on the API response for accurate usage stats.
text_token_estimate = 0
try:
text_token_estimate = self.count_tokens(system_prompt, model) + self.count_tokens(user_text, model)
except Exception as e:
print(f"Warning: Token counting failed - {e}")
# --- Make API Call and Process Response ---
try:
start_time = time.time()
response = requests.post(url, headers=headers, json=data, timeout=validated_timeout)
response.raise_for_status() # Raises HTTPError for bad responses (4xx or 5xx)
end_time = time.time()
result = response.json()
# Debug: print truncated response to see what OpenRouter returned
debug_str = json.dumps(result, default=str)
print(f"API response ({len(debug_str)} chars): {debug_str[:500]}")
# --- Extract results and calculate stats ---
if not result.get("choices") or not result["choices"][0].get("message"):
raise ValueError("Invalid response format from API: 'choices' or 'message' missing.")
# Parse response for text and image content
message = result["choices"][0]["message"]
text_output = message.get("content", "")
image_tensor = placeholder_image
# Check for images in the separate images field (OpenRouter format)
if message.get("images"):
print(f"Found {len(message['images'])} image(s) in API response")
try:
# Get the first image from the images array
first_image = message["images"][0]
image_url = first_image["image_url"]["url"]
if image_url.startswith("data:image"):
base64_str = image_url.split(",", 1)[1]
try:
# Convert base64 to image tensor
image_tensor = self.base64_to_image(base64_str)
print(f"Successfully decoded image from API response")
except Exception as e:
print(f"Error decoding image: {e}")
else:
print(f"Image URL format not supported: {image_url[:50]}...")
except Exception as e:
print(f"Error processing images from response: {e}")
else:
print("No images found in API response - this may be normal if the model doesn't support image generation or the prompt didn't request an image")
# Also handle legacy multimodal content format as fallback
if isinstance(text_output, list):
text_parts = []
for content in text_output:
if isinstance(content, dict):
if content.get("type") == "text":
text_parts.append(content.get("text", ""))
elif content.get("type") == "image_url":
# Extract base64 image data
image_url = content["image_url"]["url"]
if image_url.startswith("data:image"):
base64_str = image_url.split(",", 1)[1]
try:
# Convert base64 to image tensor
image_tensor = self.base64_to_image(base64_str)
except Exception as e:
print(f"Error decoding image: {e}")
text_output = "\n".join(text_parts)
response_ms = result.get("response_ms", None)
api_usage = result.get("usage", {})
prompt_tokens = api_usage.get("prompt_tokens", text_token_estimate) # Use API value if available
completion_tokens = api_usage.get("completion_tokens", 0)
if completion_tokens == 0 and text_output: # Estimate completion tokens if API doesn't provide them
try:
completion_tokens = self.count_tokens(text_output, model)
except Exception as e:
print(f"Warning: Completion token counting failed - {e}")
# Calculate tokens per second (TPS)
tps = 0
elapsed_time = end_time - start_time
if response_ms is not None:
server_elapsed_time = response_ms / 1000.0
if server_elapsed_time > 0:
tps = completion_tokens / server_elapsed_time
elif elapsed_time > 0:
# Use client-side timing as fallback, less accurate due to network latency
tps = completion_tokens / elapsed_time
# Optional: apply a heuristic correction factor if needed, but server time is better
# correction_factor = 1.28 # Example factor, might need tuning
# tps *= correction_factor
stats_text = (
f"TPS: {tps:.2f}, "
f"Prompt Tokens: {prompt_tokens}, "
f"Completion Tokens: {completion_tokens}, "
f"Temp: {validated_temp:.1f}, "
f"Model: {modified_model}" # Display the actual model used
)
if pdf_engine != "auto":
stats_text += f", PDF Engine: {pdf_engine}"
if validated_reasoning_effort != "auto":
stats_text += f", Reasoning: {validated_reasoning_effort}"
# Fetch credits information AFTER the main request
credits_text = self.fetch_credits(api_key, timeout=validated_timeout)
# Save conversation in chat mode
if chat_mode and session_path:
# Append assistant's response to the conversation
assistant_message = {
"role": "assistant",
"content": text_output
}
messages.append(assistant_message)
# Save the updated conversation
self.chat_manager.save_conversation(session_path, messages)
return (text_output, image_tensor, stats_text, credits_text)
except requests.exceptions.RequestException as e:
error_message = f"API Request Error: {str(e)}"
if hasattr(e, 'response') and e.response is not None:
try:
error_detail = e.response.json()
error_message += f" | Details: {error_detail}"
except json.JSONDecodeError:
error_message += f" | Status: {e.response.status_code} | Response: {e.response.text[:200]}"
else:
error_message += " (Network or connection issue)"
print(f"ERROR: {error_message}")
return (error_message, placeholder_image, "Stats N/A due to error", "Credits N/A due to error")
except Exception as e:
print(f"ERROR: Node Error: {str(e)}")
return (f"Node Error: {str(e)}", placeholder_image, "Stats N/A due to error", "Credits N/A due to error")
@staticmethod
def image_to_base64(image):
"""
Converts a ComfyUI IMAGE (torch.Tensor, BHWC, float 0-1)
into a base64-encoded PNG string.
"""
if not isinstance(image, torch.Tensor):
raise TypeError("Input 'image' is not a torch.Tensor")
# Remove batch dimension if present
if image.ndim == 4:
if image.shape[0] != 1:
print(f"Warning: Image batch size is {image.shape[0]}, using only the first image.")
image = image.squeeze(0) # Shape HWC
if image.ndim != 3:
raise ValueError(f"Unexpected image dimensions: {image.shape}. Expected HWC.")
# Convert float tensor (0-1) to numpy array (0-255, uint8)
image_np = image.cpu().numpy()
if image_np.dtype != np.uint8:
if image_np.min() < 0 or image_np.max() > 1:
print("Warning: Image tensor values outside [0, 1] range. Clamping.")
image_np = np.clip(image_np, 0, 1)
image_np = (image_np * 255).astype(np.uint8)
# Convert numpy array to PIL Image
pil_image = Image.fromarray(image_np, 'RGB') # Assuming RGB, adjust if needed
# Save PIL Image to a bytes buffer as PNG
buffered = io.BytesIO()
pil_image.save(buffered, format="PNG")
# Encode the bytes buffer to base64 string
return base64.b64encode(buffered.getvalue()).decode('utf-8')
@staticmethod
def base64_to_image(base64_str: str) -> torch.Tensor:
"""
Converts a base64 image string to a ComfyUI image tensor
Returns tensor in [1, H, W, 3] format with values in [0, 1]
"""
try:
# Decode base64 string to image
img_data = base64.b64decode(base64_str)
img = Image.open(io.BytesIO(img_data))
img = img.convert("RGB")
# Convert to numpy array and normalize to [0, 1]
img_array = np.array(img).astype(np.float32) / 255.0
# Add batch dimension: [1, H, W, 3]
img_tensor = torch.from_numpy(img_array).unsqueeze(0)
print(f"Successfully converted base64 to image tensor: {img_tensor.shape}")
return img_tensor
except Exception as e:
print(f"Error in base64_to_image: {e}")
# Return a small placeholder image instead of failing
return torch.zeros((1, 64, 64, 3), dtype=torch.float32)
@staticmethod
def count_tokens(text, model):
"""
Count tokens for a given text using tiktoken.
Uses model-specific encodings where possible, falls back to cl100k_base.
Handles potential errors during encoding.
"""
if not text or not isinstance(text, str):
return 0
# Strip any model modifiers like :floor, :nitro, :online
base_model = model.split(':')[0] if ':' in model else model
# Simplified mapping, cl100k_base is common for many recent models
encoding_name = "cl100k_base"
try:
# List known models/prefixes that definitely use cl100k_base
# Add others if known, but cl100k_base is a safe default for many
cl100k_models = [
"openai/gpt-4", "openai/gpt-3.5", "openai/gpt-4o",
"anthropic/claude",
"google/gemini",
"meta-llama/llama-2", "meta-llama/llama-3",
"mistralai/mistral", "mistralai/mixtral",
]
# Check if the base_model or its prefix matches known cl100k models
is_cl100k = any(base_model.startswith(prefix) for prefix in cl100k_models)
if is_cl100k:
encoding_name = "cl100k_base"
# else: # Add logic for other encodings if needed, e.g., p50k_base for older models
# pass # Stick with cl100k_base as default for now
encoding = tiktoken.get_encoding(encoding_name)
token_count = len(encoding.encode(text, disallowed_special=())) # Allow special tokens
return token_count
except Exception as e:
print(f"Warning: Tiktoken error for model '{model}' (base: '{base_model}', encoding: '{encoding_name}'): {e}. Falling back to estimation.")
# Fallback: Estimate tokens based on characters (rough approximation)
# Average ~4 chars per token is a common heuristic
return max(1, round(len(text) / 4))
@classmethod
def IS_CHANGED(cls, api_key, system_prompt, user_message_box, model,
web_search, cheapest, fastest, temperature, pdf_engine, chat_mode,
request_timeout=120, aspect_ratio="auto", image_resolution="1K", seed=0,
pdf_data=None, user_message_input=None, reasoning_effort="auto", **kwargs):
"""
Check if any input that affects the output has changed.
Includes hashing image and PDF data.
"""
# Hash image data if present - handle multiple images from kwargs
image_hashes = []
image_keys = sorted([k for k in kwargs.keys() if k.startswith('image_')],
key=lambda x: int(x.split('_')[1]))
for image_key in image_keys:
if kwargs[image_key] is not None:
image = kwargs[image_key]
if isinstance(image, torch.Tensor):
try:
hasher = hashlib.sha256()
hasher.update(image.cpu().numpy().tobytes())
image_hashes.append(hasher.hexdigest())
except Exception as e:
print(f"Warning: Could not hash {image_key} data for IS_CHANGED: {e}")
image_hashes.append(f"{image_key}_hashing_error")
else:
image_hashes.append(None)
# Hash PDF data if present and valid
pdf_hash = None
if pdf_data is not None and isinstance(pdf_data, dict) and "bytes" in pdf_data and isinstance(pdf_data["bytes"], bytes):
try:
hasher = hashlib.sha256()
hasher.update(pdf_data["bytes"])
pdf_hash = hasher.hexdigest()
# Optionally include filename in hash if it affects processing?
# if "filename" in pdf_data: hasher.update(pdf_data["filename"].encode())
except Exception as e:
print(f"Warning: Could not hash pdf data for IS_CHANGED: {e}")
pdf_hash = "pdf_hashing_error" # Use a placeholder on error
elif pdf_data is not None:
# Handle cases where pdf_data is present but not in the expected format
pdf_hash = "invalid_pdf_data_format"
# Ensure temperature is consistently represented (e.g., as float)
try:
temp_float = float(temperature) if isinstance(temperature, (str, int, float)) else 1.0
temp_float = max(0.0, min(2.0, temp_float))
except (ValueError, TypeError):
temp_float = 1.0
try:
timeout_int = int(request_timeout)
timeout_int = max(cls.min_request_timeout, min(cls.max_request_timeout, timeout_int))
except (ValueError, TypeError):
timeout_int = cls.default_request_timeout
validated_reasoning_effort = cls.validate_reasoning_effort(reasoning_effort)
# Combine all relevant inputs into a tuple for comparison
# Use primitive types where possible for reliable hashing/comparison
# Note: api_key here is the UI value only. Keys resolved from the LLM_KEY
# env var or openrouter_api_key.json are intentionally NOT part of the
# cache key — they're treated as user environment, not workflow inputs.
return (api_key, system_prompt, user_message_box, model,
web_search, cheapest, fastest, temp_float, pdf_engine, chat_mode,
timeout_int, aspect_ratio, image_resolution, seed, validated_reasoning_effort,
tuple(image_hashes), pdf_hash, user_message_input)
# Node class mappings
NODE_CLASS_MAPPINGS = {
"OpenRouterNode": OpenRouterNode
}
# Node display name mappings
NODE_DISPLAY_NAME_MAPPINGS = {
"OpenRouterNode": "OpenRouter LLM Node (Text/Multi-Image/PDF/Chat)" # Updated name
}
|