Class RembgConfig

Central configuration singleton for rembg-web Manages model paths and other configuration settings

Methods

getInstance setCustomModelPath getCustomModelPath getAllModelPaths hasCustomPath resetToDefaults removeCustomPath getAvailableModels setBaseUrl getBaseUrl enableWebNN setWebNNDeviceType setWebNNPowerPreference isWebNNEnabled getWebNNDeviceType getWebNNPowerPreference getWebNNConfig resetWebNNSettings enableWebGPU setWebGPUPowerPreference isWebGPUEnabled getWebGPUPowerPreference getWebGPUConfig resetWebGPUSettings enableGeneralLogging enablePerformanceLogging isGeneralLoggingEnabled isPerformanceLoggingEnabled enableONNXProfiling isONNXProfilingEnabled getLoggingConfig resetLoggingSettings setSessionCacheBypass setModelCacheBypass isSessionCacheBypassEnabled isModelCacheBypassEnabled getCacheBypassConfig resetCacheBypassSettings

Methods

Static getInstance

setCustomModelPath

  • setCustomModelPath(modelName, path): void

  • Set a custom model path for a specific model

    Parameters

    • modelName: string

      Name of the model

    • path: string

      Custom path to the model file

    Returns void

getCustomModelPath

  • getCustomModelPath(modelName): undefined | string

  • Get the model path for a specific model

    Parameters

    • modelName: string

      Name of the model

    Returns undefined | string

    The model path, or undefined if not set

getAllModelPaths

  • getAllModelPaths(): Map<string, string>

  • Get all configured model paths

    Returns Map<string, string>

    Map of model names to their paths

hasCustomPath

  • hasCustomPath(modelName): boolean

  • Check if a model has a custom path configured

    Parameters

    • modelName: string

      Name of the model

    Returns boolean

    True if a custom path is configured

resetToDefaults

  • resetToDefaults(): void

  • Reset all model paths to defaults

    Returns void

removeCustomPath

  • removeCustomPath(modelName): void

  • Remove a custom model path (will use default)

    Parameters

    • modelName: string

      Name of the model

    Returns void

getAvailableModels

  • getAvailableModels(): string[]

  • Get list of all available model names

    Returns string[]

    Array of model names

setBaseUrl

getBaseUrl

  • getBaseUrl(): string

  • Get the current base URL for model paths

    Returns string

    The current base URL

enableWebNN

  • enableWebNN(enable): void

  • Enable or disable WebNN support globally

    Parameters

    • enable: boolean

      Whether to enable WebNN

    Returns void

setWebNNDeviceType

  • setWebNNDeviceType(deviceType): void

  • Set the preferred WebNN device type

    Parameters

    • deviceType: "cpu" | "gpu" | "npu"

      The device type to prefer ('cpu', 'gpu', or 'npu')

    Returns void

setWebNNPowerPreference

  • setWebNNPowerPreference(preference): void

  • Set the WebNN power preference

    Parameters

    • preference: "default" | "low-power" | "high-performance"

      The power preference ('default', 'low-power', or 'high-performance')

    Returns void

isWebNNEnabled

  • isWebNNEnabled(): boolean

  • Check if WebNN is enabled globally

    Returns boolean

    True if WebNN is enabled

getWebNNDeviceType

  • getWebNNDeviceType(): "cpu" | "gpu" | "npu"

  • Get the current WebNN device type

    Returns "cpu" | "gpu" | "npu"

    The current device type

getWebNNPowerPreference

  • getWebNNPowerPreference(): "default" | "low-power" | "high-performance"

  • Get the current WebNN power preference

    Returns "default" | "low-power" | "high-performance"

    The current power preference

getWebNNConfig

  • getWebNNConfig(): {
        enabled: boolean;
        deviceType: "cpu" | "gpu" | "npu";
        powerPreference: "default" | "low-power" | "high-performance";
    }

  • Get all WebNN configuration settings

    Returns {
        enabled: boolean;
        deviceType: "cpu" | "gpu" | "npu";
        powerPreference: "default" | "low-power" | "high-performance";
    }

    Object containing all WebNN settings

    • enabled: boolean
    • deviceType: "cpu" | "gpu" | "npu"
    • powerPreference: "default" | "low-power" | "high-performance"

resetWebNNSettings

  • resetWebNNSettings(): void

  • Reset WebNN settings to defaults

    Returns void

enableWebGPU

  • enableWebGPU(enable): void

  • Enable or disable WebGPU support globally

    Parameters

    • enable: boolean

      Whether to enable WebGPU

    Returns void

setWebGPUPowerPreference

  • setWebGPUPowerPreference(preference): void

  • Set the WebGPU power preference

    Parameters

    • preference: "default" | "low-power" | "high-performance"

      The power preference ('default', 'low-power', or 'high-performance')

    Returns void

isWebGPUEnabled

  • isWebGPUEnabled(): boolean

  • Check if WebGPU is enabled globally

    Returns boolean

    True if WebGPU is enabled

getWebGPUPowerPreference

  • getWebGPUPowerPreference(): "default" | "low-power" | "high-performance"

  • Get the current WebGPU power preference

    Returns "default" | "low-power" | "high-performance"

    The current power preference

getWebGPUConfig

  • getWebGPUConfig(): {
        enabled: boolean;
        powerPreference: "default" | "low-power" | "high-performance";
    }

  • Get all WebGPU configuration settings

    Returns {
        enabled: boolean;
        powerPreference: "default" | "low-power" | "high-performance";
    }

    Object containing all WebGPU settings

    • enabled: boolean
    • powerPreference: "default" | "low-power" | "high-performance"

resetWebGPUSettings

  • resetWebGPUSettings(): void

  • Reset WebGPU settings to defaults

    Returns void

enableGeneralLogging

  • enableGeneralLogging(enable): void

  • Enable or disable general logging (info, debug messages)

    Parameters

    • enable: boolean

      Whether to enable general logging

    Returns void

enablePerformanceLogging

  • enablePerformanceLogging(enable): void

  • Enable or disable performance logging (timing messages)

    Parameters

    • enable: boolean

      Whether to enable performance logging

    Returns void

isGeneralLoggingEnabled

  • isGeneralLoggingEnabled(): boolean

  • Check if general logging is enabled

    Returns boolean

    True if general logging is enabled

isPerformanceLoggingEnabled

  • isPerformanceLoggingEnabled(): boolean

  • Check if performance logging is enabled

    Returns boolean

    True if performance logging is enabled

enableONNXProfiling

  • enableONNXProfiling(enable): void

  • Enable or disable ONNX Runtime profiling

    Parameters

    • enable: boolean

      Whether to enable ONNX profiling

    Returns void

isONNXProfilingEnabled

  • isONNXProfilingEnabled(): boolean

  • Check if ONNX profiling is enabled

    Returns boolean

    True if ONNX profiling is enabled

getLoggingConfig

  • getLoggingConfig(): {
        generalLogging: boolean;
        performanceLogging: boolean;
        onnxProfiling: boolean;
    }

  • Get all logging configuration settings

    Returns {
        generalLogging: boolean;
        performanceLogging: boolean;
        onnxProfiling: boolean;
    }

    Object containing all logging settings

    • generalLogging: boolean
    • performanceLogging: boolean
    • onnxProfiling: boolean

resetLoggingSettings

  • resetLoggingSettings(): void

  • Reset logging settings to defaults

    Returns void

setSessionCacheBypass

  • setSessionCacheBypass(bypass): void

  • Enable or disable session cache bypass globally

    Parameters

    • bypass: boolean

      Whether to bypass session cache

    Returns void

setModelCacheBypass

  • setModelCacheBypass(bypass): void

  • Enable or disable model cache bypass globally

    Parameters

    • bypass: boolean

      Whether to bypass model cache

    Returns void

isSessionCacheBypassEnabled

  • isSessionCacheBypassEnabled(): boolean

  • Check if session cache bypass is enabled globally

    Returns boolean

    True if session cache bypass is enabled

isModelCacheBypassEnabled

  • isModelCacheBypassEnabled(): boolean

  • Check if model cache bypass is enabled globally

    Returns boolean

    True if model cache bypass is enabled

getCacheBypassConfig

  • getCacheBypassConfig(): {
        sessionCacheBypass: boolean;
        modelCacheBypass: boolean;
    }

  • Get all cache bypass configuration settings

    Returns {
        sessionCacheBypass: boolean;
        modelCacheBypass: boolean;
    }

    Object containing all cache bypass settings

    • sessionCacheBypass: boolean
    • modelCacheBypass: boolean

resetCacheBypassSettings

  • resetCacheBypassSettings(): void

  • Reset cache bypass settings to defaults

    Returns void

Settings

Member Visibility

Theme

On This Page

getInstancesetCustomModelPathgetCustomModelPathgetAllModelPathshasCustomPathresetToDefaultsremoveCustomPathgetAvailableModelssetBaseUrlgetBaseUrlenableWebNNsetWebNNDeviceTypesetWebNNPowerPreferenceisWebNNEnabledgetWebNNDeviceTypegetWebNNPowerPreferencegetWebNNConfigresetWebNNSettingsenableWebGPUsetWebGPUPowerPreferenceisWebGPUEnabledgetWebGPUPowerPreferencegetWebGPUConfigresetWebGPUSettingsenableGeneralLoggingenablePerformanceLoggingisGeneralLoggingEnabledisPerformanceLoggingEnabledenableONNXProfilingisONNXProfilingEnabledgetLoggingConfigresetLoggingSettingssetSessionCacheBypasssetModelCacheBypassisSessionCacheBypassEnabledisModelCacheBypassEnabledgetCacheBypassConfigresetCacheBypassSettings