LocalAI/core/http/endpoints/localai/vram.go

package localai

import (
	"net/http"

	"github.com/labstack/echo/v4"
	"github.com/mudler/LocalAI/core/config"
	"github.com/mudler/LocalAI/core/services/modeladmin"
)

// VRAMEstimateEndpoint returns a handler that estimates VRAM usage for an
// installed model configuration at multiple context sizes.
// @Summary Estimate VRAM usage for a model
// @Description Estimates VRAM based on model weight files at multiple context sizes
// @Tags config
// @Accept json
// @Produce json
// @Param request body modeladmin.VRAMRequest true "VRAM estimation parameters"
// @Success 200 {object} modeladmin.VRAMResponse "VRAM estimate"
// @Router /api/models/vram-estimate [post]
func VRAMEstimateEndpoint(cl *config.ModelConfigLoader, appConfig *config.ApplicationConfig) echo.HandlerFunc {
	return func(c echo.Context) error {
		var req modeladmin.VRAMRequest
		if err := c.Bind(&req); err != nil {
			return c.JSON(http.StatusBadRequest, map[string]any{"error": "invalid request body"})
		}
		resp, err := modeladmin.EstimateVRAM(c.Request().Context(), req, cl, appConfig.SystemState)
		if err != nil {
			return c.JSON(httpStatusForModelAdminError(err), map[string]any{"error": err.Error()})
		}
		// Backwards compat: when there are no weight files, the previous
		// handler returned {"message": "..."} rather than a typed response.
		if resp.ContextNote == "no weight files found for estimation" && resp.EstimateResult.SizeBytes == 0 {
			return c.JSON(http.StatusOK, map[string]any{"message": resp.ContextNote})
		}
		return c.JSON(http.StatusOK, resp)
	}
}