Improved Documentation

.github/workflows/prerelease.yml

@@ -16,7 +16,27 @@ permissions:
   contents: read
 
 jobs:
-
+  versioning:
+    name: Update Version
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Run TinySemVer
+        uses: ashvardanian/[email protected]
+        with:
+          verbose: "true"
+          version-file: "VERSION"
+          update-version-in: |
+            package.json:"version": "(\d+\.\d+\.\d+)"
+            package-lock.json:"uform",\n\s+"version": "(\d+\.\d+\.\d+)"
+            CITATION.cff:^version: (\d+\.\d+\.\d+)
+            pyproject.toml:^version = "(\d+\.\d+\.\d+)"
+          dry-run: "true"
+
   test_python:
     name: Test Python
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -15,16 +15,28 @@ permissions:
 
 jobs:
   versioning:
-    name: Semantic Release
+    name: Update Version
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
+          fetch-depth: 0
           persist-credentials: false
-      - uses: actions/setup-node@v4
+      - name: Run TinySemVer
+        uses: ashvardanian/[email protected]
         with:
-          node-version: 20
-      - run: npm install --save-dev --prefix ./package-ci @semantic-release/exec @semantic-release/git conventional-changelog-eslint semantic-release && npx --prefix ./package-ci semantic-release
+          verbose: "true"
+          version-file: "VERSION"
+          update-version-in: |
+            package.json:"version": "(\d+\.\d+\.\d+)"
+            package-lock.json:"uform",\n\s+"version": "(\d+\.\d+\.\d+)"
+            CITATION.cff:^version: (\d+\.\d+\.\d+)
+            pyproject.toml:^version = "(\d+\.\d+\.\d+)"
+          dry-run: "false"
+          push: "true"
+          create-release: "true"
+          github-token: ${{ secrets.SEMANTIC_RELEASE_TOKEN }}
 
   rebase:
     name: Rebase Dev. Branch

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "cSpell.words": [
         "arange",
+        "ashvardanian",
         "astype",
         "CFURL",
         "coreml",

README.md

@@ -42,7 +42,7 @@ With compact __custom pre-trained transformer models__, this can run anywhere fr
 
 ## Features
 
-- __Tiny Embeddings__: 64-dimensional [Matryoshaka][matryoshka]-style embeddings for extremely fast [search][usearch].
+- __Tiny Embeddings__: 64-dimensional [Matryoshka][matryoshka]-style embeddings for extremely fast [search][usearch].
 - __Throughput__: Thanks to the small size, the inference speed is [2-4x faster](#speed) than competitors.
 - __Portable__: Models come with native ONNX support, making them easy to deploy on any platform.
 - __Quantization Aware__: Down-cast embeddings from `f32` to `i8` without losing much recall.
@@ -153,7 +153,7 @@ from io import BytesIO
 from PIL import Image
 
 image_url = 'https://media-cdn.tripadvisor.com/media/photo-s/1b/28/6b/53/lovely-armenia.jpg'
-image_url = Image.open(BytesIO(requests.get(image_url).content))
+image = Image.open(BytesIO(requests.get(image_url).content))
 image_data = processor_image(image)
 image_features, image_embedding = model_image.encode(image_data, return_features=True)
 ```

package.json

@@ -1,8 +1,7 @@
 {
   "name": "@unum-cloud/uform",
   "type": "module",
-  "private": false,
-  "version": "2.0.2",
+  "version": "3.0.2",
   "description": "Pocket-Sized Multimodal AI for Content Understanding and Generation",
   "dependencies": {
     "@huggingface/hub": "^0.14.8",