modelexpress-client 0.7.0

Client library for Model Express gRPC server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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

# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

"""
Metadata client factory.

Selects the metadata client implementation from the
``MX_METADATA_BACKEND`` env var. The returned object duck-types
:class:`MxClient`, so callers (loaders, strategies) never need to
branch on backend.

Supported values:

- ``""`` / ``"server"`` / ``"redis"`` / ``"kubernetes"`` / ``"k8s"`` /
  ``"crd"`` - central ModelExpress server (default). Returns
  :class:`MxClient`.
- ``"k8s-service"`` / ``"service"`` - K8s-Service-routed decentralized
  backend. Returns :class:`MxK8sServiceClient`.
"""

from __future__ import annotations

import logging

from .. import envs
from ..client import MxClient, MxClientBase
from .k8s_service_client import MxK8sServiceClient

logger = logging.getLogger("modelexpress.metadata.client_factory")

_CENTRAL_BACKEND_ALIASES = frozenset({
    "", "server", "redis", "kubernetes", "k8s", "crd",
})
_K8S_SERVICE_ALIASES = frozenset({"k8s-service", "service"})


def create_metadata_client(
    worker_rank: int | None = None,
    server_url: str | None = None,
) -> MxClientBase:
    """Create the metadata client dictated by ``MX_METADATA_BACKEND``.

    ``worker_rank`` is only consumed by backends that resolve a rank-
    specific endpoint (currently :class:`MxK8sServiceClient`);
    others ignore it.
    """
    backend = envs.MX_METADATA_BACKEND
    if backend in _CENTRAL_BACKEND_ALIASES:
        logger.debug("create_metadata_client: central MxClient (backend=%r)", backend)
        return MxClient(server_url=server_url)
    if backend in _K8S_SERVICE_ALIASES:
        logger.info(
            "create_metadata_client: MxK8sServiceClient "
            "(backend=%r, worker_rank=%s)",
            backend, worker_rank,
        )
        return MxK8sServiceClient(worker_rank=worker_rank)
    raise ValueError(
        f"Unknown MX_METADATA_BACKEND value {backend!r}. "
        f"Supported: {sorted(_CENTRAL_BACKEND_ALIASES | _K8S_SERVICE_ALIASES)}"
    )