Package-level declarations

Every public type of the engine lives in this package.

  • Core: Tensor, noGrad, MatMul, Quantization, QuantizedTensor, Module

  • Layers: Linear, QuantizedLinear, Embedding, QuantizedEmbedding, TiedQuantizedEmbedding, RMSNorm, RoPE, SwiGLU, Attention, TransformerBlock, Transformer, KVCache, PromptPrefix, InferenceBuffers

  • Training: mseLoss, crossEntropyLoss, fusedCrossEntropyLoss, IGNORE_INDEX, SGD, AdamW, DataLoader, LoRALinear, LoRAAdapter, FineTuningPipeline

  • Text: Tokenizer, SimpleTokenizer, BPETokenizer, IncrementalDecoder, StreamingSession, Sampling, Sampler

  • I/O: SafeTensors, SafeTensorsFile, HuggingFaceModelLoader, HuggingFaceConfig, JsonParser

Types

Link copied to clipboard
class AdamW(val parameters: List<Tensor>, val learningRate: Float = 1.0E-4f, val beta1: Float = 0.9f, val beta2: Float = 0.999f, val epsilon: Float = 1.0E-8f, val weightDecay: Float = 0.01f)
Link copied to clipboard
class Attention(val dimension: Int, val numHeads: Int, val numKeyValueHeads: Int = numHeads, val ropeTheta: Float = 10000.0f, ropeScaling: RoPEScaling? = null, quantization: Quantization? = null) : Module
Link copied to clipboard
class BPETokenizer(vocab: Map<String, Int>, merges: List<Pair<String, String>>, specialTokens: Map<String, Int> = emptyMap(), addedTokens: Map<String, Int> = emptyMap(), val preTokenizerPattern: String = GPT2_PRE_TOKENIZER_PATTERN, val addPrefixSpace: Boolean = false, val normalization: String? = null, val ignoreMerges: Boolean = false, val unkToken: String? = null, prefixTokens: IntArray = IntArray(0), suffixTokens: IntArray = IntArray(0)) : Tokenizer
Link copied to clipboard
class DataLoader @JvmOverloads constructor(val tokens: IntArray, val batchSize: Int, val sequenceLength: Int, val labels: IntArray = tokens)
Link copied to clipboard
class Embedding(vocabularySize: Int, embeddingDim: Int) : TokenEmbedding
Link copied to clipboard
class FineTuningPipeline(val model: Transformer, val adapter: LoRAAdapter, val optimizer: AdamW)
Link copied to clipboard
data class GenerationState(val prompt: String = "", val generatedText: String = "", val isGenerating: Boolean = false, val tokensGenerated: Int = 0, val tokensPerSecond: Float = 0.0f)
Link copied to clipboard
class HuggingFaceConfig(val modelType: String, val hiddenSize: Int, val numHiddenLayers: Int, val numAttentionHeads: Int, val numKeyValueHeads: Int, val intermediateSize: Int, val rmsNormEps: Float, val ropeTheta: Float, val vocabSize: Int, val maxPositionEmbeddings: Int, val tieWordEmbeddings: Boolean, val ropeScaling: RoPEScaling? = null)
Link copied to clipboard
Link copied to clipboard
class ImportReport(val loaded: List<String>, val ignored: List<String>, val missing: List<String>, val tiedLmHead: Boolean)
Link copied to clipboard
class IncrementalDecoder(val tokenizer: Tokenizer)
Link copied to clipboard
class InferenceBuffers(val dimension: Int, val hiddenDimension: Int, val vocabularySize: Int, val maxSequenceLength: Int, val kvDimension: Int = dimension)
Link copied to clipboard
Link copied to clipboard
class KVCache(val numLayers: Int, val numHeads: Int, val maxSequenceLength: Int, val headDim: Int)
Link copied to clipboard
class Linear(inSize: Int, outSize: Int) : Projection
Link copied to clipboard
class LoRAAdapter(val model: Transformer, val rank: Int = 4, val alpha: Float = 1.0f, blockIndices: Iterable<Int>)
Link copied to clipboard
class LoRALinear(val baseLinear: Projection, val rank: Int = 4, val alpha: Float = 1.0f) : Module
Link copied to clipboard
object MatMul
Link copied to clipboard
abstract class Module
Link copied to clipboard
abstract class Projection(val inSize: Int, val outSize: Int) : Module
Link copied to clipboard
Link copied to clipboard
class Quantization(val bits: Int, val groupSize: Int = 64)
Link copied to clipboard
class QuantizedEmbedding(vocabularySize: Int, embeddingDim: Int, val quantization: Quantization) : TokenEmbedding
Link copied to clipboard
class QuantizedLinear(inSize: Int, outSize: Int, val quantization: Quantization) : Projection
Link copied to clipboard
Link copied to clipboard
class RMSNorm(val dimension: Int, val eps: Float = 1.0E-6f) : Module
Link copied to clipboard
class RoPE(val dimension: Int, val base: Float = 10000.0f, val scaling: RoPEScaling? = null) : Module
Link copied to clipboard
class RoPEScaling(val factor: Float, val lowFrequencyFactor: Float = 1.0f, val highFrequencyFactor: Float = 4.0f, val originalMaxPositionEmbeddings: Int = 8192)
Link copied to clipboard
Link copied to clipboard
class SafeTensorsEntry(val name: String, val dtype: String, val shape: IntArray, val bytes: ByteArray)
Link copied to clipboard
class SafeTensorsFile(val file: File) : Closeable
Link copied to clipboard
class Sampler
Link copied to clipboard
class Sampling @JvmOverloads constructor(val temperature: Float = 0.7f, val topK: Int = 40, val topP: Float = 0.9f, val repetitionPenalty: Float = 1.1f, val repetitionWindow: Int = 64, val seed: Long? = null)
Link copied to clipboard
class SGD(val parameters: List<Tensor>, val learningRate: Float = 0.01f)
Link copied to clipboard
class SimpleTokenizer(val textBody: String) : Tokenizer
Link copied to clipboard
class StreamingSession(val model: Transformer, val tokenizer: Tokenizer)
Link copied to clipboard
class SwiGLU(val dimension: Int, val hiddenDimension: Int, quantization: Quantization? = null) : Module
Link copied to clipboard
class Tensor(val data: FloatArray, val shape: IntArray, parents: List<Tensor> = emptyList(), backwardOp: () -> Unit = {})
Link copied to clipboard
Link copied to clipboard
abstract class TokenEmbedding(val vocabularySize: Int, val embeddingDim: Int) : Module
Link copied to clipboard
interface Tokenizer
Link copied to clipboard
class Transformer(val vocabularySize: Int, val dimension: Int, val numLayers: Int, val numHeads: Int, val hiddenDimension: Int = 4 * dimension, val numKeyValueHeads: Int = numHeads, val normEps: Float = 1.0E-6f, val ropeTheta: Float = 10000.0f, val ropeScaling: RoPEScaling? = null, quantization: Quantization? = null) : Module
Link copied to clipboard
class TransformerBlock(val dimension: Int, val numHeads: Int, val hiddenDimension: Int = 4 * dimension, val numKeyValueHeads: Int = numHeads, val normEps: Float = 1.0E-6f, val ropeTheta: Float = 10000.0f, ropeScaling: RoPEScaling? = null, quantization: Quantization? = null) : Module

Properties

Link copied to clipboard
const val IGNORE_INDEX: Int

Functions

Link copied to clipboard
fun crossEntropyLoss(logits: Tensor, targets: Tensor, ignoreIndex: Int = IGNORE_INDEX): Tensor
fun crossEntropyLoss(logits: Tensor, targets: IntArray, ignoreIndex: Int = IGNORE_INDEX): Tensor
Link copied to clipboard
fun fusedCrossEntropyLoss(hidden: Tensor, head: Projection, targets: Tensor, ignoreIndex: Int = IGNORE_INDEX): Tensor
fun fusedCrossEntropyLoss(hidden: Tensor, head: Projection, targets: IntArray, ignoreIndex: Int = IGNORE_INDEX): Tensor
Link copied to clipboard
fun mseLoss(prediction: Tensor, target: Tensor): Tensor
Link copied to clipboard
fun <T> noGrad(block: () -> T): T
Link copied to clipboard
fun projection(inSize: Int, outSize: Int, quantization: Quantization?): Projection