Skip to content

Local UI to run and train LLMs and diffusion models. Supports GGUF, MLX, Qwen3.8, DeepSeek-V4.1, MiniMax-H3, Gemma 4, FLUX and more.

2.8 KB
Raw Blame
// SPDX-License-Identifier: AGPL-3.0-only
// Copyright 2026-present the Unsloth AI Inc. team. All rights reserved. See /studio/LICENSE.AGPL-3.0

import type { InferenceParams } from "../types/runtime";

const API_FIELDS = {
  temperature: "temperature",
  topP: "top_p",
  topK: "top_k",
  minP: "min_p",
  repetitionPenalty: "repetition_penalty",
  presencePenalty: "presence_penalty",
} as const;

type SamplingField = keyof typeof API_FIELDS;

export type SavedSampling = Partial<Record<SamplingField, number>>;

type SamplingParams = Pick<InferenceParams, SamplingField | "minPMode">;

const FIELDS = Object.keys(API_FIELDS) as SamplingField[];

/** Min P on the server's choice stays unsaved. */
export function samplingPayload(params: SamplingParams): SavedSampling {
  const sampling: SavedSampling = {};
  for (const field of FIELDS) {
    if (field !== "minP" || params.minPMode === "custom") {
      sampling[field] = params[field];
    }
  }
  return sampling;
}

/** Null for every field forgets the model. */
export function toApiSampling(
  sampling: SavedSampling | null,
): Record<string, number | null> {
  const body: Record<string, number | null> = {};
  for (const field of FIELDS) {
    body[API_FIELDS[field]] = sampling?.[field] ?? null;
  }
  return body;
}

export function fromApiSampling(
  body: Record<string, unknown> | null | undefined,
): SavedSampling | null {
  const sampling: SavedSampling = {};
  for (const field of FIELDS) {
    const value = body?.[API_FIELDS[field]];
    if (typeof value === "number" && Number.isFinite(value)) {
      sampling[field] = value;
    }
  }
  return Object.keys(sampling).length > 0 ? sampling : null;
}

export function sameSampling(a: SavedSampling, b: SavedSampling): boolean {
  return FIELDS.every((field) => {
    const x = a[field];
    const y = b[field];
    return x === undefined || y === undefined
      ? x === y
      : Math.abs(x - y) <= 1e-9;
  });
}

export function samplingSaveStatus(
  remember: boolean,
  saved: SavedSampling | null,
  current: SavedSampling,
): string | null {
  if (remember) {
    return saved && sameSampling(saved, current)
      ? "Saved for this model"
      : "Unsaved changes";
  }
  return saved ? "Saved settings will be forgotten" : null;
}

export function recommendedSampling(
  inference: Record<string, unknown> | null | undefined,
  d: Pick<InferenceParams, SamplingField>,
): Pick<InferenceParams, SamplingField> {
  const recommended = fromApiSampling(inference) ?? {};
  return {
    temperature: recommended.temperature ?? d.temperature,
    topP: recommended.topP ?? d.topP,
    topK: recommended.topK ?? d.topK,
    minP: recommended.minP ?? d.minP,
    // Not part of a model's recommendation.
    repetitionPenalty: d.repetitionPenalty,
    presencePenalty: recommended.presencePenalty ?? d.presencePenalty,
  };
}