💡 All-in-one AI framework for semantic search, LLM orchestration and language model workflows
Python agentsaiai-agentsembeddingsinformation-retrievallanguage-modellarge-language-modelsllmnlppythonragretrieval-augmented-generationsearchsearch-enginesemantic-searchsentence-embeddingstransformerstxtaivector-databasevector-search
Support minimal install for edge devices, closes #1089
davidmezzetti20fff84a7eb0
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.ymlindex f0ff23fa..02bdf1ec 100644--- a/.github/workflows/docs.yml+++ b/.github/workflows/docs.yml@@ -7,12 +7,19 @@ jobs:deploy:runs-on: ubuntu-lateststeps:- - uses: actions/checkout@v6- - uses: actions/setup-python@v6+ - name: Checkout code+ uses: actions/checkout@v6++ - name: Install Python+ uses: actions/setup-python@v6with:python-version: "3.10"- - run: |++ - name: Install txtai+ run: |pip install -U pip wheelpip install .[all,dev]- - run: mkdocs gh-deploy --force++ - name: Deploy documentation+ run: mkdocs gh-deploy --force\ No newline at end of filediff --git a/.github/workflows/minimal.yml b/.github/workflows/minimal.ymlindex b9ce7a11..498601b5 100644--- a/.github/workflows/minimal.yml+++ b/.github/workflows/minimal.yml@@ -7,11 +7,21 @@ jobs:deploy:runs-on: ubuntu-lateststeps:- - uses: actions/checkout@v6- - uses: actions/setup-python@v6+ - name: Checkout code+ uses: actions/checkout@v6++ - name: Install Python+ uses: actions/setup-python@v6with:python-version: "3.10"- - run: |++ - name: Base install+ run: |pip install -U pip wheelpip install .python -c "import txtai"++ - name: Minimal install+ run: |+ pip uninstall faiss-cpu msgpack torch+ python -c "import txtai"diff --git a/Makefile b/Makefileindex de649854..471a788c 100644--- a/Makefile+++ b/Makefile@@ -52,6 +52,7 @@ coverage:coverage run -m unittest discover -v -k testpipeline.testtrain -s ${TEST_DIR}coverage run -m unittest discover -v -k testscoring -s ${TEST_DIR}coverage run -m unittest discover -v -k testserialize -s ${TEST_DIR}+ coverage run -m unittest discover -v -k testtorch -s ${TEST_DIR}coverage run -m unittest discover -v -k testvectors -s ${TEST_DIR}coverage run -m unittest discover -v -k testworkflow -s ${TEST_DIR}coverage combinediff --git a/setup.py b/setup.pyindex cf81fc68..64360096 100644--- a/setup.py+++ b/setup.py@@ -5,10 +5,10 @@ with open("README.md", "r", encoding="utf-8") as f:# Remove GitHub dark mode imagesDESCRIPTION = "".join([line for line in f if "gh-dark-mode-only" not in line])-# Required dependencies+# Default dependenciesinstall = ["faiss-cpu>=1.7.1.post2", "msgpack>=1.0.7", "torch>=2.4", "transformers>=4.56.2"]-# Required dependencies that are also base transformers dependencies+# Default dependencies that are also base transformers dependenciesinstall += ["huggingface-hub>=0.34.0", "numpy>=1.18.4", "pyyaml>=5.3", "regex>=2022.8.17", "safetensors>=0.4.5"]# Optional dependenciesdiff --git a/src/python/txtai/ann/dense/factory.py b/src/python/txtai/ann/dense/factory.pyindex 658bd109..eaf61505 100644--- a/src/python/txtai/ann/dense/factory.py+++ b/src/python/txtai/ann/dense/factory.py@@ -5,7 +5,7 @@ Factory modulefrom ...util import Resolverfrom .annoy import Annoy-from .faiss import Faiss+from .faiss import Faiss, FAISSfrom .ggml import GGMLfrom .hnsw import HNSWfrom .numpy import NumPy@@ -33,7 +33,7 @@ class ANNFactory:# ANN instanceann = None- backend = config.get("backend", "faiss")+ backend = config.get("backend", "faiss" if FAISS else "numpy")# Create ANN instanceif backend == "annoy":diff --git a/src/python/txtai/ann/dense/faiss.py b/src/python/txtai/ann/dense/faiss.pyindex 40480d55..a60a5825 100644--- a/src/python/txtai/ann/dense/faiss.py+++ b/src/python/txtai/ann/dense/faiss.py@@ -16,8 +16,14 @@ if platform.system() == "Darwin" or os.name == "nt":import numpy as np-from faiss import index_factory, IO_FLAG_MMAP, METRIC_INNER_PRODUCT, read_index, write_index-from faiss import index_binary_factory, read_index_binary, write_index_binary, IndexBinaryIDMap+# Conditional import+try:+ from faiss import index_factory, IO_FLAG_MMAP, METRIC_INNER_PRODUCT, read_index, write_index+ from faiss import index_binary_factory, read_index_binary, write_index_binary, IndexBinaryIDMap++ FAISS = True+except ImportError:+ FAISS = Falsefrom ..base import ANN@@ -30,6 +36,9 @@ class Faiss(ANN):def __init__(self, config):super().__init__(config)+ if not FAISS:+ raise ImportError('Faiss is not available - install "ann" extra to enable')+# Scalar quantizationquantize = self.config.get("quantize")self.qbits = quantize if quantize and isinstance(quantize, int) and not isinstance(quantize, bool) else Nonediff --git a/src/python/txtai/ann/dense/torch.py b/src/python/txtai/ann/dense/torch.pyindex c83d9d71..be736088 100644--- a/src/python/txtai/ann/dense/torch.py+++ b/src/python/txtai/ann/dense/torch.py@@ -3,7 +3,6 @@ PyTorch module"""import numpy as np-import torchtry:from bitsandbytes import matmul_4bit@@ -23,6 +22,11 @@ except ImportError:from .numpy import NumPy+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+class Torch(NumPy):"""diff --git a/src/python/txtai/data/tokens.py b/src/python/txtai/data/tokens.pyindex f04bc996..67b9af96 100644--- a/src/python/txtai/data/tokens.py+++ b/src/python/txtai/data/tokens.py@@ -2,10 +2,12 @@Tokens module"""-import torch+from ..util import TorchLib+Dataset = TorchLib().dataset()-class Tokens(torch.utils.data.Dataset):++class Tokens(Dataset):"""Default dataset used to hold tokenized data."""diff --git a/src/python/txtai/models/models.py b/src/python/txtai/models/models.pyindex e05d7efa..d2e532de 100644--- a/src/python/txtai/models/models.py+++ b/src/python/txtai/models/models.py@@ -4,8 +4,6 @@ Models moduleimport os-import torch-from transformers import (AutoConfig,AutoModel,@@ -18,6 +16,11 @@ from transformers.models.auto.modeling_auto import MODEL_FOR_IMAGE_TEXT_TO_TEXT_from .onnx import OnnxModel+# Conditional torch imports+from ..util import TorchLib++torch = TorchLib().torch()+class Models:"""diff --git a/src/python/txtai/models/onnx.py b/src/python/txtai/models/onnx.pyindex 77a0b1f7..728ff4b1 100644--- a/src/python/txtai/models/onnx.py+++ b/src/python/txtai/models/onnx.py@@ -11,15 +11,21 @@ except ImportError:ONNX_RUNTIME = Falseimport numpy as np-import torch++import transformersfrom transformers import AutoConfigfrom transformers.configuration_utils import PretrainedConfig-from transformers.modeling_outputs import SequenceClassifierOutput-from transformers.modeling_utils import PreTrainedModelfrom .registry import Registry+# Conditional torch imports+from ..util import TorchLib++torchlib = TorchLib()+torch = torchlib.torch()+PreTrainedModel = torchlib.pretrained()+# pylint: disable=W0223class OnnxModel(PreTrainedModel):@@ -95,7 +101,7 @@ class OnnxModel(PreTrainedModel):# pylint: disable=E1101# Detect if logits is an output and return classifier output in that caseif any(x.name for x in self.model.get_outputs() if x.name == "logits"):- return SequenceClassifierOutput(logits=torch.from_numpy(np.array(results[0])))+ return transformers.modeling_outputs.SequenceClassifierOutput(logits=torch.from_numpy(np.array(results[0])))return torch.from_numpy(np.array(results))diff --git a/src/python/txtai/models/pooling/base.py b/src/python/txtai/models/pooling/base.pyindex 5a5cd034..ee0c4794 100644--- a/src/python/txtai/models/pooling/base.py+++ b/src/python/txtai/models/pooling/base.py@@ -5,16 +5,21 @@ Pooling moduleimport jsonimport numpy as np-import torchfrom huggingface_hub.errors import HFValidationError-from torch import nnfrom transformers.utils import cached_filefrom ..models import Models+# Conditional torch imports+from ...util import TorchLib-class Pooling(nn.Module):+torchlib = TorchLib()+torch = torchlib.torch()+Module = torchlib.module()+++class Pooling(Module):"""Builds pooled vectors usings outputs from a transformers model."""diff --git a/src/python/txtai/models/pooling/last.py b/src/python/txtai/models/pooling/last.pyindex 3ee08a30..b203b610 100644--- a/src/python/txtai/models/pooling/last.py+++ b/src/python/txtai/models/pooling/last.py@@ -2,10 +2,13 @@Last module"""-import torch-from .base import Pooling+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+class LastPooling(Pooling):"""diff --git a/src/python/txtai/models/pooling/late.py b/src/python/txtai/models/pooling/late.pyindex 54dfac7a..f325e52f 100644--- a/src/python/txtai/models/pooling/late.py+++ b/src/python/txtai/models/pooling/late.py@@ -3,15 +3,19 @@ Late module"""import numpy as np-import torchfrom safetensors import safe_open-from torch import nnfrom transformers.utils import cached_filefrom .base import Poolingfrom .muvera import Muvera+# Conditional torch imports+from ...util import TorchLib++torchlib = TorchLib()+torch = torchlib.torch()+class LatePooling(Pooling):"""@@ -45,7 +49,7 @@ class LatePooling(Pooling):weights = f.get_tensor("linear.weight")# Load weights into linear layer- self.linear = nn.Linear(weights.shape[1], weights.shape[0], bias=False, device=self.device, dtype=weights.dtype)+ self.linear = torch.nn.Linear(weights.shape[1], weights.shape[0], bias=False, device=self.device, dtype=weights.dtype)with torch.no_grad():self.linear.weight.copy_(weights)diff --git a/src/python/txtai/models/pooling/mean.py b/src/python/txtai/models/pooling/mean.pyindex 3d224178..b6011168 100644--- a/src/python/txtai/models/pooling/mean.py+++ b/src/python/txtai/models/pooling/mean.py@@ -2,10 +2,13 @@Mean module"""-import torch-from .base import Pooling+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+class MeanPooling(Pooling):"""diff --git a/src/python/txtai/models/tokendetection.py b/src/python/txtai/models/tokendetection.pyindex d3448b96..6283d710 100644--- a/src/python/txtai/models/tokendetection.py+++ b/src/python/txtai/models/tokendetection.py@@ -5,9 +5,12 @@ Token Detection moduleimport inspectimport os-import torch+# Conditional torch imports+from ..util import TorchLib-from transformers import PreTrainedModel+torchlib = TorchLib()+torch = torchlib.torch()+PreTrainedModel = torchlib.pretrained()class TokenDetection(PreTrainedModel):diff --git a/src/python/txtai/pipeline/audio/texttospeech.py b/src/python/txtai/pipeline/audio/texttospeech.pyindex 82b1ee7b..5eb8cc51 100644--- a/src/python/txtai/pipeline/audio/texttospeech.py+++ b/src/python/txtai/pipeline/audio/texttospeech.py@@ -20,7 +20,6 @@ import loggingfrom io import BytesIO-import torchimport yamlimport numpy as np@@ -31,6 +30,11 @@ from transformers.utils import cached_filefrom ..base import Pipeline+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+# Logging configurationlogger = logging.getLogger(__name__)diff --git a/src/python/txtai/pipeline/tensors.py b/src/python/txtai/pipeline/tensors.pyindex c86cf72e..43a7f1c4 100644--- a/src/python/txtai/pipeline/tensors.py+++ b/src/python/txtai/pipeline/tensors.py@@ -2,10 +2,13 @@Tensor processing framework module"""-import torch-from .base import Pipeline+# Conditional torch imports+from ..util import TorchLib++torch = TorchLib().torch()+class Tensors(Pipeline):"""diff --git a/src/python/txtai/pipeline/text/lateencoder.py b/src/python/txtai/pipeline/text/lateencoder.pyindex f970df60..118f950c 100644--- a/src/python/txtai/pipeline/text/lateencoder.py+++ b/src/python/txtai/pipeline/text/lateencoder.py@@ -3,11 +3,15 @@ Late encoder module"""import numpy as np-import torchfrom ...models import Models, PoolingFactoryfrom ..base import Pipeline+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+class LateEncoder(Pipeline):"""diff --git a/src/python/txtai/pipeline/text/questions.py b/src/python/txtai/pipeline/text/questions.pyindex 4e785735..d05768f5 100644--- a/src/python/txtai/pipeline/text/questions.py+++ b/src/python/txtai/pipeline/text/questions.py@@ -2,11 +2,13 @@Questions module"""-import torch-import torch.nn.functional as F-from ..hfmodel import HFModel+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+class Questions(HFModel):"""@@ -56,8 +58,8 @@ class Questions(HFModel):answer = self.answer(contexts[x], tokens, start, end)# Calculate span score- startprob = F.softmax(startlogits, dim=-1)[0]- endprob = F.softmax(endlogits, dim=-1)[0]+ startprob = torch.nn.functional.softmax(startlogits, dim=-1)[0]+ endprob = torch.nn.functional.softmax(endlogits, dim=-1)[0]score = startprob[start] * endprob[end]# Require score to be at least 0.05diff --git a/src/python/txtai/pipeline/train/hfonnx.py b/src/python/txtai/pipeline/train/hfonnx.pyindex 37428964..5ad081ef 100644--- a/src/python/txtai/pipeline/train/hfonnx.py+++ b/src/python/txtai/pipeline/train/hfonnx.py@@ -15,14 +15,18 @@ try:except ImportError:ONNX_RUNTIME = False-from torch import nn-from torch.onnx import export-from transformers import AutoModel, AutoModelForQuestionAnswering, AutoModelForSequenceClassification, AutoTokenizerfrom ...models import PoolingFactoryfrom ..tensors import Tensors+# Conditional torch imports+from ...util import TorchLib++torchlib = TorchLib()+torch = torchlib.torch()+Module = torchlib.module()+class HFOnnx(Tensors):"""@@ -60,7 +64,7 @@ class HFOnnx(Tensors):output = output if output else BytesIO()# Export model to ONNX- export(+ torch.onnx.export(ModelWrapper(model),(dummy,),output,@@ -157,7 +161,7 @@ class HFOnnx(Tensors):return (inputs,) + config[task]-class ModelWrapper(nn.Module):+class ModelWrapper(Module):"""Wraps an model to control named inputs for export."""diff --git a/src/python/txtai/pipeline/train/hftrainer.py b/src/python/txtai/pipeline/train/hftrainer.pyindex 711053e0..33870b26 100644--- a/src/python/txtai/pipeline/train/hftrainer.py+++ b/src/python/txtai/pipeline/train/hftrainer.py@@ -5,8 +5,6 @@ Hugging Face Transformers trainer wrapper moduleimport osimport sys-import torch-from transformers import (AutoConfig,AutoModelForCausalLM,@@ -35,6 +33,11 @@ from ...data import Labels, Questions, Sequences, Textsfrom ...models import Models, TokenDetectionfrom ..tensors import Tensors+# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()+class HFTrainer(Tensors):"""diff --git a/src/python/txtai/serialize/messagepack.py b/src/python/txtai/serialize/messagepack.pyindex 943c9d97..0d4a5897 100644--- a/src/python/txtai/serialize/messagepack.py+++ b/src/python/txtai/serialize/messagepack.py@@ -2,9 +2,15 @@MessagePack module"""-import msgpack-from msgpack import Unpacker-from msgpack.exceptions import ExtraData+# Conditional import+try:+ import msgpack+ from msgpack import Unpacker+ from msgpack.exceptions import ExtraData++ MSGPACK = True+except ImportError:+ MSGPACK = Falsefrom .base import Serializefrom .errors import SerializeError@@ -19,6 +25,9 @@ class MessagePack(Serialize):# Parent constructorsuper().__init__()+ if not MSGPACK:+ raise ImportError("MessagePack is not available - install to msgpack enable")+# Streaming unpackerself.streaming = streamingdiff --git a/src/python/txtai/util/__init__.py b/src/python/txtai/util/__init__.pyindex 4cbc088d..edccbf30 100644--- a/src/python/txtai/util/__init__.py+++ b/src/python/txtai/util/__init__.py@@ -5,3 +5,4 @@ Utility importsfrom .resolver import Resolverfrom .sparsearray import SparseArrayfrom .template import TemplateFormatter+from .torchlib import TorchLibdiff --git a/src/python/txtai/util/torchlib.py b/src/python/txtai/util/torchlib.pynew file mode 100644index 00000000..1135aecd--- /dev/null+++ b/src/python/txtai/util/torchlib.py@@ -0,0 +1,98 @@+"""+TorchLib module+"""+++# pylint: disable=C0415+class TorchLib:+ """+ Imports torch dependencies with fallbacks when the library is not installed.+ """++ def dataset(self):+ """+ Import torch.utils.data.Dataset.++ Returns:+ Dataset+ """++ try:+ from torch.utils.data import Dataset++ except ImportError:++ class Dataset:+ """+ Stub for Dataset+ """++ return Dataset++ def module(self):+ """+ Imports torch.nn.Module++ Returns:+ Module+ """++ try:+ import torch.nn++ # pylint: disable=C0103+ Module = torch.nn.Module++ except ImportError:++ class Module:+ """+ Stub for Module+ """++ return Module++ def pretrained(self):+ """+ Imports transformers.modeling_utils.PreTrainedModel.++ Returns:+ PreTrainedModel+ """++ try:+ from transformers.modeling_utils import PreTrainedModel++ except ImportError:++ class PreTrainedModel:+ """+ Stub for PreTrainedModel+ """++ return PreTrainedModel++ def torch(self):+ """+ Imports torch.++ Returns:+ torch+ """++ try:+ import torch++ except ImportError:++ class Torch:+ """+ Stub for torch+ """++ def __getattr__(self, name):+ raise ImportError("Torch is not installed, install torch to use this module")++ torch = Torch()++ return torchdiff --git a/src/python/txtai/workflow/execute.py b/src/python/txtai/workflow/execute.pyindex eecb7126..2c8b65df 100644--- a/src/python/txtai/workflow/execute.py+++ b/src/python/txtai/workflow/execute.py@@ -4,7 +4,10 @@ Execute modulefrom multiprocessing.pool import Pool, ThreadPool-import torch.multiprocessing+# Conditional torch imports+from ..util import TorchLib++torch = TorchLib().torch()class Execute:diff --git a/src/python/txtai/workflow/task/base.py b/src/python/txtai/workflow/task/base.pyindex 5ef41ef7..e212d6ee 100644--- a/src/python/txtai/workflow/task/base.py+++ b/src/python/txtai/workflow/task/base.py@@ -7,7 +7,11 @@ import reimport typesimport numpy as np-import torch++# Conditional torch imports+from ...util import TorchLib++torch = TorchLib().torch()# Logging configurationlogger = logging.getLogger(__name__)diff --git a/test/python/testoptional.py b/test/python/testoptional.pyindex 45d57f7b..062c2f85 100644--- a/test/python/testoptional.py+++ b/test/python/testoptional.py@@ -29,6 +29,7 @@ class TestOptional(unittest.TestCase):"croniter","docling.document_converter","duckdb",+ "faiss","fastapi","ggml","gliner",@@ -41,6 +42,7 @@ class TestOptional(unittest.TestCase):"litellm","llama_cpp","model2vec",+ "msgpack","networkx","nltk","onnxmltools",@@ -116,6 +118,9 @@ class TestOptional(unittest.TestCase):with self.assertRaises(ImportError):ANNFactory.create({"backend": "annoy"})+ with self.assertRaises(ImportError):+ ANNFactory.create({"backend": "faiss"})+with self.assertRaises(ImportError):ANNFactory.create({"backend": "ggml"})@@ -310,6 +315,16 @@ class TestOptional(unittest.TestCase):with self.assertRaises(ImportError):Translation().detect(["test"])+ def testSerialize(self):+ """+ Test missing msgpack dependency+ """++ from txtai.serialize import MessagePack++ with self.assertRaises(ImportError):+ MessagePack()+def testScoring(self):"""Test missing scoring dependenciesdiff --git a/test/python/testtorch.py b/test/python/testtorch.pynew file mode 100644index 00000000..3f8aa7b6--- /dev/null+++ b/test/python/testtorch.py@@ -0,0 +1,78 @@+"""+Torch module tests+"""++import sys+import unittest++# pylint: disable=C0415,W0611,W0621+import txtai+++class TestTorch(unittest.TestCase):+ """+ Simulates torch not being installed. Even though torch is a required dependency, txtai can operate without it gracefully.+ """++ @classmethod+ def setUpClass(cls):+ """+ Simulate torch not being installed+ """++ modules = [+ "transformers.modeling_utils",+ "transformers.modeling_outputs",+ "torch",+ "torch.nn",+ "torch.onnx",+ "torch.utils.data",+ ]++ # Get handle to all currently loaded txtai modules+ modules = modules + [key for key in sys.modules if key.startswith("txtai")]+ cls.modules = {module: None for module in modules}++ # Replace loaded modules with stubs. Save modules for later reloading+ for module in cls.modules:+ if module in sys.modules:+ cls.modules[module] = sys.modules[module]++ # Remove txtai modules. Set optional dependencies to None to prevent reloading.+ if "txtai" in module:+ if module in sys.modules:+ del sys.modules[module]+ else:+ sys.modules[module] = None++ @classmethod+ def tearDownClass(cls):+ """+ Resets modules environment back to initial state.+ """++ # Reset replaced modules in setup+ for key, value in cls.modules.items():+ if value:+ sys.modules[key] = value+ else:+ del sys.modules[key]++ def testTorch(self):+ """+ Test torch not installed+ """++ from txtai.util import TorchLib++ torchlib = TorchLib()++ # Test torch stubs+ self.assertTrue(torchlib.dataset().__module__.endswith("torchlib"))+ self.assertTrue(torchlib.module().__module__.endswith("torchlib"))+ self.assertTrue(torchlib.pretrained().__module__.endswith("torchlib"))+ self.assertTrue(torchlib.torch())++ # pylint: disable=W0106+ with self.assertRaises(ImportError):+ torchlib.torch().device