2025-02-05 15:29:47 +01:00
<!DOCTYPE html> < html class = "default" lang = "en" data-base = ".." > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > Config | @vladmandic/human - v3.3.4< / title > < meta name = "description" content = "Documentation for @vladmandic/human" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script defer src = "../assets/main.js" > < / script > < script async src = "../assets/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < script async src = "../assets/hierarchy.js" id = "tsd-hierarchy-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < div class = "table-cell" id = "tsd-search" > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div > < div class = "field" > < div id = "tsd-toolbar-links" > < / div > < / div > < ul class = "results" > < li class = "state loading" > Preparing search index...< / li > < li class = "state failure" > The search index is not available< / li > < / ul > < a href = "../index.html" class = "title" > @vladmandic/human - v3.3.4< / a > < / div > < div class = "table-cell" id = "tsd-widgets" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" > < li > < a href = "../index.html" > @vladmandic/human< / a > < / li > < li > < a href = "Config.html" > Config< / a > < / li > < / ul > < h1 > Interface Config< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Configuration interface definition for < strong > Human< / strong > library
2022-11-18 17:13:29 +01:00
Contains all configurable parameters
2025-02-05 15:29:47 +01:00
Defaults: < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L262" > config< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < div class = "tsd-signature" > < span class = "tsd-signature-keyword" > interface< / span > < span class = "tsd-kind-interface" > Config< / span > < span class = "tsd-signature-symbol" > {< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#async" > async< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#backend" > backend< / a > < span class = "tsd-signature-symbol" > :< / span > < a href = "../types/BackendEnum.html" class = "tsd-signature-type tsd-kind-type-alias" > BackendEnum< / a > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#body" > body< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "BodyConfig.html" class = "tsd-signature-type tsd-kind-interface" > BodyConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#cachemodels" > cacheModels< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#cachesensitivity" > cacheSensitivity< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#deallocate" > deallocate< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#debug" > debug< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#face" > face< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceConfig.html" class = "tsd-signature-type tsd-kind-interface" > FaceConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#filter" > filter< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FilterConfig.html" class = "tsd-signature-type tsd-kind-interface" > FilterConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#flags" > flags< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Record< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ,< / span > < span class = "tsd-signature-type" > unknown< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#gesture" > gesture< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "GestureConfig.html" class = "tsd-signature-type tsd-kind-interface" > GestureConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#hand" > hand< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "HandConfig.html" class = "tsd-signature-type tsd-kind-interface" > HandConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "Config.html#modelbasepath" > modelBasePath< / a > < span class = "tsd-signatur
2024-04-17 17:29:51 +02:00
< a href = "Config.html#backend" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > backend< / span > < / a >
< a href = "Config.html#body" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > body< / span > < / a >
2025-02-05 15:29:47 +01:00
< a href = "Config.html#cachemodels" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > cache< wbr / > Models< / span > < / a >
< a href = "Config.html#cachesensitivity" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > cache< wbr / > Sensitivity< / span > < / a >
2024-04-17 17:29:51 +02:00
< a href = "Config.html#deallocate" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > deallocate< / span > < / a >
< a href = "Config.html#debug" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > debug< / span > < / a >
< a href = "Config.html#face" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > face< / span > < / a >
< a href = "Config.html#filter" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > filter< / span > < / a >
< a href = "Config.html#flags" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > flags< / span > < / a >
< a href = "Config.html#gesture" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > gesture< / span > < / a >
< a href = "Config.html#hand" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > hand< / span > < / a >
2025-02-05 15:29:47 +01:00
< a href = "Config.html#modelbasepath" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > model< wbr / > Base< wbr / > Path< / span > < / a >
2024-04-17 17:29:51 +02:00
< a href = "Config.html#object" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > object< / span > < / a >
< a href = "Config.html#segmentation" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > segmentation< / span > < / a >
2025-02-05 15:29:47 +01:00
< a href = "Config.html#skipallowed" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > skip< wbr / > Allowed< / span > < / a >
< a href = "Config.html#softwarekernels" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > software< wbr / > Kernels< / span > < / a >
< a href = "Config.html#validatemodels" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > validate< wbr / > Models< / span > < / a >
2024-04-17 17:29:51 +02:00
< a href = "Config.html#warmup" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > warmup< / span > < / a >
2025-02-05 15:29:47 +01:00
< a href = "Config.html#wasmpath" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > wasm< wbr / > Path< / span > < / a >
< a href = "Config.html#wasmplatformfetch" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > wasm< wbr / > Platform< wbr / > Fetch< / span > < / a >
2024-09-10 21:44:39 +02:00
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < a id = "async" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > async< / span > < a href = "#async" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > async< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Perform model loading and inference concurrently or sequentially< / p >
2022-11-18 17:13:29 +01:00
< p > default: < code > true< / code > < / p >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L269" > src/config.ts:269< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "backend" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > backend< / span > < a href = "#backend" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > backend< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../types/BackendEnum.html" class = "tsd-signature-type tsd-kind-type-alias" > BackendEnum< / a > < / div > < div class = "tsd-comment tsd-typography" > < p > Backend used for TFJS operations
2022-11-18 17:13:29 +01:00
valid build-in backends are:< / p >
< ul >
< li > Browser: < code > cpu< / code > , < code > wasm< / code > , < code > webgl< / code > , < code > humangl< / code > , < code > webgpu< / code > < / li >
< li > NodeJS: < code > cpu< / code > , < code > wasm< / code > , < code > tensorflow< / code >
default: < code > webgl< / code > for browser and < code > tensorflow< / code > for nodejs< / li >
< / ul >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L245" > src/config.ts:245< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "body" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > body< / span > < a href = "#body" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > body< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "BodyConfig.html" class = "tsd-signature-type tsd-kind-interface" > BodyConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Body config < a href = "BodyConfig.html" class = "tsd-kind-interface" > BodyConfig< / a > < / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L329" > src/config.ts:329< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "cachemodels" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > cache< wbr / > Models< / span > < a href = "#cachemodels" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > cacheModels< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Cache models in IndexDB on first sucessfull load
2022-11-18 17:13:29 +01:00
default: true if indexdb is available (browsers), false if its not (nodejs)< / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L289" > src/config.ts:289< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "cachesensitivity" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > cache< wbr / > Sensitivity< / span > < a href = "#cachesensitivity" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > cacheSensitivity< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Cache sensitivity< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > values 0..1 where 0.01 means reset cache if input changed more than 1%< / li >
< li > set to 0 to disable caching< / li >
< / ul >
< p > default: 0.7< / p >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L303" > src/config.ts:303< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "deallocate" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > deallocate< / span > < a href = "#deallocate" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > deallocate< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Perform immediate garbage collection on deallocated tensors instead of caching them< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L314" > src/config.ts:314< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "debug" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > debug< / span > < a href = "#debug" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > debug< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Print debug statements to console< / p >
2022-11-18 17:13:29 +01:00
< p > default: < code > true< / code > < / p >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L263" > src/config.ts:263< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "face" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > face< / span > < a href = "#face" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > face< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceConfig.html" class = "tsd-signature-type tsd-kind-interface" > FaceConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Face config < a href = "FaceConfig.html" class = "tsd-kind-interface" > FaceConfig< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L326" > src/config.ts:326< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "filter" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > filter< / span > < a href = "#filter" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > filter< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FilterConfig.html" class = "tsd-signature-type tsd-kind-interface" > FilterConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Filter config < a href = "FilterConfig.html" class = "tsd-kind-interface" > FilterConfig< / a > < / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L320" > src/config.ts:320< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "flags" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > flags< / span > < a href = "#flags" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > flags< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Record< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ,< / span > < span class = "tsd-signature-type" > unknown< / span > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Explicit flags passed to initialize TFJS< / p >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L306" > src/config.ts:306< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "gesture" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > gesture< / span > < a href = "#gesture" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > gesture< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "GestureConfig.html" class = "tsd-signature-type tsd-kind-interface" > GestureConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Gesture config < a href = "GestureConfig.html" class = "tsd-kind-interface" > GestureConfig< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L323" > src/config.ts:323< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "hand" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > hand< / span > < a href = "#hand" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > hand< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "HandConfig.html" class = "tsd-signature-type tsd-kind-interface" > HandConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Hand config < a href = "HandConfig.html" class = "tsd-kind-interface" > HandConfig< / a > < / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L332" > src/config.ts:332< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "modelbasepath" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > model< wbr / > Base< wbr / > Path< / span > < a href = "#modelbasepath" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > modelBasePath< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Base model path (typically starting with file://, http:// or https://) for all models< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > individual modelPath values are relative to this path< / li >
< / ul >
< p > default: < code > ../models/< / code > for browsers and < code > file://models/< / code > for nodejs< / p >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L284" > src/config.ts:284< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "object" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > object< / span > < a href = "#object" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > object< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "ObjectConfig.html" class = "tsd-signature-type tsd-kind-interface" > ObjectConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Object config < a href = "ObjectConfig.html" class = "tsd-kind-interface" > ObjectConfig< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L335" > src/config.ts:335< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "segmentation" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > segmentation< / span > < a href = "#segmentation" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > segmentation< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "SegmentationConfig.html" class = "tsd-signature-type tsd-kind-interface" > SegmentationConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Segmentation config < a href = "SegmentationConfig.html" class = "tsd-kind-interface" > SegmentationConfig< / a > < / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L338" > src/config.ts:338< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "skipallowed" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > skip< wbr / > Allowed< / span > < a href = "#skipallowed" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > skipAllowed< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Internal Variable< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L317" > src/config.ts:317< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "softwarekernels" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > software< wbr / > Kernels< / span > < a href = "#softwarekernels" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > softwareKernels< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Software Kernels
2022-11-18 17:13:29 +01:00
Registers software kernel ops running on CPU when accelerated version of kernel is not found in the current backend< / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L311" > src/config.ts:311< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "validatemodels" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > validate< wbr / > Models< / span > < a href = "#validatemodels" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > validateModels< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Validate kernel ops used in model during model load
2022-11-18 17:13:29 +01:00
default: true
any errors will be printed on console but will be treated as non-fatal< / p >
2024-09-11 18:13:03 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L295" > src/config.ts:295< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "warmup" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > warmup< / span > < a href = "#warmup" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > warmup< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../types/WarmupEnum.html" class = "tsd-signature-type tsd-kind-type-alias" > WarmupEnum< / a > < / div > < div class = "tsd-comment tsd-typography" > < p > What to use for < code > human.warmup()< / code > < / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > warmup pre-initializes all models for faster inference but can take significant time on startup< / li >
< li > used by < code > webgl< / code > , < code > humangl< / code > and < code > webgpu< / code > backends< / li >
< / ul >
< p > default: < code > full< / code > < / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L277" > src/config.ts:277< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "wasmpath" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > wasm< wbr / > Path< / span > < a href = "#wasmpath" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > wasmPath< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Path to *.wasm files if backend is set to < code > wasm< / code > < / p >
2022-11-18 17:13:29 +01:00
< p > default: auto-detects to link to CDN < code > jsdelivr< / code > when running in browser< / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L251" > src/config.ts:251< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "wasmplatformfetch" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > wasm< wbr / > Platform< wbr / > Fetch< / span > < a href = "#wasmplatformfetch" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > wasmPlatformFetch< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Force WASM loader to use platform fetch< / p >
2022-11-18 17:13:29 +01:00
< p > default: false< / p >
2025-02-05 15:29:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L257" > src/config.ts:257< / a > < / li > < / ul > < / aside > < / section > < / section > < / details > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < span class = "settings-label" > Member Visibility< / span > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < / ul > < / div > < div class = "tsd-theme-toggle" > < label class = "settings-label" for = "tsd-theme" > Theme< / label > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div > < details open class = "tsd-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / summary > < div > < a href = "#async" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > async< / span > < / a > < a href = "#backend" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > backend< / span > < / a > < a href = "#body" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > body< / span > < / a > < a href = "#cachemodels" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > cache< wbr / > Models< / span > < / a > < a href = "#cachesensitivity" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > cache< wbr / > Sensitivity< / span > < / a > < a href = "#deallocate" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > deallocate< / span > < / a > < a href = "#debug" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > debug< / span > < / a > < a href = "#face" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > face< / span > < / a > < a href = "#filter" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > filter< / span > < / a > < a href = "#flags" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > flags< / span > < / a > < a href = "#gesture" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > gesture< / span > < / a > < a href = "#hand" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > hand< / span > < / a > < a href = "#modelbasepath" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > model< wbr / > Base< wbr / > Path< / span > < / a > < a href = "#object" class = "" > < svg class = "tsd-
