Skip to content

Commit 85581dc

Browse files
michalharakalmichalharakal
committed
Rename package and class names to reflect its called SafeTensors
Related-To:#10
1 parent f99a5d2 commit 85581dc

13 files changed

Lines changed: 39 additions & 55 deletions

File tree

‎safetensors/build.gradle.kts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ kotlin {
4141
}
4242
}
4343

44-
jvm("desktop")
44+
jvm()
4545

4646
@OptIn(ExperimentalWasmDsl::class)
4747
wasmJs {
@@ -67,7 +67,7 @@ kotlin {
6767
}
6868

6969
sourceSets {
70-
val desktopMain by getting
70+
val jvmMain by getting
7171
val wasmJsMain by getting
7272

7373
androidMain.dependencies {
@@ -86,7 +86,7 @@ kotlin {
8686
implementation(libs.kotlin.test)
8787
}
8888
}
89-
desktopMain.dependencies {
89+
jvmMain.dependencies {
9090
// Desktop-specific dependencies if needed
9191
}
9292
wasmJsMain.dependencies {
@@ -108,7 +108,7 @@ kotlin {
108108
val wasmJsTest by getting {
109109
resources.srcDirs("src/commonMain/resources")
110110
}
111-
val desktopTest by getting {
111+
val jvmTest by getting {
112112
resources.srcDirs("src/commonMain/resources")
113113
}
114114
val androidUnitTest by getting {

safetensors/src/androidMain/kotlin/sk/ai/net/safetensor/ResourceUtils.kt renamed to safetensors/src/androidMain/kotlin/sk/ai/net/safetensors/ResourceUtils.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import android.content.Context
4-
import android.content.res.AssetManager
54
import java.io.IOException
65

76
/**

safetensors/src/commonMain/kotlin/sk/ai/net/safetensor/ResourceUtils.kt renamed to safetensors/src/commonMain/kotlin/sk/ai/net/safetensors/ResourceUtils.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
/**
44
* Utility class for loading resources in a platform-independent way.

safetensors/src/commonMain/kotlin/sk/ai/net/safetensor/SafeTensor.kt renamed to safetensors/src/commonMain/kotlin/sk/ai/net/safetensors/SafeTensors.kt

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import kotlinx.serialization.json.Json
44
import kotlinx.serialization.json.JsonObject
@@ -32,7 +32,7 @@ import sk.ai.net.graph.tensor.shape.Shape
3232
*
3333
* @see <a href="https://huggingface.co/docs/safetensors/index">Hugging Face Safetensors Documentation</a>
3434
*/
35-
interface SafeTensorReader {
35+
interface SafeTensorsReader {
3636
/**
3737
* Reads a tensor from the safetensor data.
3838
*
@@ -48,7 +48,7 @@ interface SafeTensorReader {
4848
*/
4949
fun getTensorNames(): List<String>
5050

51-
companion object {
51+
companion object Companion {
5252
/**
5353
* Creates a SafeTensorReader from the given byte array.
5454
*
@@ -58,7 +58,7 @@ interface SafeTensorReader {
5858
* @param data The byte array containing the safetensor data.
5959
* @return A SafeTensorReader instance.
6060
*/
61-
fun fromByteArray(data: ByteArray): SafeTensorReader = SafeTensorReaderImpl(data)
61+
fun fromByteArray(data: ByteArray): SafeTensorsReader = SafeTensorsReaderImpl(data)
6262

6363
/**
6464
* Creates a SafeTensorReader from a resource file.
@@ -71,7 +71,7 @@ interface SafeTensorReader {
7171
* @return A SafeTensorReader instance.
7272
* @throws IllegalArgumentException If the resource could not be found.
7373
*/
74-
fun fromResource(resourcePath: String): SafeTensorReader {
74+
fun fromResource(resourcePath: String): SafeTensorsReader {
7575
val resourceBytes = ResourceUtils.loadResourceAsBytes(resourcePath)
7676
?: throw IllegalArgumentException("Resource not found: $resourcePath")
7777

@@ -91,7 +91,7 @@ interface SafeTensorReader {
9191
* @return A SafeTensorReader instance.
9292
* @throws IllegalArgumentException If the file could not be found or read.
9393
*/
94-
fun fromFilePath(filePath: String): SafeTensorReader {
94+
fun fromFilePath(filePath: String): SafeTensorsReader {
9595
// Default implementation falls back to loading as a resource
9696
// Platform-specific implementations will override this behavior
9797
return fromResource(filePath)
@@ -110,7 +110,7 @@ interface SafeTensorReader {
110110
* @return A SafeTensorReader instance.
111111
* @throws IllegalArgumentException If the file could not be found or read.
112112
*/
113-
fun fromFile(file: Any): SafeTensorReader {
113+
fun fromFile(file: Any): SafeTensorsReader {
114114
// Default implementation falls back to loading as a resource
115115
// Platform-specific implementations will override this behavior
116116
return fromResource(file.toString())
@@ -129,7 +129,7 @@ interface SafeTensorReader {
129129
* The implementation supports different tensor data types (F32, I8) and
130130
* converts them to the appropriate tensor implementation.
131131
*/
132-
private class SafeTensorReaderImpl(private val data: ByteArray) : SafeTensorReader {
132+
private class SafeTensorsReaderImpl(private val data: ByteArray) : SafeTensorsReader {
133133
// Header information
134134
private val headerSize: Long
135135
private val metadata: Map<String, TensorMetadata>
@@ -312,18 +312,3 @@ private data class TensorMetadata(
312312
val dataOffset: Long,
313313
val dataLength: Long
314314
)
315-
316-
/**
317-
* Dummy tensor implementation for placeholder purposes.
318-
*
319-
* This class provides a minimal implementation of the Tensor interface,
320-
* returning zero for all element accesses. It's used as a fallback when
321-
* a proper tensor implementation cannot be created.
322-
*
323-
* @property shape The shape of the tensor as a list of dimensions.
324-
*/
325-
private class DummyTensor(override val shape: Shape) : Tensor {
326-
override fun get(vararg indices: Int): Double {
327-
return 0.0
328-
}
329-
}

‎safetensors/src/commonTest/kotlin/sk/ai/net/safetensor/ResourceLoadingTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import kotlin.test.Test
44
import kotlin.test.assertEquals
@@ -13,7 +13,7 @@ class ResourceLoadingTest {
1313
val mockSafeTensorData = createMockSafeTensorData()
1414

1515
// Create a SafeTensorReader from the mock data
16-
val reader = SafeTensorReader.fromByteArray(mockSafeTensorData)
16+
val reader = SafeTensorsReader.fromByteArray(mockSafeTensorData)
1717

1818
// Verify that the reader was created successfully
1919
assertNotNull(reader, "SafeTensorReader should be created successfully")

‎safetensors/src/commonTest/kotlin/sk/ai/net/safetensor/SafeTensorReaderTest.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import kotlin.test.Test
44
import kotlin.test.assertEquals
@@ -13,7 +13,7 @@ class SafeTensorReaderTest {
1313
val mockSafeTensorData = createMockSafeTensorData()
1414

1515
// Create a SafeTensorReader from the mock data
16-
val reader = SafeTensorReader.fromByteArray(mockSafeTensorData)
16+
val reader = SafeTensorsReader.fromByteArray(mockSafeTensorData)
1717

1818
// Test getTensorNames
1919
val tensorNames = reader.getTensorNames()
@@ -33,7 +33,7 @@ class SafeTensorReaderTest {
3333
val mockSafeTensorData = createSimpleSafeTensorData()
3434

3535
// Create a SafeTensorReader from the mock data
36-
val reader = SafeTensorReader.fromByteArray(mockSafeTensorData)
36+
val reader = SafeTensorsReader.fromByteArray(mockSafeTensorData)
3737

3838
// Test getTensorNames - should have "a" and "b"
3939
val tensorNames = reader.getTensorNames()

‎safetensors/src/iosMain/kotlin/sk/ai/net/safetensor/ResourceUtils.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import platform.Foundation.*
44
import kotlinx.cinterop.*

safetensors/src/desktopMain/kotlin/sk/ai/net/safetensor/MemoryMappedSafeTensorReader.kt renamed to safetensors/src/jvmMain/kotlin/sk/ai/net/safetensors/MemoryMappedSafeTensorReader.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import java.io.File
44
import java.io.RandomAccessFile
@@ -27,12 +27,12 @@ import sk.ai.net.graph.tensor.shape.Shape
2727
* @property headerBuffer The memory-mapped buffer for the header and metadata.
2828
* @property randomAccessFile The random access file for accessing the file.
2929
*/
30-
class MemoryMappedSafeTensorReader private constructor(
30+
class MemoryMappedSafeTensorsReader private constructor(
3131
private val file: File,
3232
private val fileChannel: FileChannel,
3333
private val headerBuffer: MappedByteBuffer,
3434
private val randomAccessFile: RandomAccessFile
35-
) : SafeTensorReader {
35+
) : SafeTensorsReader {
3636
// Header information
3737
private val headerSize: Long
3838
private val metadata: Map<String, MappedTensorMetadata>
@@ -227,7 +227,7 @@ class MemoryMappedSafeTensorReader private constructor(
227227
* @param file The file containing the safetensor data.
228228
* @return A MemoryMappedSafeTensorReader instance.
229229
*/
230-
fun fromFile(file: File): MemoryMappedSafeTensorReader {
230+
fun fromFile(file: File): MemoryMappedSafeTensorsReader {
231231
val randomAccessFile = RandomAccessFile(file, "r")
232232
val fileChannel = randomAccessFile.channel
233233

@@ -243,7 +243,7 @@ class MemoryMappedSafeTensorReader private constructor(
243243
(8 + headerSize).coerceAtMost(Int.MAX_VALUE.toLong())
244244
)
245245

246-
return MemoryMappedSafeTensorReader(file, fileChannel, headerBuffer, randomAccessFile)
246+
return MemoryMappedSafeTensorsReader(file, fileChannel, headerBuffer, randomAccessFile)
247247
}
248248

249249
/**
@@ -256,7 +256,7 @@ class MemoryMappedSafeTensorReader private constructor(
256256
* @param filePath The path to the file containing the safetensor data.
257257
* @return A MemoryMappedSafeTensorReader instance.
258258
*/
259-
fun fromFilePath(filePath: String): MemoryMappedSafeTensorReader {
259+
fun fromFilePath(filePath: String): MemoryMappedSafeTensorsReader {
260260
return fromFile(File(filePath))
261261
}
262262
}

safetensors/src/desktopMain/kotlin/sk/ai/net/safetensor/ResourceUtils.kt renamed to safetensors/src/jvmMain/kotlin/sk/ai/net/safetensors/ResourceUtils.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import java.io.InputStream
44

safetensors/src/desktopMain/kotlin/sk/ai/net/safetensor/SafeTensorReaderDesktop.kt renamed to safetensors/src/jvmMain/kotlin/sk/ai/net/safetensors/SafeTensorReaderDesktop.kt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sk.ai.net.safetensor
1+
package sk.ai.net.safetensors
22

33
import java.io.File
44

@@ -19,8 +19,8 @@ import java.io.File
1919
* @return A SafeTensorReader instance.
2020
*/
2121
@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
22-
fun SafeTensorReader.Companion.fromFilePath(filePath: String): SafeTensorReader {
23-
return MemoryMappedSafeTensorReader.fromFilePath(filePath)
22+
fun SafeTensorsReader.Companion.fromFilePath(filePath: String): SafeTensorsReader {
23+
return MemoryMappedSafeTensorsReader.fromFilePath(filePath)
2424
}
2525

2626
/**
@@ -33,11 +33,11 @@ fun SafeTensorReader.Companion.fromFilePath(filePath: String): SafeTensorReader
3333
* @return A SafeTensorReader instance.
3434
*/
3535
@Suppress("EXTENSION_SHADOWED_BY_MEMBER", "UNCHECKED_CAST")
36-
fun SafeTensorReader.Companion.fromFile(file: Any): SafeTensorReader {
36+
fun SafeTensorsReader.Companion.fromFile(file: Any): SafeTensorsReader {
3737
if (file !is File) {
3838
throw IllegalArgumentException("Expected java.io.File, got ${file::class.java.name}")
3939
}
40-
return MemoryMappedSafeTensorReader.fromFile(file)
40+
return MemoryMappedSafeTensorsReader.fromFile(file)
4141
}
4242

4343
// Keep the top-level functions for backward compatibility with existing tests
@@ -50,8 +50,8 @@ fun SafeTensorReader.Companion.fromFile(file: Any): SafeTensorReader {
5050
* @param filePath The path to the file containing the safetensor data.
5151
* @return A SafeTensorReader instance.
5252
*/
53-
fun fromFilePath(filePath: String): SafeTensorReader {
54-
return MemoryMappedSafeTensorReader.fromFilePath(filePath)
53+
fun fromFilePath(filePath: String): SafeTensorsReader {
54+
return MemoryMappedSafeTensorsReader.fromFilePath(filePath)
5555
}
5656

5757
/**
@@ -63,6 +63,6 @@ fun fromFilePath(filePath: String): SafeTensorReader {
6363
* @param file The file containing the safetensor data.
6464
* @return A SafeTensorReader instance.
6565
*/
66-
fun fromFile(file: File): SafeTensorReader {
67-
return MemoryMappedSafeTensorReader.fromFile(file)
66+
fun fromFile(file: File): SafeTensorsReader {
67+
return MemoryMappedSafeTensorsReader.fromFile(file)
6868
}

0 commit comments

Comments
 (0)