Skip to content

Commit 28a2518

Browse files
committed
update readme
1 parent 90a1639 commit 28a2518

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
- [2. Install ML Module (Optional)](#2-install-ml-module-optional)
1212
* [Design Choices](#design-choices)
1313
- [Core and ML](#core-and-ml)
14-
- [Model](#model)
1514
- [Embedding Storage](#embedding-storage)
1615
- [Benchmark Summary](#benchmark-summary)
1716

@@ -55,13 +54,13 @@ dependencyResolutionManagement {
5554
### **1. Install Core Module**
5655

5756
```gradle
58-
implementation("com.github.dev-diaries41.smartscan-sdk:smartscan-core:1.1.0")
57+
implementation("com.github.dev-diaries41.smartscan-sdk:smartscan-core:${smartscanVersion}")
5958
```
6059

6160
### **2. Install ML Module (Optional)**
6261

6362
```gradle
64-
implementation("com.github.dev-diaries41.smartscan-sdk:smartscan-ml:1.1.0")
63+
implementation("com.github.dev-diaries41.smartscan-sdk:smartscan-ml:${smartscanVersion}")
6564
```
6665

6766
> `ml` depends on `core`, so including it is enough if you need both.
@@ -217,8 +216,9 @@ val result = clusterer.cluster(itemEmbeds)
217216

218217
### Core and ML
219218

220-
* **core** → minimal runtime: shared interfaces, data classes, embeddings, media helpers, processor execution, and efficient batch/concurrent processing.
221-
* **ml** → ML infrastructure and models: model loaders, base models, embedding providers (e.g., CLIP), and few-shot classifiers. Optional or experimental ML-related features can be added under `ml/providers`.
219+
core → contains all core business logic: shared interfaces, data models, embeddings, clustering, classification, indexing, and processing components for batch/concurrent execution.
220+
221+
ml → contains all machine learning components, including models, providers, and everything they depend on.
222222

223223
---
224224

0 commit comments

Comments
 (0)