Class Env

Env class that holds detected capabilities

Index

Constructors

Constructors

constructor

new Env(): Env
Returns Env
- Defined in src/util/env.ts:101

Properties

agent

agent: string = ''

Detected agent

backends

backends: string[] = []

List of supported backends

browser

browser: boolean

Running in Browser

cpu

cpu: {
flags: string[];
model: undefined | string;
} = ...

CPU info

filter

filter: undefined | boolean

Are image filters supported?

initial

initial: boolean

Has any work been performed so far

kernels

kernels: string[] = []

List of supported kernels for current backend

node

node: boolean

Running in NodeJS

offscreen

offscreen: undefined | boolean

Is offscreenCanvas supported?

perfadd

perfadd: boolean = false

Are performance counter instant values or additive

platform

platform: string = ''

Detected platform

tensorflow

tensorflow: {
gpu: undefined | boolean;
version: undefined | string;
} = ...

If using tfjs-node get version of underlying tensorflow shared library and if gpu acceleration is enabled

tfjs

tfjs: {
version: undefined | string;
}

TFJS instance details

wasm

wasm: {
    backend: undefined | boolean;
    multithread: undefined | boolean;
    simd: undefined | boolean;
    supported: undefined | boolean;
} = ...

WASM detected capabilities

webgl

webgl: {
    backend: undefined | boolean;
    renderer: undefined | string;
    shader: undefined | string;
    supported: undefined | boolean;
    vendor: undefined | string;
    version: undefined | string;
} = ...

WebGL detected capabilities

webgpu

webgpu: {
    adapter: undefined | GPUAdapterInfo;
    backend: undefined | boolean;
    supported: undefined | boolean;
} = ...

WebGPU detected capabilities

worker

worker: boolean

Running in WebWorker thread

Accessors

Canvas

get Canvas(): undefined
Returns undefined
- Defined in src/util/env.ts:92
set Canvas(val): void
Parameters
- val: undefined
Returns void
- Defined in src/util/env.ts:93

Image

get Image(): undefined
Returns undefined
- Defined in src/util/env.ts:94
set Image(val): void
Parameters
- val: undefined
Returns void
- Defined in src/util/env.ts:96

ImageData

get ImageData(): undefined
Returns undefined
- Defined in src/util/env.ts:97
set ImageData(val): void
Parameters
- val: undefined
Returns void
- Defined in src/util/env.ts:99

Methods

updateBackend

updateBackend(): Promise<void>
update backend information

Returns Promise<void>
- Defined in src/util/env.ts:127

updateCPU

updateCPU(): void
update cpu information

Returns void
- Defined in src/util/env.ts:168

Class Env

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Env

Properties

agent

backends

browser

cpu

filter

initial

kernels

node

offscreen

perfadd

platform

tensorflow

tfjs

wasm

webgl

webgpu

worker

Accessors

Canvas

Returns undefined

Parameters

Returns void

Image

Returns undefined

Parameters

Returns void

ImageData

Returns undefined

Parameters

Returns void

Methods

updateBackend

Returns Promise<void>

updateCPU

Returns void

Settings

On This Page