lightning/pytorch_lightning/trainer/deprecated_api.py

155 lines
6.4 KiB
Python

# 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.accelerators import Accelerator
from pytorch_lightning.core.lightning import LightningModule
from pytorch_lightning.trainer.connectors.accelerator_connector import AcceleratorConnector
from pytorch_lightning.utilities import DeviceType, DistributedType, rank_zero_deprecation
class DeprecatedDistDeviceAttributes:
num_gpus: int
accelerator_connector: AcceleratorConnector
@property
def on_cpu(self) -> bool:
rank_zero_deprecation("Internal: `on_cpu` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._device_type == DeviceType.CPU
@on_cpu.setter
def on_cpu(self, val: bool) -> None:
rank_zero_deprecation("Internal: `on_cpu` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._device_type = DeviceType.CPU
@property
def on_tpu(self) -> bool:
rank_zero_deprecation("Internal: `on_tpu` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._device_type == DeviceType.TPU
@on_tpu.setter
def on_tpu(self, val: bool) -> None:
rank_zero_deprecation("Internal: `on_tpu` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._device_type = DeviceType.TPU
@property
def use_tpu(self) -> bool:
rank_zero_deprecation("Internal: `use_tpu` is deprecated in v1.2 and will be removed in v1.4.")
return self.on_tpu
@use_tpu.setter
def use_tpu(self, val: bool) -> None:
rank_zero_deprecation("Internal: `use_tpu` is deprecated in v1.2 and will be removed in v1.4.")
self.on_tpu = val
@property
def on_gpu(self) -> bool:
rank_zero_deprecation("Internal: `on_gpu` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._device_type == DeviceType.GPU
@on_gpu.setter
def on_gpu(self, val: bool) -> None:
rank_zero_deprecation("Internal: `on_gpu` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._device_type = DeviceType.GPU
@property
def use_dp(self) -> bool:
rank_zero_deprecation("Internal: `use_dp` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._distrib_type == DistributedType.DP
@use_dp.setter
def use_dp(self, val: bool) -> None:
rank_zero_deprecation("Internal: `use_dp` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._distrib_type = DistributedType.DP
@property
def use_ddp(self) -> bool:
rank_zero_deprecation("Internal: `use_ddp` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._distrib_type in (DistributedType.DDP, DistributedType.DDP_SPAWN)
@use_ddp.setter
def use_ddp(self, val: bool) -> None:
rank_zero_deprecation("Internal: `use_ddp` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._distrib_type = DistributedType.DDP
@property
def use_ddp2(self) -> bool:
rank_zero_deprecation("Internal: `use_ddp2` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._distrib_type == DistributedType.DDP2
@use_ddp2.setter
def use_ddp2(self, val: bool) -> None:
rank_zero_deprecation("Internal: `use_ddp2` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._distrib_type = DistributedType.DDP2
@property
def use_horovod(self) -> bool:
rank_zero_deprecation("Internal: `use_horovod` is deprecated in v1.2 and will be removed in v1.4.")
return self.accelerator_connector._distrib_type == DistributedType.HOROVOD
@use_horovod.setter
def use_horovod(self, val: bool) -> None:
rank_zero_deprecation("Internal: `use_horovod` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._distrib_type = DistributedType.HOROVOD
@property
def use_single_gpu(self) -> bool:
rank_zero_deprecation("Internal: `use_single_gpu` is deprecated in v1.2 and will be removed in v1.4.")
# todo, limiting to exclude DDP2 is not clear but it comes from connectors...
return (
self.accelerator_connector._device_type and self.accelerator_connector._device_type == DeviceType.GPU
and self.num_gpus == 1 and self.accelerator_connector._distrib_type not in (DistributedType.DDP2, )
)
@use_single_gpu.setter
def use_single_gpu(self, val: bool) -> None:
rank_zero_deprecation("Internal: `use_single_gpu` is deprecated in v1.2 and will be removed in v1.4.")
if val:
self.accelerator_connector._device_type = DeviceType.GPU
class DeprecatedTrainerAttributes:
accelerator: Accelerator
lightning_module: LightningModule
sanity_checking: bool
@property
def accelerator_backend(self) -> Accelerator:
rank_zero_deprecation(
"The `Trainer.accelerator_backend` attribute is deprecated in favor of `Trainer.accelerator`"
" since 1.2 and will be removed in v1.4."
)
return self.accelerator
def get_model(self) -> LightningModule:
rank_zero_deprecation(
"The use of `Trainer.get_model()` is deprecated in favor of `Trainer.lightning_module`"
" and will be removed in v1.4."
)
return self.lightning_module
@property
def running_sanity_check(self) -> bool:
rank_zero_deprecation(
"`Trainer.running_sanity_check` has been renamed to `Trainer.sanity_checking` and will be removed in v1.5."
)
return self.sanity_checking