embedkombinat-annotator 0.3.0__tar.gz

embedkombinat_annotator-0.3.0/.dockerignore

@@ -0,0 +1,21 @@
+.git/
+.github/
+.venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+tests/
+coverage.xml
+.coverage
+htmlcov/
+.env
+.env.example
+.DS_Store
+docker-compose.yml
+annotator-prd.md

embedkombinat_annotator-0.3.0/.env.example

@@ -0,0 +1,23 @@
+# annotator configuration
+# All variables are prefixed with ANNOTATOR_
+
+# kombinat API URL
+# ANNOTATOR_KOMBINAT_URL=https://api.embedkombinat.dev
+
+# Batch size (pairs per batch claimed from kombinat)
+# ANNOTATOR_BATCH_SIZE=100
+
+# Chunk size (pairs per submission to kombinat)
+# ANNOTATOR_CHUNK_SIZE=50
+
+# Fraction of GPU memory for inference (vLLM only)
+# ANNOTATOR_GPU_MEMORY_UTILIZATION=0.9
+
+# Max model context length
+# ANNOTATOR_MAX_MODEL_LEN=4096
+
+# Max output tokens per response
+# ANNOTATOR_MAX_OUTPUT_TOKENS=256
+
+# Annotator home directory (auth, models, logs)
+# ANNOTATOR_ANNOTATOR_HOME=~/.annotator

embedkombinat_annotator-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run mypy annotator/
+      - run: uv run pytest -v --tb=short
+
+      - name: Upload coverage
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-xml-annotator
+          path: coverage.xml
+
+  docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+
+      # The vllm/vllm-openai base image is ~5.3 GB and doesn't fit on the default
+      # GitHub runner once the preinstalled toolchain is there — ~14 GB of unused
+      # SDKs need to be cleared before `docker build` can extract the layers.
+      - name: Free disk space
+        uses: jlumbroso/free-disk-space@v1.3.1
+        with:
+          tool-cache: true
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          swap-storage: true
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GHCR
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build (and push on main)
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+          tags: |
+            ghcr.io/embedkombinat/annotator:latest
+            ghcr.io/embedkombinat/annotator:${{ github.sha }}
+          labels: |
+            org.opencontainers.image.revision=${{ github.sha }}
+            org.opencontainers.image.version=${{ github.sha }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

embedkombinat_annotator-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run mypy annotator/
+      - run: uv run pytest -v --tb=short
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi-publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create "${{ github.ref_name }}" dist/* --generate-notes

embedkombinat_annotator-0.3.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+dist/
+build/
+*.egg-info/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+.env
+*.egg
+.DS_Store
+uv.lock
+annotator-prd.md

embedkombinat_annotator-0.3.0/CLAUDE.md

@@ -0,0 +1,55 @@
+# CLAUDE.md — annotator
+
+This file provides guidance to Claude Code (claude.ai/code) when working in the **annotator** sub-repo (headless CLI labeling worker, Python 3.12+, Typer, vLLM/MLX/llama.cpp).
+
+## Build and dev commands
+
+```bash
+pip install -e ".[dev]"          # or: uv sync --all-extras
+
+# Lint, format, type check
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy annotator/
+
+# Tests
+uv run pytest -v
+
+# Single test
+uv run pytest tests/test_runner.py::TestRunnerBasicLoop -v
+```
+
+## Linting policy
+
+CI runs `ruff check .` and `ruff format --check .` as hard gates. Both must pass on every push.
+
+**Always fix lint errors — never ignore them.** When you finish editing Python files, run:
+
+```bash
+uv run ruff check --fix .
+uv run ruff format .
+uv run ruff check .              # confirm zero errors
+uv run ruff format --check .     # confirm formatting clean
+```
+
+Fix every error surfaced, including in files you did not touch directly. Do not add `# noqa` suppressions or extend `tool.ruff.lint.ignore` to silence pre-existing errors — collapse nested `with` into a single statement, rename unused variables to `_`, shorten long lines, etc. The only acceptable reason to touch ignore lists is when a rule is genuinely wrong for this codebase, and that change must be called out explicitly.
+
+Same rule for `uv run mypy annotator/` — fix the types, don't add `# type: ignore`.
+
+## Architecture
+
+Typer CLI with polymorphic inference backends. Heavy modules (vllm, mlx_lm, llama_cpp) are lazy-imported to avoid startup delay.
+
+- `annotator/cli.py` — Commands: default (run loop), login, status, logout
+- `annotator/runner.py` — Orchestration: auth → resolve → load engine → claim/label/submit loop. SIGINT/SIGTERM: first = graceful (finish chunk), second within 3s = forced exit.
+- `annotator/resolver.py` — Hardware detection (NVIDIA via pynvml → Apple Silicon via sysctl → CPU fallback), model selection from registry by available VRAM
+- `annotator/engine/` — `BaseEngine` ABC with `load()` and `label_batch()`. Implementations: `VLLMEngine` (guided JSON decoding, batch), `MLXEngine` (sequential), `LlamaCppEngine` (stub)
+- `annotator/labeler.py` — Prompt template (system + user with XML-wrapped query/doc), JSON response parsing, SHA256 hashing
+- `annotator/client.py` — HTTPX client with exponential backoff (3 retries for 5xx, increasing wait on 204 no-pairs)
+- `annotator/auth.py` — GitHub OAuth web flow with a fixed-port (`ANNOTATOR_AUTH_PORT`, default `51820`) localhost callback server, token persisted to `~/.annotator/auth.json`
+
+### Key conventions
+
+- **Pydantic everywhere** (BaseSettings, API schemas, internal DTOs). No dataclasses.
+- **Config via env vars**, prefixed with `ANNOTATOR_` (e.g. `ANNOTATOR_KOMBINAT_URL`).
+- **Tests do not use pytest-asyncio.** All tests are synchronous.

embedkombinat_annotator-0.3.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to annotator
+
+Thanks for your interest. This document covers what you need to know to get a development environment running and submit changes.
+
+## Development setup
+
+Prerequisites: Python 3.12 or newer, [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/embedkombinat/annotator.git
+cd annotator
+uv sync --all-extras
+```
+
+The `--all-extras` flag pulls in the dev dependencies plus all three inference backends (vLLM, MLX, llama.cpp). On platforms that can't install one of them (e.g. MLX on Linux), drop the relevant extra: `uv sync --extra dev --extra vllm`.
+
+## Workflow
+
+- Branch off `main`. Open a pull request when ready; no direct pushes to `main`.
+- Keep commits focused. Squash exploratory work before opening the PR.
+- The CI gate runs `ruff check`, `ruff format --check`, `mypy`, and `pytest`. Run them locally before pushing.
+
+```bash
+uv run ruff check --fix .
+uv run ruff format .
+uv run ruff check .               # confirm zero errors
+uv run ruff format --check .      # confirm formatting clean
+uv run mypy annotator/
+uv run pytest -v
+```
+
+We do not accept `# noqa` or `# type: ignore` to silence existing errors. Fix the root cause, including in files you didn't touch. If a lint rule is genuinely wrong for this codebase, call that out explicitly in the PR.
+
+## Adding an inference engine
+
+Engines live under `annotator/engine/` and subclass `BaseEngine` (`annotator/engine/base.py`). Implement `load()` and `label_batch()`. Register the new engine in `annotator/resolver.py` so it can be auto-selected based on detected hardware. Add tests under `tests/`; existing engine tests are a good template.
+
+## Reporting bugs and proposing features
+
+File an issue at https://github.com/embedkombinat/annotator/issues. Include the output of `annotator status --debug` (when implemented) or at least your OS, Python version, and the command that failed.
+
+## Security disclosures
+
+For anything that looks like a real vulnerability, please don't file it as a public issue. Use [GitHub Private Vulnerability Reporting](https://github.com/embedkombinat/annotator/security/advisories/new) or email security@embedkombinat.org.

embedkombinat_annotator-0.3.0/Dockerfile

@@ -0,0 +1,20 @@
+# check=skip=SecretsUsedInArgOrEnv
+FROM vllm/vllm-openai:v0.20.0
+
+LABEL org.opencontainers.image.source="https://github.com/embedkombinat/annotator"
+LABEL org.opencontainers.image.description="Distributed annotation worker for EmbedKombinat"
+LABEL org.opencontainers.image.licenses="Apache-2.0"
+
+WORKDIR /app
+
+COPY pyproject.toml README.md LICENSE ./
+COPY annotator/ ./annotator/
+
+# Base image already provides vllm; install only annotator + non-vllm deps
+# so pip doesn't fight the base's torch/triton/flash-attn pins.
+RUN pip install --no-cache-dir .
+
+ENV HF_HOME=/root/.annotator/models
+
+ENTRYPOINT ["annotator"]
+CMD []

embedkombinat_annotator-0.3.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 EmbedKombinat contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.