Skip to content

Base Bridges Module

Base Bridge

BaseBridgeMixin

Bases: BaseModel

Base Bridge Class.

Source code in src/fed_rag/base/bridge.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class BaseBridgeMixin(BaseModel):
    """Base Bridge Class."""

    # Version of the bridge implementaiton
    _bridge_version: ClassVar[str]
    _bridge_extra: ClassVar[Optional[str | None]]
    _framework: ClassVar[str]
    _compatible_versions: ClassVar[list[str]]
    _method_name: ClassVar[str]

    model_config = ConfigDict(arbitrary_types_allowed=True)

    def __init_subclass__(cls, **kwargs: Any):
        """Register bridge into ~RAGSystem bridge registry."""
        super().__init_subclass__(**kwargs)

        # Register this bridge's metadata to the parent RAGSystem
        for base in cls.__mro__:
            if base.__name__ == "_RAGSystem" and hasattr(
                base, "_register_bridge"
            ):
                metadata = cls.get_bridge_metadata()

                # validate method exists
                if not hasattr(cls, metadata["method_name"]):
                    raise MissingSpecifiedConversionMethod(
                        f"Bridge mixin for `{metadata['framework']}` is missing conversion method `{metadata['method_name']}`."
                    )
                base._register_bridge(metadata)
                break

    @classmethod
    def get_bridge_metadata(cls) -> BridgeMetadata:
        metadata: BridgeMetadata = {
            "bridge_version": cls._bridge_version,
            "framework": cls._framework,
            "compatible_versions": cls._compatible_versions,
            "method_name": cls._method_name,
        }
        return metadata

    @classmethod
    def _validate_framework_installed(cls) -> None:
        if importlib.util.find_spec(cls._framework.replace("-", "_")) is None:
            missing_package_or_extra = (
                f"fed-rag[{cls._bridge_extra}]"
                if cls._bridge_extra
                else cls._framework
            )
            msg = (
                f"`{cls._framework}` module is missing but needs to be installed. "
                f"To fix please run `pip install {missing_package_or_extra}`."
            )
            raise MissingExtraError(msg)

__init_subclass__ 

__init_subclass__(**kwargs)

Register bridge into ~RAGSystem bridge registry.

Source code in src/fed_rag/base/bridge.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def __init_subclass__(cls, **kwargs: Any):
    """Register bridge into ~RAGSystem bridge registry."""
    super().__init_subclass__(**kwargs)

    # Register this bridge's metadata to the parent RAGSystem
    for base in cls.__mro__:
        if base.__name__ == "_RAGSystem" and hasattr(
            base, "_register_bridge"
        ):
            metadata = cls.get_bridge_metadata()

            # validate method exists
            if not hasattr(cls, metadata["method_name"]):
                raise MissingSpecifiedConversionMethod(
                    f"Bridge mixin for `{metadata['framework']}` is missing conversion method `{metadata['method_name']}`."
                )
            base._register_bridge(metadata)
            break