hcf.FlatEmbeddingBatch

hcf.FlatEmbeddingBatch

Classes

Name Description
FlatEmbeddingBatch FlatEmbeddingBatch.
FlatEmbeddingBatchT FlatEmbeddingBatchT.

FlatEmbeddingBatch

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch()

FlatEmbeddingBatch.

Methods

Name Description
FlatTensor FlatTensor.
FlatTensorAsNumpy FlatTensorAsNumpy.
FlatTensorIsNone FlatTensorIsNone.
FlatTensorLength FlatTensorLength.
GetRootAs GetRootAs.
GetRootAsFlatEmbeddingBatch This method is deprecated. Please switch to GetRootAs.
Id Id.
Init Init.
ProductIdx ProductIdx.
ProductIdxAsNumpy ProductIdxAsNumpy.
ProductIdxIsNone ProductIdxIsNone.
ProductIdxLength ProductIdxLength.
Shape Shape.
ShapeAsNumpy ShapeAsNumpy.
ShapeIsNone ShapeIsNone.
ShapeLength ShapeLength.
VibeMode VibeMode.
FlatTensor

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.FlatTensor(j)

FlatTensor.

Parameters
Name Type Description Default
j int j required
FlatTensorAsNumpy

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.FlatTensorAsNumpy()

FlatTensorAsNumpy.

FlatTensorIsNone

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.FlatTensorIsNone()

FlatTensorIsNone.

Parameters
Name Type Description Default
Returns required
bool required
FlatTensorLength

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.FlatTensorLength()

FlatTensorLength.

Parameters
Name Type Description Default
Returns required
int required
GetRootAs

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.GetRootAs(buf, offset=0)

GetRootAs.

Parameters
Name Type Description Default
buf buf required
offset int offset 0
GetRootAsFlatEmbeddingBatch

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.GetRootAsFlatEmbeddingBatch(buf, offset=0)

This method is deprecated. Please switch to GetRootAs.

Id

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.Id()

Id.

Parameters
Name Type Description Default
Returns required
Optional required
Init

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.Init(buf, pos)

Init.

Parameters
Name Type Description Default
buf bytes buf required
pos int pos required
ProductIdx

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ProductIdx(j)

ProductIdx.

Parameters
Name Type Description Default
j int j required
ProductIdxAsNumpy

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ProductIdxAsNumpy()

ProductIdxAsNumpy.

ProductIdxIsNone

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ProductIdxIsNone()

ProductIdxIsNone.

Parameters
Name Type Description Default
Returns required
bool required
ProductIdxLength

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ProductIdxLength()

ProductIdxLength.

Parameters
Name Type Description Default
Returns required
int required
Shape

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.Shape(j)

Shape.

Parameters
Name Type Description Default
j int j required
ShapeAsNumpy

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ShapeAsNumpy()

ShapeAsNumpy.

ShapeIsNone

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ShapeIsNone()

ShapeIsNone.

Parameters
Name Type Description Default
Returns required
bool required
ShapeLength

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.ShapeLength()

ShapeLength.

Parameters
Name Type Description Default
Returns required
int required
VibeMode

hcf.FlatEmbeddingBatch.FlatEmbeddingBatch.VibeMode()

VibeMode.

FlatEmbeddingBatchT

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchT(self)

FlatEmbeddingBatchT.

Methods

Name Description
InitFromBuf InitFromBuf.
InitFromObj InitFromObj.
InitFromPackedBuf InitFromPackedBuf.
Pack Pack.
InitFromBuf

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchT.InitFromBuf(buf, pos)

InitFromBuf.

Parameters
Name Type Description Default
buf buf required
pos pos required
InitFromObj

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchT.InitFromObj(flatEmbeddingBatch)

InitFromObj.

Parameters
Name Type Description Default
flatEmbeddingBatch flatEmbeddingBatch required
InitFromPackedBuf

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchT.InitFromPackedBuf(buf, pos=0)

InitFromPackedBuf.

Parameters
Name Type Description Default
buf buf required
pos pos 0
Pack

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchT.Pack(builder)

Pack.

Parameters
Name Type Description Default
builder builder required

Functions

Name Description
AddFlatTensor AddFlatTensor.
AddId AddId.
AddProductIdx AddProductIdx.
AddShape AddShape.
AddVibeMode AddVibeMode.
End End.
FlatEmbeddingBatchAddFlatTensor FlatEmbeddingBatchAddFlatTensor.
FlatEmbeddingBatchAddId FlatEmbeddingBatchAddId.
FlatEmbeddingBatchAddProductIdx FlatEmbeddingBatchAddProductIdx.
FlatEmbeddingBatchAddShape FlatEmbeddingBatchAddShape.
FlatEmbeddingBatchAddVibeMode FlatEmbeddingBatchAddVibeMode.
FlatEmbeddingBatchEnd FlatEmbeddingBatchEnd.
FlatEmbeddingBatchStart FlatEmbeddingBatchStart.
FlatEmbeddingBatchStartFlatTensorVector FlatEmbeddingBatchStartFlatTensorVector.
FlatEmbeddingBatchStartProductIdxVector FlatEmbeddingBatchStartProductIdxVector.
FlatEmbeddingBatchStartShapeVector FlatEmbeddingBatchStartShapeVector.
Start Start.
StartFlatTensorVector StartFlatTensorVector.
StartProductIdxVector StartProductIdxVector.
StartShapeVector StartShapeVector.

AddFlatTensor

hcf.FlatEmbeddingBatch.AddFlatTensor(builder, flatTensor)

AddFlatTensor.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
flatTensor int flatTensor required

AddId

hcf.FlatEmbeddingBatch.AddId(builder, id)

AddId.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
id int id required

AddProductIdx

hcf.FlatEmbeddingBatch.AddProductIdx(builder, productIdx)

AddProductIdx.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
productIdx int productIdx required

AddShape

hcf.FlatEmbeddingBatch.AddShape(builder, shape)

AddShape.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
shape int shape required

AddVibeMode

hcf.FlatEmbeddingBatch.AddVibeMode(builder, vibeMode)

AddVibeMode.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
vibeMode int vibeMode required

End

hcf.FlatEmbeddingBatch.End(builder)

End.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

Returns

Type Description
int

FlatEmbeddingBatchAddFlatTensor

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchAddFlatTensor(builder, flatTensor)

FlatEmbeddingBatchAddFlatTensor.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
flatTensor int flatTensor required

FlatEmbeddingBatchAddId

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchAddId(builder, id)

FlatEmbeddingBatchAddId.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
id int id required

FlatEmbeddingBatchAddProductIdx

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchAddProductIdx(builder, productIdx)

FlatEmbeddingBatchAddProductIdx.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
productIdx int productIdx required

FlatEmbeddingBatchAddShape

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchAddShape(builder, shape)

FlatEmbeddingBatchAddShape.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
shape int shape required

FlatEmbeddingBatchAddVibeMode

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchAddVibeMode(builder, vibeMode)

FlatEmbeddingBatchAddVibeMode.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required
vibeMode int vibeMode required

FlatEmbeddingBatchEnd

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchEnd(builder)

FlatEmbeddingBatchEnd.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

Returns

Type Description
int

FlatEmbeddingBatchStart

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchStart(builder)

FlatEmbeddingBatchStart.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

FlatEmbeddingBatchStartFlatTensorVector

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchStartFlatTensorVector(builder, numElems)

FlatEmbeddingBatchStartFlatTensorVector.

Parameters

Name Type Description Default
builder builder required
numElems int numElems required

Returns

Type Description
int

FlatEmbeddingBatchStartProductIdxVector

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchStartProductIdxVector(builder, numElems)

FlatEmbeddingBatchStartProductIdxVector.

Parameters

Name Type Description Default
builder builder required
numElems int numElems required

Returns

Type Description
int

FlatEmbeddingBatchStartShapeVector

hcf.FlatEmbeddingBatch.FlatEmbeddingBatchStartShapeVector(builder, numElems)

FlatEmbeddingBatchStartShapeVector.

Parameters

Name Type Description Default
builder builder required
numElems int numElems required

Returns

Type Description
int

Start

hcf.FlatEmbeddingBatch.Start(builder)

Start.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

StartFlatTensorVector

hcf.FlatEmbeddingBatch.StartFlatTensorVector(builder, numElems)

StartFlatTensorVector.

Parameters

Name Type Description Default
builder builder required
numElems int numElems required

Returns

Type Description
int

StartProductIdxVector

hcf.FlatEmbeddingBatch.StartProductIdxVector(builder, numElems)

StartProductIdxVector.

Parameters

Name Type Description Default
builder builder required
numElems int numElems required

Returns

Type Description
int

StartShapeVector

hcf.FlatEmbeddingBatch.StartShapeVector(builder, numElems)

StartShapeVector.

Parameters

Name Type Description Default
builder builder required
numElems int numElems required

Returns

Type Description
int