2024-09-10 17:30:23 +02:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > LoadOptions | @vladmandic/face-api - v1.7.14< / title > < meta name = "description" content = "Documentation for @vladmandic/face-api" / > < 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 > < / 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" data-base = ".." > < 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/face-api - v1.7.14< / 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/face-api< / a > < / li > < li > < a href = "../modules/tf.html" > tf< / a > < / li > < li > < a href = "../modules/tf.io.html" > io< / a > < / li > < li > < a href = "tf.io.LoadOptions.html" > LoadOptions< / a > < / li > < / ul > < h1 > Interface LoadOptions< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < h4 class = "tsd-anchor-link" > < a id = "Innamespace" class = "tsd-anchor" > < / a > Innamespace< a href = "#Innamespace" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h4 > < p > io< / p >
< / div > < / section > < div class = "tsd-signature" > < span class = "tsd-signature-keyword" > interface < / span > < span class = "tsd-kind-interface" > LoadOptions< / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.LoadOptions.html#fetchFunc" > fetchFunc< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > RequestInfo< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > RequestInfo< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / 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" > Request< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.LoadOptions.html#fromTFHub" > fromTFHub< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.LoadOptions.html#onProgress" > onProgress< / a > < span class = "tsd-signature-symbol" > ?: < / span > < a href = "../types/tf.io.OnProgressCallback.html" class = "tsd-signature-type tsd-kind-type-alias" > OnProgressCallback< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.LoadOptions.html#requestInit" > requestInit< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.LoadOptions.html#streamWeights" > streamWeights< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.LoadOptions.html#strict" > strict< / a > < span class = "tsd-signature-symbol" > ?: < /span
< a href = "tf.io.LoadOptions.html#fromTFHub" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > fromTFHub?< / span > < / a >
< a href = "tf.io.LoadOptions.html#onProgress" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > on< wbr / > Progress?< / span > < / a >
< a href = "tf.io.LoadOptions.html#requestInit" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > request< wbr / > Init?< / span > < / a >
< a href = "tf.io.LoadOptions.html#streamWeights" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > stream< wbr / > Weights?< / span > < / a >
< a href = "tf.io.LoadOptions.html#strict" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > strict?< / span > < / a >
< a href = "tf.io.LoadOptions.html#weightPathPrefix" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > weight< wbr / > Path< wbr / > Prefix?< / span > < / a >
< a href = "tf.io.LoadOptions.html#weightUrlConverter" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > weight< wbr / > Url< wbr / > Converter?< / span > < / a >
< / 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 = "fetchFunc" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > fetch< wbr / > Func< / span > < a href = "#fetchFunc" 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" > fetch< wbr / > Func< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > RequestInfo< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > RequestInfo< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / 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" > Request< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > RequestInit< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > A function used to override the < code > window.fetch< / code > function.< / p >
< / div > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < li class = "tsd-parameter-signature" > < ul class = "tsd-signatures" > < li class = "tsd-signature" id = "fetchFunc.__type.__type-1" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > < a href = "https://developer.mozilla.org/docs/Web/API/fetch" target = "_blank" class = "external" > MDN Reference< / a > < / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > input< / span > : < span class = "tsd-signature-type" > RequestInfo< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > < / span > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > init< / span > : < span class = "tsd-signature-type" > RequestInit< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li class = "tsd-signature" id = "fetchFunc.__type.__type-2" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > < a href = "https://developer.mozilla.org/docs/Web/API/fetch" target = "_blank" class = "external" > MDN Reference< / a > < / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > input< / span > : < span class = "tsd-signature-type" > RequestInfo< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > < / span > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > init< / span > : < span class = "tsd-signature-type" > RequestInit< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li class = "tsd-signature" id = "fetchFunc.__type.__type-3" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > init< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < li class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > input< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Request< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > URL< / span > < / span > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > init< / span > : < span class = "tsd-signature-type" > RequestInit< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < / ul > < / li > < / ul > < / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:425< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "fromTFHub" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > fromTFHub< / span > < a href = "#fromTFHub" 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" > fromTFHub< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Whether the module or model is to be loaded from TF Hub.< / p >
2024-01-17 22:56:53 +01:00
< p > Setting this to < code > true< / code > allows passing a TF-Hub module URL, omitting the
standard model file name and the query parameters.< / p >
< p > Default: < code > false< / code > .< / p >
2024-09-10 17:30:23 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:459< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "onProgress" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > on< wbr / > Progress< / span > < a href = "#onProgress" 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" > on< wbr / > Progress< / span > < span class = "tsd-signature-symbol" > ?:< / span > < a href = "../types/tf.io.OnProgressCallback.html" class = "tsd-signature-type tsd-kind-type-alias" > OnProgressCallback< / a > < / div > < div class = "tsd-comment tsd-typography" > < p > Progress callback.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:421< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "requestInit" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > request< wbr / > Init< / span > < a href = "#requestInit" 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" > request< wbr / > Init< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > RequestInit< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > RequestInit (options) for HTTP requests.< / p >
2024-01-17 22:56:53 +01:00
< p > For detailed information on the supported fields, see
2024-09-10 17:30:23 +02:00
< a href = "https://developer.mozilla.org/en-US/docs/Web/API/Request/Request" target = "_blank" class = "external" > https://developer.mozilla.org/en-US/docs/Web/API/Request/Request< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:417< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "streamWeights" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > stream< wbr / > Weights< / span > < a href = "#streamWeights" 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" > stream< wbr / > Weights< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Whether to stream the model directly to the backend or cache all its
2024-01-17 22:56:53 +01:00
weights on CPU first. Useful for large models.< / p >
2024-09-10 17:30:23 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:475< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "strict" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > strict< / span > < a href = "#strict" 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" > strict< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Strict loading model: whether extraneous weights or missing
2024-01-17 22:56:53 +01:00
weights should trigger an < code > Error< / code > .< / p >
< p > If < code > true< / code > , require that the provided weights exactly match those
required by the layers. < code > false< / code > means that both extra weights
and missing weights will be silently ignored.< / p >
< p > Default: < code > true< / code > .< / p >
2024-09-10 17:30:23 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:436< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "weightPathPrefix" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > weight< wbr / > Path< wbr / > Prefix< / span > < a href = "#weightPathPrefix" 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" > weight< wbr / > Path< wbr / > Prefix< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Path prefix for weight files, by default this is calculated from the
2024-01-17 22:56:53 +01:00
path of the model JSON file.< / p >
< p > For instance, if the path to the model JSON file is
< code > http://localhost/foo/model.json< / code > , then the default path prefix will be
< code > http://localhost/foo/< / code > . If a weight file has the path value
< code > group1-shard1of2< / code > in the weight manifest, then the weight file will be
loaded from < code > http://localhost/foo/group1-shard1of2< / code > by default. However,
if you provide a < code > weightPathPrefix< / code > value of
< code > http://localhost/foo/alt-weights< / code > , then the weight file will be loaded
from the path < code > http://localhost/foo/alt-weights/group1-shard1of2< / code > instead.< / p >
2024-09-10 17:30:23 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:450< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "weightUrlConverter" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Optional< / code > < span > weight< wbr / > Url< wbr / > Converter< / span > < a href = "#weightUrlConverter" 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" > weight< wbr / > Url< wbr / > Converter< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > weightFileName< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > )< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > An async function to convert weight file name to URL. The weight file
names are stored in model.json's weightsManifest.paths field. By default we
2024-01-17 22:56:53 +01:00
consider weight files are colocated with the model.json file. For example:
2024-09-10 17:30:23 +02:00
model.json URL: < a href = "https://www.google.com/models/1/model.json" target = "_blank" class = "external" > https://www.google.com/models/1/model.json< / a >
group1-shard1of1.bin url:
< a href = "https://www.google.com/models/1/group1-shard1of1.bin" target = "_blank" class = "external" > https://www.google.com/models/1/group1-shard1of1.bin< / a > < / p >
2024-01-17 22:56:53 +01:00
< p > With this func you can convert the weight file name to any URL.< / p >
2024-09-10 17:30:23 +02:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.21.0/node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:470< / 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 = "tsd-otp-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 = "#fetchFunc" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > fetch< wbr / > Func< / span > < / a > < a href = "#fromTFHub" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > fromTFHub< / span > < / a > < a href = "#onProgress" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > on< wbr / > Progress< / span > < / a > < a href = "#requestInit" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > request< wbr / > Init< / span > < / a > < a href = "#streamWeights" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > stream< wbr / > Weights< / span > < / a > < a href = "#strict" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > strict< / span > < / a > < a href = "#weightPathPrefix" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > weight< wbr / > Path< wbr / > Prefix< / span > < / a > < a href = "#weightUrlConverter" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > weight< wbr / > Url< wbr / > Converter< / span > < / a > < / div > < / details > < / div > < / details > < / div > < div class = "site-menu" > < nav class = "tsd-navigation" > < a href = "../index.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1" > < / use > < / svg > < span > @vladmandic/face-api - v1.7.14< / span > < / a > < ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" data-base = ".." > < li > Loading...< / li > < / ul > < / nav > < / div > < / div > < / div > < footer > < / footer > < div class = "overlay" > < / div > < / body > < / html >
