Search for OTB (set env if necessary), subclass core.App for each available application.

OTBTFApp

Bases: App

Helper for OTBTF to ensure the nb_sources variable is set.

Source code in pyotb/apps.py 
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
class OTBTFApp(App):
    """Helper for OTBTF to ensure the nb_sources variable is set."""

    @staticmethod
    def set_nb_sources(*args, n_sources: int = None):
        """Set the number of sources of TensorflowModelServe. Can be either user-defined or deduced from the args.

        Args:
            *args: arguments (dict). NB: we don't need kwargs because it cannot contain source#.il
            n_sources: number of sources. Default is None (resolves the number of sources based on the
                       content of the dict passed in args, where some 'source' str is found)

        """
        if n_sources:
            os.environ["OTB_TF_NSOURCES"] = str(int(n_sources))
        else:
            # Retrieving the number of `source#.il` parameters
            params_dic = {
                k: v for arg in args if isinstance(arg, dict) for k, v in arg.items()
            }
            n_sources = len(
                [k for k in params_dic if "source" in k and k.endswith(".il")]
            )
            if n_sources >= 1:
                os.environ["OTB_TF_NSOURCES"] = str(n_sources)

    def __init__(self, name: str, *args, n_sources: int = None, **kwargs):
        """Constructor for an OTBTFApp object.

        Args:
            name: name of the OTBTF app
            n_sources: number of sources. Default is None (resolves the number of sources based on the
                       content of the dict passed in args, where some 'source' str is found)

        """
        self.set_nb_sources(*args, n_sources=n_sources)
        super().__init__(name, *args, **kwargs)

__init__(name, *args, n_sources=None, **kwargs)

Constructor for an OTBTFApp object.

Parameters:
  • name (str) –

    name of the OTBTF app

  • n_sources (int, default: None ) –

    number of sources. Default is None (resolves the number of sources based on the content of the dict passed in args, where some 'source' str is found)
Source code in pyotb/apps.py 
58
59
60
61
62
63
64
65
66
67
68
def __init__(self, name: str, *args, n_sources: int = None, **kwargs):
    """Constructor for an OTBTFApp object.

    Args:
        name: name of the OTBTF app
        n_sources: number of sources. Default is None (resolves the number of sources based on the
                   content of the dict passed in args, where some 'source' str is found)

    """
    self.set_nb_sources(*args, n_sources=n_sources)
    super().__init__(name, *args, **kwargs)

set_nb_sources(*args, n_sources=None) staticmethod

Set the number of sources of TensorflowModelServe. Can be either user-defined or deduced from the args.

Parameters:
  • *args –

    arguments (dict). NB: we don't need kwargs because it cannot contain source#.il

  • n_sources (int, default: None ) –

    number of sources. Default is None (resolves the number of sources based on the content of the dict passed in args, where some 'source' str is found)
Source code in pyotb/apps.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@staticmethod
def set_nb_sources(*args, n_sources: int = None):
    """Set the number of sources of TensorflowModelServe. Can be either user-defined or deduced from the args.

    Args:
        *args: arguments (dict). NB: we don't need kwargs because it cannot contain source#.il
        n_sources: number of sources. Default is None (resolves the number of sources based on the
                   content of the dict passed in args, where some 'source' str is found)

    """
    if n_sources:
        os.environ["OTB_TF_NSOURCES"] = str(int(n_sources))
    else:
        # Retrieving the number of `source#.il` parameters
        params_dic = {
            k: v for arg in args if isinstance(arg, dict) for k, v in arg.items()
        }
        n_sources = len(
            [k for k in params_dic if "source" in k and k.endswith(".il")]
        )
        if n_sources >= 1:
            os.environ["OTB_TF_NSOURCES"] = str(n_sources)

get_available_applications()

Find available OTB applications.

Returns:
  • tuple[str] –

    tuple of available applications
Raises:
  • SystemExit –

    if no application is found
Source code in pyotb/apps.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def get_available_applications() -> tuple[str]:
    """Find available OTB applications.

    Returns:
        tuple of available applications

    Raises:
        SystemExit: if no application is found

    """
    app_list = otb.Registry.GetAvailableApplications()
    if app_list:
        logger.info("Successfully loaded %s OTB applications", len(app_list))
        return app_list
    raise SystemExit(
        "Unable to load applications. Set env variable OTB_APPLICATION_PATH and try again."
    )