foldit-plugin-sdk 0.1.5

Foldit plugin SDK - owns plugin.proto, the protocol types, and the Plugin trait; exposes a cbindgen C-ABI and pyo3 Python bindings
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
62
63
64
65
66
67
68
69
70
71

"""Device detection utilities for foldit-runner.

Provides a consistent interface for detecting and selecting compute devices
(CPU, CUDA GPU, or Apple MPS) across all model plugins.
"""

import torch


def get_best_device(prefer_cpu=False, allow_mps=True):
    """Get the best available compute device.

    Args:
        prefer_cpu: If True, always return CPU regardless of GPU availability
        allow_mps: If True, allow MPS (Apple Silicon GPU) to be selected

    Returns:
        torch.device: The selected device (cuda, mps, or cpu)
    """
    if prefer_cpu:
        return torch.device("cpu")

    if torch.cuda.is_available():
        return torch.device("cuda")

    if allow_mps and torch.backends.mps.is_available():
        return torch.device("mps")

    return torch.device("cpu")


def get_device_info():
    """Get information about available compute devices.

    Returns:
        dict: Device availability information with keys:
            - cuda_available: bool
            - mps_available: bool
            - best_device: str (device name)
    """
    cuda_available = torch.cuda.is_available()
    mps_available = torch.backends.mps.is_available()

    if cuda_available:
        best = "cuda"
    elif mps_available:
        best = "mps"
    else:
        best = "cpu"

    return {
        "cuda_available": cuda_available,
        "mps_available": mps_available,
        "best_device": best,
    }


def log_device_info(logger):
    """Log information about available compute devices.

    Args:
        logger: Logger instance to use for output
    """
    info = get_device_info()

    if info["cuda_available"]:
        logger.info("CUDA GPU available")
    elif info["mps_available"]:
        logger.info("MPS (Apple GPU) available")
    else:
        logger.info("No GPU available - will use CPU")