onnxruntime-web/lib/build-def.d.ts

A Javascript library for running ONNX models on browsers

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

/* eslint-disable @typescript-eslint/naming-convention */

/**
 * The interface BuildDefinitions contains a set of flags which are defined at build time.
 *
 * Those flags are processed in bundler for tree shaking to remove unused code.
 * No flags in this file should present in production build.
 */
interface BuildDefinitions {
  /**
   * defines whether to disable the whole WebGL backend in the build.
   */
  readonly DISABLE_WEBGL: boolean;
  /**
   * defines whether to disable the whole WebGpu backend in the build.
   */
  readonly DISABLE_WEBGPU: boolean;
  /**
   * defines whether to disable the whole WebNN backend in the build.
   */
  readonly DISABLE_WASM: boolean;
  /**
   * defines whether to disable proxy feature in WebAssembly backend in the build.
   */
  readonly DISABLE_WASM_PROXY: boolean;
  /**
   * defines whether to disable multi-threading feature in WebAssembly backend in the build.
   */
  readonly DISABLE_WASM_THREAD: boolean;
  /**
   * defines whether to disable training APIs in WebAssembly backend.
   */
  readonly DISABLE_TRAINING: boolean;
}

declare const BUILD_DEFS: BuildDefinitions;