lightning/tests/tests_pytorch/accelerators/test_registry.py

# Copyright The PyTorch Lightning team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from pytorch_lightning import Trainer
from pytorch_lightning.accelerators import Accelerator, AcceleratorRegistry


def test_accelerator_registry_with_new_accelerator():

    accelerator_name = "custom_accelerator"
    accelerator_description = "Custom Accelerator"

    class CustomAccelerator(Accelerator):
        def __init__(self, param1, param2):
            self.param1 = param1
            self.param2 = param2
            super().__init__()

        @staticmethod
        def parse_devices(devices):
            return devices

        @staticmethod
        def get_parallel_devices(devices):
            return ["foo"] * devices

        @staticmethod
        def auto_device_count():
            return 3

        @staticmethod
        def is_available():
            return True

    AcceleratorRegistry.register(
        accelerator_name, CustomAccelerator, description=accelerator_description, param1="abc", param2=123
    )

    assert accelerator_name in AcceleratorRegistry

    assert AcceleratorRegistry[accelerator_name]["description"] == accelerator_description
    assert AcceleratorRegistry[accelerator_name]["init_params"] == {"param1": "abc", "param2": 123}
    assert AcceleratorRegistry[accelerator_name]["accelerator_name"] == accelerator_name

    assert isinstance(AcceleratorRegistry.get(accelerator_name), CustomAccelerator)

    trainer = Trainer(accelerator=accelerator_name, devices="auto")
    assert isinstance(trainer.accelerator, CustomAccelerator)
    assert trainer.strategy.parallel_devices == ["foo"] * 3

    AcceleratorRegistry.remove(accelerator_name)
    assert accelerator_name not in AcceleratorRegistry


def test_available_accelerators_in_registry():
    assert AcceleratorRegistry.available_accelerators() == ["cpu", "cuda", "hpu", "ipu", "mps", "tpu"]