ci: Check import formatting with isort

.github/workflows/code-format.yml

@@ -15,14 +15,26 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.7
-
       - name: Install dependencies
         run: |
-          # python -m pip install --upgrade --user pip
           pip install flake8
           pip --version
         shell: bash
-
       - name: PEP8
         run: |
           flake8 .
+
+  imports-check-isort:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install isort
+        run: |
+          pip install isort==5.6.4
+          pip --version
+      - name: isort
+        run: |
+          isort . --check --diff

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 5.5.2
+    hooks:
+      - id: isort

docs/source/conf.py

@@ -12,14 +12,14 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-import os
-import sys
+# import m2r
+import builtins
 import glob
-import shutil
 import inspect
+import os
 import re
-# import m2r
-import builtins
+import shutil
+import sys
 
 import pt_lightning_sphinx_theme
 from sphinx.ext import apidoc

pl_bolts/__init__.py

@@ -45,7 +45,7 @@
 else:
 
     # from pl_bolts.models.mnist_module import LitMNIST
-    from pl_bolts import models, metrics, callbacks, datamodules, transforms, datasets
+    from pl_bolts import callbacks, datamodules, datasets, metrics, models, transforms
 
     __all__ = [
         # 'LitMNIST',

pl_bolts/callbacks/data_monitor.py

@@ -1,12 +1,10 @@
-from typing import Any, Sequence, Dict
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Sequence, Union
 
 import numpy as np
 import torch
 import torch.nn as nn
-from pytorch_lightning import Callback
-from pytorch_lightning import LightningModule, Trainer
-from pytorch_lightning.loggers import WandbLogger, TensorBoardLogger
+from pytorch_lightning import Callback, LightningModule, Trainer
+from pytorch_lightning.loggers import TensorBoardLogger, WandbLogger
 from pytorch_lightning.utilities import rank_zero_warn
 from pytorch_lightning.utilities.apply_func import apply_to_collection
 from torch import Tensor

pl_bolts/callbacks/printing.py

@@ -1,6 +1,6 @@
 import copy
 from itertools import zip_longest
-from typing import List, Any, Dict, Callable, Optional
+from typing import Any, Callable, Dict, List, Optional
 
 from pytorch_lightning.callbacks import Callback
 from pytorch_lightning.utilities import rank_zero_info

pl_bolts/datamodules/__init__.py

@@ -10,20 +10,17 @@
     __all__ += ['BinaryMNISTDataModule']
 
 try:
-    from pl_bolts.datamodules.cifar10_datamodule import (
-        CIFAR10DataModule,
-        TinyCIFAR10DataModule,
-    )
+    from pl_bolts.datamodules.cifar10_datamodule import CIFAR10DataModule, TinyCIFAR10DataModule
 except ModuleNotFoundError:
     pass
 else:
     __all__ += ['CIFAR10DataModule', 'TinyCIFAR10DataModule']
 
 try:
     from pl_bolts.datamodules.experience_source import (
-        ExperienceSourceDataset,
-        ExperienceSource,
         DiscountedExperienceSource,
+        ExperienceSource,
+        ExperienceSourceDataset,
     )
 except ModuleNotFoundError:
     pass
@@ -52,11 +49,7 @@
     __all__ += ['MNISTDataModule']
 
 try:
-    from pl_bolts.datamodules.sklearn_datamodule import (
-        SklearnDataset,
-        SklearnDataModule,
-        TensorDataset,
-    )
+    from pl_bolts.datamodules.sklearn_datamodule import SklearnDataModule, SklearnDataset, TensorDataset
 except ModuleNotFoundError:
     pass
 else:

pl_bolts/datamodules/binary_mnist_datamodule.py

@@ -7,6 +7,7 @@
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import MNIST
+
     from pl_bolts.datasets.mnist_dataset import BinaryMNIST
 except ModuleNotFoundError:
     warn_missing_pkg('torchvision')  # pragma: no-cover

pl_bolts/datamodules/experience_source.py

@@ -4,7 +4,7 @@
 """
 from abc import ABC
 from collections import deque, namedtuple
-from typing import Iterable, Callable, Tuple, List
+from typing import Callable, Iterable, List, Tuple
 
 import torch
 from gym import Env

pl_bolts/datamodules/sklearn_datamodule.py

@@ -4,7 +4,7 @@
 import numpy as np
 import torch
 from pytorch_lightning import LightningDataModule
-from torch.utils.data import Dataset, DataLoader
+from torch.utils.data import DataLoader, Dataset
 
 try:
     from sklearn.utils import shuffle as sk_shuffle

pl_bolts/datasets/__init__.py

@@ -1,9 +1,9 @@
 from pl_bolts.datasets.dummy_dataset import (
-    RandomDictStringDataset,
-    RandomDictDataset,
-    RandomDataset,
     DummyDataset,
-    DummyDetectionDataset
+    DummyDetectionDataset,
+    RandomDataset,
+    RandomDictDataset,
+    RandomDictStringDataset,
 )
 
 __all__ = [

pl_bolts/datasets/base_dataset.py

@@ -2,7 +2,7 @@
 import os
 import urllib.request
 from abc import ABC
-from typing import Tuple, Sequence
+from typing import Sequence, Tuple
 from urllib.error import HTTPError
 
 import torch

pl_bolts/datasets/cifar10_dataset.py

@@ -1,7 +1,7 @@
 import os
 import pickle
 import tarfile
-from typing import Tuple, Optional, Sequence, Callable
+from typing import Callable, Optional, Sequence, Tuple
 
 import torch
 from torch import Tensor

pl_bolts/datasets/dummy_dataset.py

@@ -1,5 +1,5 @@
 import torch
-from torch.utils.data import Dataset, DataLoader
+from torch.utils.data import DataLoader, Dataset
 
 
 class DummyDataset(Dataset):

pl_bolts/losses/rl.py

@@ -2,7 +2,7 @@
 Loss functions for the RL models
 """
 
-from typing import Tuple, List
+from typing import List, Tuple
 
 import numpy as np
 import torch

pl_bolts/metrics/__init__.py

@@ -1 +1 @@
-from pl_bolts.metrics.aggregation import mean, accuracy, precision_at_k
+from pl_bolts.metrics.aggregation import accuracy, mean, precision_at_k

pl_bolts/models/__init__.py

@@ -6,7 +6,5 @@
 from pl_bolts.models.autoencoders.basic_vae.basic_vae_module import VAE
 from pl_bolts.models.mnist_module import LitMNIST
 from pl_bolts.models.regression import LinearRegression, LogisticRegression
-from pl_bolts.models.vision import PixelCNN
-from pl_bolts.models.vision import SemSegment
-from pl_bolts.models.vision import UNet
+from pl_bolts.models.vision import PixelCNN, SemSegment, UNet
 from pl_bolts.models.vision.image_gpt.igpt_module import GPT2, ImageGPT

pl_bolts/models/autoencoders/__init__.py

@@ -5,6 +5,9 @@
 
 from pl_bolts.models.autoencoders.basic_ae.basic_ae_module import AE
 from pl_bolts.models.autoencoders.basic_vae.basic_vae_module import VAE
-
-from pl_bolts.models.autoencoders.components import resnet18_encoder, resnet18_decoder
-from pl_bolts.models.autoencoders.components import resnet50_encoder, resnet50_decoder
+from pl_bolts.models.autoencoders.components import (
+    resnet18_decoder,
+    resnet18_encoder,
+    resnet50_decoder,
+    resnet50_encoder,
+)

pl_bolts/models/autoencoders/basic_ae/basic_ae_module.py

@@ -5,8 +5,12 @@
 import torch.nn as nn
 from torch.nn import functional as F
 
-from pl_bolts.models.autoencoders.components import resnet18_encoder, resnet18_decoder
-from pl_bolts.models.autoencoders.components import resnet50_encoder, resnet50_decoder
+from pl_bolts.models.autoencoders.components import (
+    resnet18_decoder,
+    resnet18_encoder,
+    resnet50_decoder,
+    resnet50_encoder,
+)
 
 
 class AE(pl.LightningModule):

pl_bolts/models/autoencoders/basic_vae/basic_vae_module.py

@@ -5,8 +5,12 @@
 import torch.nn as nn
 from torch.nn import functional as F
 
-from pl_bolts.models.autoencoders.components import resnet18_encoder, resnet18_decoder
-from pl_bolts.models.autoencoders.components import resnet50_encoder, resnet50_decoder
+from pl_bolts.models.autoencoders.components import (
+    resnet18_decoder,
+    resnet18_encoder,
+    resnet50_decoder,
+    resnet50_encoder,
+)
 
 
 class VAE(pl.LightningModule):

pl_bolts/models/gans/basic/basic_gan_module.py

@@ -4,7 +4,7 @@
 import torch
 from torch.nn import functional as F
 
-from pl_bolts.models.gans.basic.components import Generator, Discriminator
+from pl_bolts.models.gans.basic.components import Discriminator, Generator
 
 
 class GAN(pl.LightningModule):

pl_bolts/models/rl/common/memory.py

@@ -3,7 +3,7 @@
 # Named tuple for storing experience steps gathered in training
 import collections
 from collections import deque, namedtuple
-from typing import Tuple, List, Union
+from typing import List, Tuple, Union
 
 import numpy as np
 

pl_bolts/models/rl/common/networks.py

@@ -6,8 +6,7 @@
 
 import numpy as np
 import torch
-from torch import Tensor
-from torch import nn
+from torch import Tensor, nn
 from torch.nn import functional as F
 
 

pl_bolts/models/rl/dqn_model.py

@@ -4,7 +4,7 @@
 
 import argparse
 from collections import OrderedDict
-from typing import Tuple, List, Dict, Optional
+from typing import Dict, List, Optional, Tuple
 
 import numpy as np
 import pytorch_lightning as pl
@@ -15,7 +15,7 @@
 from torch.optim.optimizer import Optimizer
 from torch.utils.data import DataLoader
 
-from pl_bolts.datamodules.experience_source import ExperienceSourceDataset, Experience
+from pl_bolts.datamodules.experience_source import Experience, ExperienceSourceDataset
 from pl_bolts.losses.rl import dqn_loss
 from pl_bolts.models.rl.common.agents import ValueAgent
 from pl_bolts.models.rl.common.memory import MultiStepBuffer

pl_bolts/models/rl/per_dqn_model.py

@@ -12,7 +12,7 @@
 
 from pl_bolts.datamodules import ExperienceSourceDataset
 from pl_bolts.losses.rl import per_dqn_loss
-from pl_bolts.models.rl.common.memory import PERBuffer, Experience
+from pl_bolts.models.rl.common.memory import Experience, PERBuffer
 from pl_bolts.models.rl.dqn_model import DQN
 
 

pl_bolts/models/rl/reinforce_model.py

@@ -1,6 +1,6 @@
 import argparse
 from collections import OrderedDict
-from typing import Tuple, List
+from typing import List, Tuple
 
 import numpy as np
 import pytorch_lightning as pl

pl_bolts/models/rl/vanilla_policy_gradient_model.py

@@ -1,6 +1,6 @@
 import argparse
 from collections import OrderedDict
-from typing import Tuple, List
+from typing import List, Tuple
 
 import numpy as np
 import pytorch_lightning as pl

pl_bolts/models/self_supervised/amdim/__init__.py

@@ -1,13 +1,14 @@
 from pl_bolts.models.self_supervised.amdim.amdim_module import AMDIM
 from pl_bolts.models.self_supervised.amdim.networks import AMDIMEncoder
+
 try:
     from pl_bolts.models.self_supervised.amdim.transforms import (
         AMDIMEvalTransformsCIFAR10,
-        AMDIMTrainTransformsCIFAR10,
-        AMDIMTrainTransformsSTL10,
+        AMDIMEvalTransformsImageNet128,
         AMDIMEvalTransformsSTL10,
+        AMDIMTrainTransformsCIFAR10,
         AMDIMTrainTransformsImageNet128,
-        AMDIMEvalTransformsImageNet128,
+        AMDIMTrainTransformsSTL10,
     )
 except ModuleNotFoundError:
     pass

pl_bolts/models/self_supervised/amdim/datasets.py

@@ -6,6 +6,7 @@
 
 try:
     from torchvision.datasets import STL10
+
     from pl_bolts.datasets.imagenet_dataset import UnlabeledImagenet
     from pl_bolts.datasets.ssl_amdim_datasets import CIFAR10Mixed
     from pl_bolts.models.self_supervised.amdim import transforms as amdim_transforms

pl_bolts/models/self_supervised/byol/byol_module.py

@@ -177,8 +177,8 @@ def add_model_specific_args(parent_parser):
 
 def cli_main():
     from pl_bolts.callbacks.ssl_online import SSLOnlineEvaluator
-    from pl_bolts.datamodules import CIFAR10DataModule, STL10DataModule, ImagenetDataModule
-    from pl_bolts.models.self_supervised.simclr import SimCLRTrainDataTransform, SimCLREvalDataTransform
+    from pl_bolts.datamodules import CIFAR10DataModule, ImagenetDataModule, STL10DataModule
+    from pl_bolts.models.self_supervised.simclr import SimCLREvalDataTransform, SimCLRTrainDataTransform
 
     seed_everything(1234)
 

pl_bolts/models/self_supervised/cpc/__init__.py

@@ -1,10 +1,10 @@
 from pl_bolts.models.self_supervised.cpc.cpc_module import CPCV2
-from pl_bolts.models.self_supervised.cpc.networks import cpc_resnet101, cpc_resnet50
+from pl_bolts.models.self_supervised.cpc.networks import cpc_resnet50, cpc_resnet101
 from pl_bolts.models.self_supervised.cpc.transforms import (
-    CPCTrainTransformsCIFAR10,
     CPCEvalTransformsCIFAR10,
-    CPCTrainTransformsSTL10,
+    CPCEvalTransformsImageNet128,
     CPCEvalTransformsSTL10,
+    CPCTrainTransformsCIFAR10,
     CPCTrainTransformsImageNet128,
-    CPCEvalTransformsImageNet128
+    CPCTrainTransformsSTL10,
 )

pl_bolts/models/self_supervised/cpc/cpc_finetuner.py

@@ -6,9 +6,9 @@
 from pl_bolts.models.self_supervised import CPCV2, SSLFineTuner
 from pl_bolts.models.self_supervised.cpc.transforms import (
     CPCEvalTransformsCIFAR10,
+    CPCEvalTransformsSTL10,
     CPCTrainTransformsCIFAR10,
     CPCTrainTransformsSTL10,
-    CPCEvalTransformsSTL10,
 )