Class FaceFeatureExtractor

Hierarchy

NeuralNetwork<FaceFeatureExtractorParams>
- FaceFeatureExtractor

Implements

IFaceFeatureExtractor<FaceFeatureExtractorParams>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FaceFeatureExtractor(): FaceFeatureExtractor

Overrides NeuralNetwork.__constructor
- Defined in face-api.js/src/faceFeatureExtractor/FaceFeatureExtractor.ts:9
Returns FaceFeatureExtractor

Properties

Protected _name

_name: string

Protected _paramMappings

_paramMappings: ParamMapping[]

Protected _params

_params: FaceFeatureExtractorParams | undefined

isLoaded

isLoaded: boolean

paramMappings

paramMappings: ParamMapping[]

params

params: FaceFeatureExtractorParams | undefined

Methods

dispose

dispose(throwOnRedispose?: undefined | false | true): void

Implementation of IFaceFeatureExtractor.dispose

Inherited from NeuralNetwork.dispose
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:27
Parameters
- Optional throwOnRedispose: undefined | false | true
Returns void

Protected extractParams

extractParams(weights: Float32Array): object

Implementation of IFaceFeatureExtractor.extractParams

Overrides NeuralNetwork.extractParams
- Defined in face-api.js/src/faceFeatureExtractor/FaceFeatureExtractor.ts:50
Parameters
- weights: Float32Array
Returns object

Protected extractParamsFromWeigthMap

extractParamsFromWeigthMap(weightMap: tf.NamedTensorMap): object

Implementation of IFaceFeatureExtractor.extractParamsFromWeigthMap

Overrides NeuralNetwork.extractParamsFromWeigthMap
- Defined in face-api.js/src/faceFeatureExtractor/FaceFeatureExtractor.ts:46
Parameters
- weightMap: tf.NamedTensorMap
Returns object

extractWeights

extractWeights(weights: Float32Array): void

Implementation of IFaceFeatureExtractor.extractWeights

Inherited from NeuralNetwork.extractWeights
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:33
Parameters
- weights: Float32Array
Returns void

forward

forward(input: TNetInput): Promise<tf.Tensor4D>

Implementation of IFaceFeatureExtractor.forward
- Defined in face-api.js/src/faceFeatureExtractor/FaceFeatureExtractor.ts:38
Parameters
- input: TNetInput
Returns Promise<tf.Tensor4D>

forwardInput

forwardInput(input: NetInput): tf.Tensor4D

Implementation of IFaceFeatureExtractor.forwardInput
- Defined in face-api.js/src/faceFeatureExtractor/FaceFeatureExtractor.ts:15
Parameters
- input: NetInput
Returns tf.Tensor4D

freeze

freeze(): void

Implementation of IFaceFeatureExtractor.freeze

Inherited from NeuralNetwork.freeze
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:26
Returns void

Protected getDefaultModelName

getDefaultModelName(): string

Implementation of IFaceFeatureExtractor.getDefaultModelName

Overrides NeuralNetwork.getDefaultModelName
- Defined in face-api.js/src/faceFeatureExtractor/FaceFeatureExtractor.ts:42
Returns string

getFrozenParams

getFrozenParams(): object[]

Implementation of IFaceFeatureExtractor.getFrozenParams

Inherited from NeuralNetwork.getFrozenParams
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:21
Returns object[]

getParamFromPath

getParamFromPath(paramPath: string): tf.Tensor

Implementation of IFaceFeatureExtractor.getParamFromPath

Inherited from NeuralNetwork.getParamFromPath
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:11
Parameters
- paramPath: string
Returns tf.Tensor

getParamList

getParamList(): object[]

Implementation of IFaceFeatureExtractor.getParamList

Inherited from NeuralNetwork.getParamList
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:13
Returns object[]

getTrainableParams

getTrainableParams(): object[]

Implementation of IFaceFeatureExtractor.getTrainableParams

Inherited from NeuralNetwork.getTrainableParams
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:17
Returns object[]

load

load(weightsOrUrl: Float32Array | string | undefined): Promise<void>

Implementation of IFaceFeatureExtractor.load

Inherited from NeuralNetwork.load
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:29
Parameters
- weightsOrUrl: Float32Array | string | undefined
Returns Promise<void>

loadFromDisk

loadFromDisk(filePath: string | undefined): Promise<void>

Implementation of IFaceFeatureExtractor.loadFromDisk

Inherited from NeuralNetwork.loadFromDisk
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:31
Parameters
- filePath: string | undefined
Returns Promise<void>

loadFromUri

loadFromUri(uri: string | undefined): Promise<void>

Implementation of IFaceFeatureExtractor.loadFromUri

Inherited from NeuralNetwork.loadFromUri
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:30
Parameters
- uri: string | undefined
Returns Promise<void>

loadFromWeightMap

loadFromWeightMap(weightMap: tf.NamedTensorMap): void

Implementation of IFaceFeatureExtractor.loadFromWeightMap

Inherited from NeuralNetwork.loadFromWeightMap
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:32
Parameters
- weightMap: tf.NamedTensorMap
Returns void

reassignParamFromPath

reassignParamFromPath(paramPath: string, tensor: tf.Tensor): void

Implementation of IFaceFeatureExtractor.reassignParamFromPath

Inherited from NeuralNetwork.reassignParamFromPath
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:12
Parameters
- paramPath: string
- tensor: tf.Tensor
Returns void

serializeParams

serializeParams(): Float32Array

Implementation of IFaceFeatureExtractor.serializeParams

Inherited from NeuralNetwork.serializeParams
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:28
Returns Float32Array

variable

variable(): void

Implementation of IFaceFeatureExtractor.variable

Inherited from NeuralNetwork.variable
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:25
Returns void

Generated using TypeDoc