chore: FAISS - small changes to improve consistency with the codebase (#2890)

* chore: FAISS - small changes to improve consistency with the codebase

* fmt

Author: anakin87

integrations/faiss/README.md

@@ -1,17 +1,11 @@
 # faiss-haystack
 
-This package provides a [FAISS](https://github.com/facebookresearch/faiss) document store for [Haystack](https://github.com/deepset-ai/haystack).
+[![PyPI - Version](https://img.shields.io/pypi/v/faiss-haystack.svg)](https://pypi.org/project/faiss-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/faiss-haystack.svg)](https://pypi.org/project/faiss-haystack)
 
-## Installation
+- [Integration page](https://haystack.deepset.ai/integrations/faiss-documentstore)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/faiss/CHANGELOG.md)
 
-```bash
-pip install faiss-haystack
-```
+---
 
-## Usage
-
-```python
-from haystack_integrations.document_stores.faiss import FAISSDocumentStore
-
-document_store = FAISSDocumentStore(index_path="my_index")
-```
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

integrations/faiss/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "faiss-haystack"
 dynamic = ["version"]
-description = ''
+description = 'An integration of FAISS (library for efficient similarity search of dense vectors) with Haystack'
 readme = "README.md"
 requires-python = ">=3.10"
 license = "Apache-2.0"
@@ -48,7 +48,7 @@ installer = "uv"
 dependencies = ["haystack-pydoc-tools", "ruff"]
 
 [tool.hatch.envs.default.scripts]
-docs = ["pydoc-markdown pydoc/config_docusaurus.yml"]
+docs = ["haystack-pydoc pydoc/config_docusaurus.yml"]
 fmt = "ruff check --fix {args}; ruff format {args}"
 fmt-check = "ruff check {args} && ruff format --check {args}"
 
@@ -59,6 +59,7 @@ dependencies = [
     "pytest-rerunfailures",
     "mypy",
     "pandas",
+    "pip",    # needed for mypy to install type stubs
 ]
 
 [tool.hatch.envs.test.scripts]
@@ -75,8 +76,12 @@ non_interactive = true
 check_untyped_defs = true
 disallow_incomplete_defs = true
 
-[tool.hatch.metadata]
-allow-direct-references = true
+[[tool.mypy.overrides]]
+module = [
+  # faiss does not provide types
+  "faiss.*",
+]
+ignore_missing_imports = true
 
 [tool.ruff]
 line-length = 120
@@ -156,4 +161,5 @@ exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
+addopts = "--strict-markers"
 markers = ["integration: integration tests"]

integrations/faiss/src/haystack_integrations/__init__.py

@@ -9,14 +9,15 @@
 from pathlib import Path
 from typing import Any
 
-import faiss  # type: ignore[import-untyped]
 import numpy as np
 from haystack import default_from_dict, default_to_dict
 from haystack.dataclasses import Document
 from haystack.document_stores.errors import DocumentStoreError, DuplicateDocumentError
 from haystack.document_stores.types import DuplicatePolicy
 from haystack.errors import FilterError
 
+import faiss
+
 logger = logging.getLogger(__name__)