Class TrainerSpec

constructor

• new TrainerSpec(properties?: ITrainerSpec): sentencepiece.TrainerSpec

  Constructs a new TrainerSpec.

  Parameters

  • Optionalproperties: ITrainerSpec

    Properties to set

  Returns sentencepiece.TrainerSpec

acceptLanguage

allowWhitespaceOnlyPieces

bosId

bosPiece

byteFallback

characterCoverage

controlSymbols

differentialPrivacyClippingThreshold

differentialPrivacyNoiseLevel

enableDifferentialPrivacy

eosId

eosPiece

hardVocabLimit

input

inputFormat

inputSentenceSize

maxSentenceLength

maxSentencepieceLength

miningSentenceSize

modelPrefix

modelType

numSubIterations

numThreads

padId

padPiece

pretokenizationDelimiter

requiredChars

seedSentencepiecesFile

seedSentencepieceSize

selfTestSampleSize

shrinkingFactor

shuffleInputSentence

splitByNumber

splitByUnicodeScript

splitByWhitespace

splitDigits

trainExtremelyLargeCorpus

trainingSentenceSize

treatWhitespaceAsSuffix

unkId

unkPiece

unkSurface

useAllVocab

userDefinedSymbols

vocabSize

vocabularyOutputPieceScore

toJSON

• toJSON(): { [k: string]: any }

  Converts this TrainerSpec to JSON.

  Returns { [k: string]: any }

  JSON object

Staticcreate

• create(properties?: ITrainerSpec): sentencepiece.TrainerSpec

  Creates a new TrainerSpec instance using the specified properties.

  Parameters

  • Optionalproperties: ITrainerSpec

    Properties to set

  Returns sentencepiece.TrainerSpec

  TrainerSpec instance

Staticdecode

• decode(reader: Uint8Array | Reader, length?: number): sentencepiece.TrainerSpec

  Decodes a TrainerSpec message from the specified reader or buffer.

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from
  • Optionallength: number

    Message length if known beforehand

  Returns sentencepiece.TrainerSpec

  TrainerSpec

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

StaticdecodeDelimited

• decodeDelimited(reader: Uint8Array | Reader): sentencepiece.TrainerSpec

  Decodes a TrainerSpec message from the specified reader or buffer, length delimited.

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns sentencepiece.TrainerSpec

  TrainerSpec

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Staticencode

• encode(message: ITrainerSpec, writer?: Writer): Writer

  Encodes the specified TrainerSpec message. Does not implicitly verify messages.

  Parameters

  • message: ITrainerSpec

    TrainerSpec message or plain object to encode
  • Optionalwriter: Writer

    Writer to encode to

  Returns Writer

  Writer

StaticencodeDelimited

• encodeDelimited(message: ITrainerSpec, writer?: Writer): Writer

  Encodes the specified TrainerSpec message, length delimited. Does not implicitly verify messages.

  Parameters

  • message: ITrainerSpec

    TrainerSpec message or plain object to encode
  • Optionalwriter: Writer

    Writer to encode to

  Returns Writer

  Writer

StaticfromObject

• fromObject(object: { [k: string]: any }): sentencepiece.TrainerSpec

  Creates a TrainerSpec message from a plain object. Also converts values to their respective internal types.

  Parameters

  • object: { [k: string]: any }

    Plain object

  Returns sentencepiece.TrainerSpec

  TrainerSpec

StaticgetTypeUrl

• getTypeUrl(typeUrlPrefix?: string): string

  Gets the default type url for TrainerSpec

  Parameters

  • OptionaltypeUrlPrefix: string

    your custom typeUrlPrefix(default "type.googleapis.com")

  Returns string

  The default type url

StatictoObject

• toObject(
      message: sentencepiece.TrainerSpec,
      options?: IConversionOptions,
  ): { [k: string]: any }

  Creates a plain object from a TrainerSpec message. Also converts values to other types if specified.

  Parameters

  • message: sentencepiece.TrainerSpec

    TrainerSpec
  • Optionaloptions: IConversionOptions

    Conversion options

  Returns { [k: string]: any }

  Plain object

Staticverify

• verify(message: { [k: string]: any }): null | string

  Verifies a TrainerSpec message.

  Parameters

  • message: { [k: string]: any }

    Plain object to verify

  Returns null | string

  null if valid, otherwise the reason why it is not