hcf.Catalog

hcf.Catalog

Classes

Name Description
Catalog Catalog.
CatalogT CatalogT.

Catalog

hcf.Catalog.Catalog()

Catalog.

Methods

Name Description
BatchSize BatchSize.
Description Description.
GetRootAs GetRootAs.
GetRootAsCatalog This method is deprecated. Please switch to GetRootAs.
Id Id.
Init Init.
ModelNameOrPath ModelNameOrPath.
ProductVibes ProductVibes.
TokenizerNameOrPath TokenizerNameOrPath.
Version Version.
BatchSize

hcf.Catalog.Catalog.BatchSize()

BatchSize.

Description

hcf.Catalog.Catalog.Description()

Description.

Parameters
Name Type Description Default
Returns required
Optional required
GetRootAs

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

GetRootAs.

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

hcf.Catalog.Catalog.GetRootAsCatalog(buf, offset=0)

This method is deprecated. Please switch to GetRootAs.

Id

hcf.Catalog.Catalog.Id()

Id.

Parameters
Name Type Description Default
Returns required
Optional required
Init

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

Init.

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

hcf.Catalog.Catalog.ModelNameOrPath()

ModelNameOrPath.

Parameters
Name Type Description Default
Returns required
Optional required
ProductVibes

hcf.Catalog.Catalog.ProductVibes()

ProductVibes.

Parameters
Name Type Description Default
Returns required
Optional required
TokenizerNameOrPath

hcf.Catalog.Catalog.TokenizerNameOrPath()

TokenizerNameOrPath.

Parameters
Name Type Description Default
Returns required
Optional required
Version

hcf.Catalog.Catalog.Version()

Version.

Parameters
Name Type Description Default
Returns required
Optional required

CatalogT

hcf.Catalog.CatalogT(self)

CatalogT.

Methods

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

hcf.Catalog.CatalogT.InitFromBuf(buf, pos)

InitFromBuf.

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

hcf.Catalog.CatalogT.InitFromObj(catalog)

InitFromObj.

Parameters
Name Type Description Default
catalog catalog required
InitFromPackedBuf

hcf.Catalog.CatalogT.InitFromPackedBuf(buf, pos=0)

InitFromPackedBuf.

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

hcf.Catalog.CatalogT.Pack(builder)

Pack.

Parameters
Name Type Description Default
builder builder required

Functions

Name Description
AddBatchSize AddBatchSize.
AddDescription AddDescription.
AddId AddId.
AddModelNameOrPath AddModelNameOrPath.
AddProductVibes AddProductVibes.
AddTokenizerNameOrPath AddTokenizerNameOrPath.
AddVersion AddVersion.
CatalogAddBatchSize CatalogAddBatchSize.
CatalogAddDescription CatalogAddDescription.
CatalogAddId CatalogAddId.
CatalogAddModelNameOrPath CatalogAddModelNameOrPath.
CatalogAddProductVibes CatalogAddProductVibes.
CatalogAddTokenizerNameOrPath CatalogAddTokenizerNameOrPath.
CatalogAddVersion CatalogAddVersion.
CatalogEnd CatalogEnd.
CatalogStart CatalogStart.
End End.
Start Start.

AddBatchSize

hcf.Catalog.AddBatchSize(builder, batchSize)

AddBatchSize.

Parameters

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

AddDescription

hcf.Catalog.AddDescription(builder, description)

AddDescription.

Parameters

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

AddId

hcf.Catalog.AddId(builder, id)

AddId.

Parameters

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

AddModelNameOrPath

hcf.Catalog.AddModelNameOrPath(builder, modelNameOrPath)

AddModelNameOrPath.

Parameters

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

AddProductVibes

hcf.Catalog.AddProductVibes(builder, productVibes)

AddProductVibes.

Parameters

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

AddTokenizerNameOrPath

hcf.Catalog.AddTokenizerNameOrPath(builder, tokenizerNameOrPath)

AddTokenizerNameOrPath.

Parameters

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

AddVersion

hcf.Catalog.AddVersion(builder, version)

AddVersion.

Parameters

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

CatalogAddBatchSize

hcf.Catalog.CatalogAddBatchSize(builder, batchSize)

CatalogAddBatchSize.

Parameters

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

CatalogAddDescription

hcf.Catalog.CatalogAddDescription(builder, description)

CatalogAddDescription.

Parameters

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

CatalogAddId

hcf.Catalog.CatalogAddId(builder, id)

CatalogAddId.

Parameters

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

CatalogAddModelNameOrPath

hcf.Catalog.CatalogAddModelNameOrPath(builder, modelNameOrPath)

CatalogAddModelNameOrPath.

Parameters

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

CatalogAddProductVibes

hcf.Catalog.CatalogAddProductVibes(builder, productVibes)

CatalogAddProductVibes.

Parameters

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

CatalogAddTokenizerNameOrPath

hcf.Catalog.CatalogAddTokenizerNameOrPath(builder, tokenizerNameOrPath)

CatalogAddTokenizerNameOrPath.

Parameters

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

CatalogAddVersion

hcf.Catalog.CatalogAddVersion(builder, version)

CatalogAddVersion.

Parameters

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

CatalogEnd

hcf.Catalog.CatalogEnd(builder)

CatalogEnd.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

Returns

Type Description
int

CatalogStart

hcf.Catalog.CatalogStart(builder)

CatalogStart.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

End

hcf.Catalog.End(builder)

End.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required

Returns

Type Description
int

Start

hcf.Catalog.Start(builder)

Start.

Parameters

Name Type Description Default
builder flatbuffers.Builder builder required