donkey-embeddings-huggingface 0.1.0__tar.gz

donkey_embeddings_huggingface-0.1.0/.gitignore

@@ -0,0 +1,85 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+#IDE
+.DS_Store
+.idea
+.vscode
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Mkdocs documentation
+docs/_build/
+docs/api_reference/site/
+
+# Ruff
+.ruff_cache/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

donkey_embeddings_huggingface-0.1.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: donkey-embeddings-huggingface
+Version: 0.1.0
+Summary: donkey embeddings huggingface integration
+Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>
+License: Apache-2.0
+Requires-Python: <3.14,>=3.11
+Requires-Dist: donkey-core<0.2.0,>=0.1.0
+Requires-Dist: hf-xet<1.5.0,>=1.4.2
+Requires-Dist: sentence-transformers<6.0.0,>=5.2.3
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio<2.0.0,>=1.4.0; extra == 'dev'
+Requires-Dist: pytest<10.0.0,>=9.1.1; extra == 'dev'
+Requires-Dist: ruff<0.16.0,>=0.15.20; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Donkey embeddings integration - HuggingFace
+
+HuggingFace sentence-transformers integration for Donkey.
+
+## Installation
+
+```bash
+pip install donkey-embeddings-huggingface
+```

donkey_embeddings_huggingface-0.1.0/README.md

@@ -0,0 +1,9 @@
+# Donkey embeddings integration - HuggingFace
+
+HuggingFace sentence-transformers integration for Donkey.
+
+## Installation
+
+```bash
+pip install donkey-embeddings-huggingface
+```

donkey_embeddings_huggingface-0.1.0/donkey/embeddings/huggingface/__init__.py

@@ -0,0 +1,3 @@
+from donkey.embeddings.huggingface.base import HuggingFaceEmbedding
+
+__all__ = ["HuggingFaceEmbedding"]

donkey_embeddings_huggingface-0.1.0/donkey/embeddings/huggingface/base.py

@@ -0,0 +1,43 @@
+from typing import Any, Literal
+
+from donkey.core.bridge.pydantic import Field, PrivateAttr
+from donkey.core.embeddings import BaseEmbedding, Embedding
+
+
+class HuggingFaceEmbedding(BaseEmbedding):
+    """
+    HuggingFace `sentence_transformers` embedding models.
+
+    Attributes:
+        model_name (str): Hugging Face model to be used. Defaults to `sentence-transformers/all-MiniLM-L6-v2`.
+        device (str, optional): Device to run the model on. Supports `cpu` and `cuda`. Defaults to `cpu`.
+
+    Example:
+        ```python
+        from donkey.embeddings.huggingface import HuggingFaceEmbedding
+
+        embedding = HuggingFaceEmbedding()
+        ```
+    """
+
+    model_name: str = Field(
+        default="sentence-transformers/all-MiniLM-L6-v2",
+        description="Name of the embedding model",
+    )
+    device: Literal["cpu", "cuda"] = "cpu"
+
+    _client: Any = PrivateAttr()
+
+    def model_post_init(self, __context):  # noqa: PYI063
+        from sentence_transformers import SentenceTransformer
+
+        self._client = SentenceTransformer(self.model_name, device=self.device)
+
+    def _get_text_embeddings(self, input: str | list[str]) -> list[Embedding]:
+        """Embed one or more text strings."""
+        embeddings = self._client.encode_document(input).tolist()
+
+        if embeddings and all(isinstance(item, list) for item in embeddings):
+            return embeddings
+        else:
+            return [embeddings]

donkey_embeddings_huggingface-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "donkey-embeddings-huggingface"
+version = "0.1.0"
+description = "donkey embeddings huggingface integration"
+authors = [{ name = "Leonardo Furnielis", email = "leonardofurnielis@outlook.com" }]
+license = { text = "Apache-2.0" }
+readme = "README.md"
+requires-python = ">=3.11,<3.14"
+dependencies = [
+    "sentence-transformers>=5.2.3,<6.0.0",
+    "hf-xet>=1.4.2,<1.5.0",
+    "donkey-core>=0.1.0,<0.2.0",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["donkey/"]
+
+[tool.hatch.build.targets.wheel]
+include = ["donkey/"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.1.1,<10.0.0",
+    "pytest-asyncio>=1.4.0,<2.0.0",
+    "ruff>=0.15.20,<0.16.0",
+]