Rename profiler to profilers (Lightning-AI#12308)

Co-authored-by: Carlos Mocholí <[email protected]>
Co-authored-by: Akihiro Nitta <[email protected]>

examples/pl_basics/profiler_example.py

@@ -31,7 +31,7 @@
 import torchvision.transforms as T
 
 from pytorch_lightning import cli_lightning_logo, LightningDataModule, LightningModule
-from pytorch_lightning.profiler.pytorch import PyTorchProfiler
+from pytorch_lightning.profilers.pytorch import PyTorchProfiler
 from pytorch_lightning.utilities.cli import LightningCLI
 
 DEFAULT_CMD_LINE = (

src/pytorch_lightning/profiler/__init__.py → src/pytorch_lightning/profilers/__init__.py

@@ -11,12 +11,12 @@
 # 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.profiler.advanced import AdvancedProfiler
-from pytorch_lightning.profiler.base import AbstractProfiler, BaseProfiler, PassThroughProfiler
-from pytorch_lightning.profiler.profiler import Profiler
-from pytorch_lightning.profiler.pytorch import PyTorchProfiler
-from pytorch_lightning.profiler.simple import SimpleProfiler
-from pytorch_lightning.profiler.xla import XLAProfiler
+from pytorch_lightning.profilers.advanced import AdvancedProfiler
+from pytorch_lightning.profilers.base import AbstractProfiler, BaseProfiler, PassThroughProfiler
+from pytorch_lightning.profilers.profiler import Profiler
+from pytorch_lightning.profilers.pytorch import PyTorchProfiler
+from pytorch_lightning.profilers.simple import SimpleProfiler
+from pytorch_lightning.profilers.xla import XLAProfiler
 
 __all__ = [
     "AbstractProfiler",

src/pytorch_lightning/profiler/advanced.py → src/pytorch_lightning/profilers/advanced.py

@@ -19,7 +19,7 @@
 from pathlib import Path
 from typing import Dict, Optional, Union
 
-from pytorch_lightning.profiler.profiler import Profiler
+from pytorch_lightning.profilers.profiler import Profiler
 
 log = logging.getLogger(__name__)
 

src/pytorch_lightning/profiler/base.py → src/pytorch_lightning/profilers/base.py

@@ -15,7 +15,7 @@
 from abc import ABC, abstractmethod
 from typing import Any
 
-from pytorch_lightning.profiler.profiler import Profiler
+from pytorch_lightning.profilers.profiler import Profiler
 from pytorch_lightning.utilities.rank_zero import rank_zero_deprecation
 
 

src/pytorch_lightning/profiler/pytorch.py → src/pytorch_lightning/profilers/pytorch.py

@@ -23,7 +23,7 @@
 from torch import nn, Tensor
 from torch.autograd.profiler import record_function
 
-from pytorch_lightning.profiler.profiler import Profiler
+from pytorch_lightning.profilers.profiler import Profiler
 from pytorch_lightning.utilities.exceptions import MisconfigurationException
 from pytorch_lightning.utilities.imports import _KINETO_AVAILABLE
 from pytorch_lightning.utilities.rank_zero import rank_zero_warn

src/pytorch_lightning/profiler/simple.py → src/pytorch_lightning/profilers/simple.py

@@ -21,7 +21,7 @@
 
 import numpy as np
 
-from pytorch_lightning.profiler.profiler import Profiler
+from pytorch_lightning.profilers.profiler import Profiler
 
 log = logging.getLogger(__name__)
 

src/pytorch_lightning/profiler/xla.py → src/pytorch_lightning/profilers/xla.py

@@ -14,7 +14,7 @@
 import logging
 from typing import Dict
 
-from pytorch_lightning.profiler.profiler import Profiler
+from pytorch_lightning.profilers.profiler import Profiler
 from pytorch_lightning.utilities import _TPU_AVAILABLE
 from pytorch_lightning.utilities.exceptions import MisconfigurationException
 

src/pytorch_lightning/trainer/trainer.py

@@ -55,7 +55,7 @@
     PrecisionPlugin,
 )
 from pytorch_lightning.plugins.environments.slurm_environment import SLURMEnvironment
-from pytorch_lightning.profiler import (
+from pytorch_lightning.profilers import (
     AdvancedProfiler,
     PassThroughProfiler,
     Profiler,

tests/tests_pytorch/core/test_datamodules.py

@@ -24,7 +24,7 @@
 from pytorch_lightning import LightningDataModule, Trainer
 from pytorch_lightning.callbacks import ModelCheckpoint
 from pytorch_lightning.demos.boring_classes import BoringDataModule, BoringModel
-from pytorch_lightning.profiler.simple import SimpleProfiler
+from pytorch_lightning.profilers.simple import SimpleProfiler
 from pytorch_lightning.trainer.states import TrainerFn
 from pytorch_lightning.utilities import _OMEGACONF_AVAILABLE, AttributeDict
 from pytorch_lightning.utilities.exceptions import MisconfigurationException

tests/tests_pytorch/deprecated_api/test_remove_1-8.py

@@ -40,7 +40,7 @@
 from pytorch_lightning.plugins.training_type.single_device import SingleDevicePlugin
 from pytorch_lightning.plugins.training_type.single_tpu import SingleTPUPlugin
 from pytorch_lightning.plugins.training_type.tpu_spawn import TPUSpawnPlugin
-from pytorch_lightning.profiler import AbstractProfiler, AdvancedProfiler, BaseProfiler, Profiler, SimpleProfiler
+from pytorch_lightning.profilers import AbstractProfiler, AdvancedProfiler, BaseProfiler, Profiler, SimpleProfiler
 from pytorch_lightning.strategies import ParallelStrategy
 from pytorch_lightning.trainer.configuration_validator import _check_datamodule_checkpoint_hooks
 from pytorch_lightning.trainer.states import RunningStage

tests/tests_pytorch/profiler/test_profiler.py → tests/tests_pytorch/profilers/test_profiler.py

@@ -26,8 +26,8 @@
 from pytorch_lightning.callbacks import EarlyStopping, StochasticWeightAveraging
 from pytorch_lightning.demos.boring_classes import BoringModel, ManualOptimBoringModel
 from pytorch_lightning.loggers import CSVLogger, TensorBoardLogger
-from pytorch_lightning.profiler import AdvancedProfiler, PassThroughProfiler, PyTorchProfiler, SimpleProfiler
-from pytorch_lightning.profiler.pytorch import RegisterRecordFunction, warning_cache
+from pytorch_lightning.profilers import AdvancedProfiler, PassThroughProfiler, PyTorchProfiler, SimpleProfiler
+from pytorch_lightning.profilers.pytorch import RegisterRecordFunction, warning_cache
 from pytorch_lightning.utilities.exceptions import MisconfigurationException
 from pytorch_lightning.utilities.imports import _KINETO_AVAILABLE
 from tests_pytorch.helpers.runif import RunIf

tests/tests_pytorch/profiler/test_xla_profiler.py → tests/tests_pytorch/profilers/test_xla_profiler.py

@@ -18,7 +18,7 @@
 
 from pytorch_lightning import Trainer
 from pytorch_lightning.demos.boring_classes import BoringModel
-from pytorch_lightning.profiler import XLAProfiler
+from pytorch_lightning.profilers import XLAProfiler
 from pytorch_lightning.utilities import _TPU_AVAILABLE
 from tests_pytorch.helpers.runif import RunIf
 

tests/tests_pytorch/run_standalone_tests.sh

@@ -38,7 +38,7 @@ parametrizations=${parametrizations//"tests/tests_pytorch/"/}
 parametrizations_arr=($parametrizations)
 
 # tests to skip - space separated
-blocklist='profiler/test_profiler.py::test_pytorch_profiler_nested_emit_nvtx utilities/test_warnings.py'
+blocklist='profilers/test_profiler.py::test_pytorch_profiler_nested_emit_nvtx utilities/test_warnings.py'
 report=''
 
 for i in "${!parametrizations_arr[@]}"; do
@@ -58,7 +58,7 @@ for i in "${!parametrizations_arr[@]}"; do
 done
 
 if nvcc --version; then
-    nvprof --profile-from-start off -o trace_name.prof -- python ${defaults} profiler/test_profiler.py::test_pytorch_profiler_nested_emit_nvtx
+    nvprof --profile-from-start off -o trace_name.prof -- python ${defaults} profilers/test_profiler.py::test_pytorch_profiler_nested_emit_nvtx
 fi
 
 # needs to run outside of `pytest`

tests/tests_pytorch/utilities/test_cli.py

@@ -36,7 +36,7 @@
 from pytorch_lightning.demos.boring_classes import BoringDataModule, BoringModel
 from pytorch_lightning.loggers import _COMET_AVAILABLE, _NEPTUNE_AVAILABLE, _WANDB_AVAILABLE, TensorBoardLogger
 from pytorch_lightning.plugins.environments import SLURMEnvironment
-from pytorch_lightning.profiler import PyTorchProfiler
+from pytorch_lightning.profilers import PyTorchProfiler
 from pytorch_lightning.strategies import DDPStrategy
 from pytorch_lightning.trainer.states import TrainerFn
 from pytorch_lightning.utilities import _TPU_AVAILABLE

tests/tests_pytorch/utilities/test_fetching.py

@@ -22,7 +22,7 @@
 
 from pytorch_lightning import Callback, LightningDataModule, Trainer
 from pytorch_lightning.demos.boring_classes import BoringModel, RandomDataset
-from pytorch_lightning.profiler import SimpleProfiler
+from pytorch_lightning.profilers import SimpleProfiler
 from pytorch_lightning.trainer.supporters import CombinedLoader
 from pytorch_lightning.utilities.exceptions import MisconfigurationException
 from pytorch_lightning.utilities.fetching import DataFetcher, DataLoaderIterDataFetcher, InterBatchParallelDataFetcher