Skip to main content

useModelStatus

@fovea/annotation-tool

@fovea/annotation-tool / hooks/useModelConfig / useModelStatus

Function: useModelStatus()

useModelStatus(options?): UseQueryResult<ModelStatusResponse, ApiError>

Defined in: src/hooks/useModelConfig.ts:146

Fetch status information for all loaded models. Includes health status, VRAM usage, and performance metrics. Automatically refetches at a configurable interval for real-time monitoring.

Parameters​

options?​

Omit<UseQueryOptions<ModelStatusResponse, ApiError, ModelStatusResponse, readonly unknown[]>, "queryKey" | "queryFn">

TanStack Query options with optional refetchInterval

Returns​

UseQueryResult<ModelStatusResponse, ApiError>

Query result with model status data

Example​

// Auto-refresh every 5 seconds
const { data: status } = useModelStatus({
  refetchInterval: 5000
})

// Disable auto-refresh
const { data: status } = useModelStatus({
  refetchInterval: false
})