Skip to content

pixano_inference.utils.package

Utility functions for working with Python packages.

assert_lance_installed()

Assert that the lance package is installed.

Source code in pixano_inference/utils/package.py 
85
86
87
88
89
def assert_lance_installed() -> None:
    """Assert that the lance package is installed."""
    assert_package_installed(
        "lance", "lance is not installed. Please install it using 'pip install pixano-inference[data]'."
    )

assert_package_installed(package_name, error_message=None)

Assert that a Python package is installed.

Parameters:

Name Type Description Default
package_name str

The name of the package to check.

 required
error_message str | None

The error message to raise if the package is not installed.

 None

Raises:

Type Description
ImportError

If the package is not installed
Source code in pixano_inference/utils/package.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
def assert_package_installed(package_name: str, error_message: str | None = None) -> None:
    """Assert that a Python package is installed.

    Args:
        package_name: The name of the package to check.
        error_message: The error message to raise if the package is not installed.

    Raises:
        ImportError: If the package is not installed
    """
    if not is_package_installed(package_name):
        message = error_message or f"Package '{package_name}' is not installed."
        raise ImportError(message)

assert_sam2_installed()

Assert that the sam2 package is installed.

Source code in pixano_inference/utils/package.py 
92
93
94
95
96
97
def assert_sam2_installed() -> None:
    """Assert that the sam2 package is installed."""
    assert_package_installed(
        "sam2",
        "sam2 is not installed. Please install it using 'pip install git+https://github.com/facebookresearch/sam2.git'.",
    )

assert_torch_installed()

Assert that the torch package is installed.

Source code in pixano_inference/utils/package.py 
108
109
110
111
112
def assert_torch_installed() -> None:
    """Assert that the torch package is installed."""
    assert_package_installed(
        "torch", "torch is not installed. Please install it using 'pip install pixano-inference[torch]'."
    )

assert_transformers_installed()

Assert that the transformers package is installed.

Source code in pixano_inference/utils/package.py 
100
101
102
103
104
105
def assert_transformers_installed() -> None:
    """Assert that the transformers package is installed."""
    assert_package_installed(
        "transformers",
        "transformers is not installed. Please install it using 'pip install pixano-inference[transformers]'.",
    )

assert_vllm_installed()

Assert that the vllm package is installed.

Source code in pixano_inference/utils/package.py 
115
116
117
118
119
def assert_vllm_installed() -> None:
    """Assert that the vllm package is installed."""
    assert_package_installed(
        "vllm", "vLLM is not installed. Please install it using 'pip install pixano-inference[vllm]'."
    )

is_lance_installed()

Check if the lance package is installed.

Returns:

Type Description
bool

True if the lance package is installed, False otherwise
Source code in pixano_inference/utils/package.py 
25
26
27
28
29
30
31
def is_lance_installed() -> bool:
    """Check if the lance package is installed.

    Returns:
        True if the lance package is installed, False otherwise
    """
    return is_package_installed("lance")

is_package_installed(package_name)

Check if a Python package is installed.

Parameters:

Name Type Description Default
package_name str

The name of the package to check.

 required

Returns:

Type Description
bool

True if the package is installed, False otherwise
Source code in pixano_inference/utils/package.py 
12
13
14
15
16
17
18
19
20
21
22
def is_package_installed(package_name: str) -> bool:
    """Check if a Python package is installed.

    Args:
        package_name: The name of the package to check.

    Returns:
        True if the package is installed, False otherwise
    """
    package_spec = importlib.util.find_spec(package_name)
    return package_spec is not None

is_sam2_installed()

Check if the sam2 package is installed.

Returns:

Type Description
bool

True if the sam2 package is installed, False otherwise
Source code in pixano_inference/utils/package.py 
34
35
36
37
38
39
40
def is_sam2_installed() -> bool:
    """Check if the sam2 package is installed.

    Returns:
        True if the sam2 package is installed, False otherwise
    """
    return is_package_installed("sam2")

is_torch_installed()

Check if the torch package is installed.

Returns:

Type Description
bool

True if the torch package is installed, False otherwise
Source code in pixano_inference/utils/package.py 
43
44
45
46
47
48
49
def is_torch_installed() -> bool:
    """Check if the torch package is installed.

    Returns:
        True if the torch package is installed, False otherwise
    """
    return is_package_installed("torch")

is_transformers_installed()

Check if the transformers package is installed.

Returns:

Type Description
bool

True if the transformers package is installed, False otherwise
Source code in pixano_inference/utils/package.py 
52
53
54
55
56
57
58
def is_transformers_installed() -> bool:
    """Check if the transformers package is installed.

    Returns:
        True if the transformers package is installed, False otherwise
    """
    return is_package_installed("transformers")

is_vllm_installed()

Check if the vllm package is installed.

Returns:

Type Description
bool

True if the vLLM package is installed, False otherwise
Source code in pixano_inference/utils/package.py 
61
62
63
64
65
66
67
def is_vllm_installed() -> bool:
    """Check if the vllm package is installed.

    Returns:
        True if the vLLM package is installed, False otherwise
    """
    return is_package_installed("vllm")