Skip to content

Commit a477071

Browse files
michalharakalclaude
andcommitted
docs: switch consumer snippets to the BOM and fix wrong artifact IDs
- README and the two tutorials were showing `sk.ainet.transformers: llm-core` / `llm-runtime-kllama` / `llm-agent` — these are project paths, not the published artifact IDs. The actual published coords are `skainet-transformers-core`, `skainet-transformers-runtime- kllama`, `skainet-transformers-agent`. Anyone copy-pasting hit a resolution failure. - Switch all three to the BOM pattern so the version pin lives in one place; only the BOM line needs bumping per release. - Add a Maven dependencyManagement example to the Java getting-started tutorial since Maven users need the explicit `-jvm` classifier. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent dab6e8f commit a477071

3 files changed

Lines changed: 37 additions & 16 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,27 @@ High-performance LLM application layer on top of the [SKaiNET](https://github.co
1818

1919
## Current release
2020

21-
The current release is **0.23.3**, version-aligned with the matching SKaiNET engine release. Coordinates:
21+
The current release is **0.23.3**, version-aligned with the matching SKaiNET engine release.
22+
23+
The recommended way to consume is via the BOM. It pins every published `skainet-transformers-*` artifact and re-exports the upstream `sk.ainet:skainet-bom`, so the engine-side `sk.ainet.core:skainet-*` artifacts get the matching version too — you only need to declare the BOM version in one place.
2224

2325
```kotlin
2426
dependencies {
25-
implementation("sk.ainet.transformers:llm-core:0.23.3")
26-
implementation("sk.ainet.transformers:llm-runtime-kllama:0.23.3") // or kgemma, kqwen, kapertus
27-
implementation("sk.ainet.transformers:llm-agent:0.23.3") // chat templates + tool calling
27+
implementation(platform("sk.ainet.transformers:skainet-transformers-bom:0.23.3"))
28+
29+
// Versions resolved from the BOM:
30+
implementation("sk.ainet.transformers:skainet-transformers-core")
31+
implementation("sk.ainet.transformers:skainet-transformers-runtime-kllama") // or runtime-kgemma, inference-qwen, inference-apertus
32+
implementation("sk.ainet.transformers:skainet-transformers-agent") // chat templates + tool calling
2833
}
2934
```
3035

3136
To opt in to the native FFM CPU provider (recommended for JVM consumers):
3237

3338
```kotlin
3439
dependencies {
35-
implementation("sk.ainet.core:skainet-backend-cpu:0.23.3") // priority-50 Panama Vector
36-
implementation("sk.ainet.core:skainet-backend-native-cpu:0.23.3") // priority-100 FFM (auto-discovered)
40+
implementation("sk.ainet.core:skainet-backend-cpu") // priority-50 Panama Vector
41+
implementation("sk.ainet.core:skainet-backend-native-cpu") // priority-100 FFM (auto-discovered)
3742
}
3843
```
3944

docs/modules/ROOT/pages/tutorials/getting-started-java.adoc

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,34 @@ In your `build.gradle.kts`:
1515
[source,kotlin]
1616
----
1717
dependencies {
18-
implementation("sk.ainet.transformers:llm-runtime-kllama:0.21.0")
19-
implementation("sk.ainet.transformers:llm-agent:0.21.0")
18+
implementation(platform("sk.ainet.transformers:skainet-transformers-bom:0.23.3"))
19+
20+
implementation("sk.ainet.transformers:skainet-transformers-runtime-kllama")
21+
implementation("sk.ainet.transformers:skainet-transformers-agent")
2022
}
2123
----
2224

23-
Or in Maven:
25+
Or in Maven (Maven needs the `-jvm` classifier suffix on platform artifacts):
2426

2527
[source,xml]
2628
----
27-
<dependency>
28-
<groupId>sk.ainet.transformers</groupId>
29-
<artifactId>llm-runtime-kllama</artifactId>
30-
<version>0.21.0</version>
31-
</dependency>
29+
<dependencyManagement>
30+
<dependencies>
31+
<dependency>
32+
<groupId>sk.ainet.transformers</groupId>
33+
<artifactId>skainet-transformers-bom</artifactId>
34+
<version>0.23.3</version>
35+
<type>pom</type>
36+
<scope>import</scope>
37+
</dependency>
38+
</dependencies>
39+
</dependencyManagement>
40+
<dependencies>
41+
<dependency>
42+
<groupId>sk.ainet.transformers</groupId>
43+
<artifactId>skainet-transformers-runtime-kllama-jvm</artifactId>
44+
</dependency>
45+
</dependencies>
3246
----
3347

3448
You also need the JVM args for the Vector API at runtime:

docs/modules/ROOT/pages/tutorials/llama3-tool-calling.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ The pieces you need live in three modules:
5252
[source,kotlin]
5353
----
5454
dependencies {
55-
implementation("sk.ainet.transformers:llm-runtime-kllama:0.23.2")
56-
implementation("sk.ainet.transformers:llm-agent:0.23.2")
55+
implementation(platform("sk.ainet.transformers:skainet-transformers-bom:0.23.3"))
56+
57+
implementation("sk.ainet.transformers:skainet-transformers-runtime-kllama")
58+
implementation("sk.ainet.transformers:skainet-transformers-agent")
5759
}
5860
----
5961

0 commit comments

Comments
 (0)