skainet-io-safetensors/sk.ainet.io.safetensors

Package-level declarations

Types

SafeTensorsDataTypeMapper

object SafeTensorsDataTypeMapper

Maps between SafeTensors dtype strings and unified DataType enum.

SafeTensorsDataTypes

object SafeTensorsDataTypes

SafeTensors data types as strings (as they appear in JSON).

SafeTensorsIndex

data class SafeTensorsIndex(val metadata: SafeTensorsIndexMetadata, val weightMap: Map<String, String>)

Represents a parsed model.safetensors.index.json file for sharded SafeTensors models.

SafeTensorsIndexMetadata

data class SafeTensorsIndexMetadata(val totalSize: Long?, val additionalFields: Map<String, String> = emptyMap())

Represents the metadata from a SafeTensors index file.

SafeTensorsIndexParseException

class SafeTensorsIndexParseException(message: String, cause: Throwable? = null) : Exception

Exception thrown when parsing a SafeTensors index file fails.

SafeTensorsIndexParser

object SafeTensorsIndexParser

Parser for model.safetensors.index.json files.

SafeTensorsParametersLoader

class SafeTensorsParametersLoader(sourceProvider: () -> RandomAccessSource, onProgress: (current: Long, total: Long, message: String?) -> Unit = { _, _, _ -> }) : ParametersLoader

ParametersLoader implementation for SafeTensors format using streaming.

SafeTensorsShardException

sealed class SafeTensorsShardException : Exception

Exceptions specific to sharded SafeTensors operations.

SafeTensorsWriter

class SafeTensorsWriter

Writer for creating SafeTensors format files.

ShardedTensorInfo

data class ShardedTensorInfo(base: StreamingSafeTensorInfo, val shardFilename: String, val shardIndex: Int, val totalShards: Int)

Tensor info with shard location information.

StreamingSafeTensorInfo

data class StreamingSafeTensorInfo(val name: String, val dtype: String, val dataType: DataType, val shape: List<Long>, val elementCount: Long, val dataOffsetStart: Long, val dataOffsetEnd: Long, val sizeInBytes: Int, val absoluteDataOffset: Long)

Tensor metadata for streaming access.

StreamingSafeTensorsReader

class StreamingSafeTensorsReader : AutoCloseable

Streaming SafeTensors reader that parses metadata without loading tensor data.

StreamingShardedSafeTensorsReader

class StreamingShardedSafeTensorsReader : ProgressReportingLoader, AutoCloseable

Streaming reader for sharded/multi-file SafeTensors models.

Properties

HEADER_SIZE_BYTES

const val HEADER_SIZE_BYTES: Int = 8

Size of the header length field in bytes

MAX_HEADER_SIZE

const val MAX_HEADER_SIZE: Int

Maximum allowed header size (100 MB) - safety limit

METADATA_KEY

const val METADATA_KEY: String

Key for custom metadata in the JSON header

Functions

createRandomAccessSource

actual fun createRandomAccessSource(filePath: String): RandomAccessSource?

Android implementation of createRandomAccessSource.

expect fun createRandomAccessSource(filePath: String): RandomAccessSource?

Platform-specific factory for creating RandomAccessSource instances.

actual fun createRandomAccessSource(filePath: String): RandomAccessSource?

JS implementation of createRandomAccessSource.

actual fun createRandomAccessSource(filePath: String): RandomAccessSource?

JVM implementation of createRandomAccessSource.

actual fun createRandomAccessSource(filePath: String): RandomAccessSource?

Native implementation of createRandomAccessSource.

actual fun createRandomAccessSource(filePath: String): RandomAccessSource?

WASM/JS implementation of createRandomAccessSource.

actual fun createRandomAccessSource(filePath: String): RandomAccessSource?

WASM/WASI implementation of createRandomAccessSource.

readTextFile

actual fun readTextFile(path: String): String?

Android implementation: Read a text file.

expect fun readTextFile(path: String): String?

Read a text file. Platform-specific implementation.

actual fun readTextFile(path: String): String?

JS implementation: Read a text file. Note: Browser JS cannot read local files directly. For sharded models, the index should be fetched via HTTP.

actual fun readTextFile(path: String): String?

JVM implementation: Read a text file.

actual fun readTextFile(path: String): String?

Native implementation: Read a text file. Note: Full implementation requires platform-specific file I/O. For sharded models, the index file reading should be done through the existing RandomAccessSource mechanism.

actual fun readTextFile(path: String): String?

WASM JS implementation: Read a text file. Note: WASM/Browser cannot read local files directly.

actual fun readTextFile(path: String): String?

WASM WASI implementation: Read a text file. Note: WASM/WASI cannot read local files directly via this API.