2024-01-17 22:56:53 +01:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > TrainingConfig | @vladmandic/face-api - v1.7.13< / 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/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" < / 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 = "#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.13< / 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 = "#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.TrainingConfig.html" > TrainingConfig< / a > < / li > < / ul > < h1 > Interface TrainingConfig< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Model training configuration.< / p >
2024-02-07 17:20:36 +01:00
< / 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" > TrainingConfig< / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.TrainingConfig.html#loss" > loss< / a > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / 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-symbol" > { < / span > < br / > < span > < / span > [< span class = "tsd-kind-index-signature" > key< / span > : < span class = "tsd-signature-type" > string< / span > ]< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / 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.TrainingConfig.html#loss_weights" > loss_weights< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > [< span class = "tsd-kind-index-signature" > key< / span > : < span class = "tsd-signature-type" > string< / span > ]< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / 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.TrainingConfig.html#metrics" > metrics< / a > < 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-symbol" > { < / span > < br / > < span > < / span > [< span class = "tsd-kind-index-signature" > key< / span > : < span class = "tsd-signature-type" > string< / span > ]< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / 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.TrainingConfig.html#optimizer_config" > optimizer_config< / a > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > {}< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.TrainingConfig.html#sample_weight_mode" > sample_weight_mode< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "tf.io.TrainingConfig.html#weighted_metrics" > weighted_metrics< / a > < 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 > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:165< / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-index-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < h5 class = "tsd-index-heading uppercase" role = "button" aria-expanded = "false" tabIndex = "0" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "#icon-chevronSmall" > < / use > < / svg > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "tf.io.TrainingConfig.html#loss" class = "tsd-index-link
2024-01-17 22:56:53 +01:00
< a href = "tf.io.TrainingConfig.html#loss_weights" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > loss_< wbr / > weights?< / span > < / a >
< a href = "tf.io.TrainingConfig.html#metrics" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > metrics?< / span > < / a >
< a href = "tf.io.TrainingConfig.html#optimizer_config" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > optimizer_< wbr / > config< / span > < / a >
< a href = "tf.io.TrainingConfig.html#sample_weight_mode" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > sample_< wbr / > weight_< wbr / > mode?< / span > < / a >
< a href = "tf.io.TrainingConfig.html#weighted_metrics" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > weighted_< wbr / > metrics?< / span > < / a >
< / div > < / section > < / div > < / details > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member" > < a id = "loss" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > loss< / span > < a href = "#loss" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > loss< / 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" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > [< span class = "tsd-kind-index-signature" > key< / span > : < span class = "tsd-signature-type" > string< / span > ]< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Loss function(s) for the model' s output(s).< / p >
2024-02-07 17:20:36 +01:00
< / div > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < li class = "tsd-parameter-index-signature" > < h5 > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-kind-parameter" > key< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < / ul > < / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:169< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "loss_weights" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span > loss_< wbr / > weights< / span > < a href = "#loss_weights" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > loss_< wbr / > weights< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > [< span class = "tsd-kind-index-signature" > key< / span > : < span class = "tsd-signature-type" > string< / span > ]< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < li class = "tsd-parameter-index-signature" > < h5 > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-kind-parameter" > key< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]: < / span > < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < / ul > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:178< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "metrics" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span > metrics< / span > < a href = "#metrics" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > metrics< / 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-symbol" > { < / span > < br / > < span > < / span > [< span class = "tsd-kind-index-signature" > key< / span > : < span class = "tsd-signature-type" > string< / span > ]< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Metric function(s) for the model' s output(s).< / p >
< / div > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < li class = "tsd-parameter-index-signature" > < h5 > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-kind-parameter" > key< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < / ul > < / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:173< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "optimizer_config" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > optimizer_< wbr / > config< / span > < a href = "#optimizer_config" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > optimizer_< wbr / > config< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > {}< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Optimizer used for the model training.< / p >
< / div > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < / ul > < / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:167< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "sample_weight_mode" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span > sample_< wbr / > weight_< wbr / > mode< / span > < a href = "#sample_weight_mode" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > sample_< wbr / > weight_< wbr / > mode< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:177< / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "weighted_metrics" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span > weighted_< wbr / > metrics< / span > < a href = "#weighted_metrics" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > weighted_< wbr / > metrics< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/io/types.d.ts:176< / li > < / ul > < / aside > < / section > < / section > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-index-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < h4 class = "uppercase" > Member Visibility< / h4 > < form > < 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 > < / form > < / div > < div class = "tsd-theme-toggle" > < h4 class = "uppercase" > Theme< / h4 > < 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-index-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < ul > < li > < a href = "#loss" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > loss< / span > < / a > < / li > < li > < a href = "#loss_weights" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > loss_< wbr / > weights< / span > < / a > < / li > < li > < a href = "#metrics" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > metrics< / span > < / a > < / li > < li > < a href = "#optimizer_config" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > optimizer_< wbr / > config< / span > < / a > < / li > < li > < a href = "#sample_weight_mode" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > sample_< wbr / > weight_< wbr / > mode< / span > < / a > < / li > < li > < a href = "#weighted_metrics" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > weighted_< wbr / > metrics< / span > < / a > < / li >
