Fixed docstring in colossalai (#171)

colossalai/nn/lr_scheduler/multistep.py

@@ -12,15 +12,16 @@ class MultiStepLR(_MultiStepLR):
     number of epoch reaches one of the milestones. Notice that such decay can
     happen simultaneously with other changes to the learning rate from outside
     this scheduler. When last_epoch=-1, sets initial lr as lr.
+
     :param optimizer: Wrapped optimizer
     :type optimizer: torch.optim.Optimizer
-    :param total_steps: number of total training steps
+    :param total_steps: Number of total training steps
     :type total_steps: int
     :param milestones: List of epoch indices. Must be increasing, defaults to None
     :type milestones: List[int], optional
     :param gamma: Multiplicative factor of learning rate decay, defaults to 0.1
     :type gamma: float, optional
-    :param num_steps_per_epoch: number of steps per epoch, defaults to -1
+    :param num_steps_per_epoch: Number of steps per epoch, defaults to -1
     :type num_steps_per_epoch: int, optional
     :param last_epoch: The index of last epoch, defaults to -1
     :type last_epoch: int, optional
@@ -33,17 +34,18 @@ class MultiStepLR(_MultiStepLR):
 @LR_SCHEDULERS.register_module
 class MultiStepWarmupLR(WarmupScheduler):
     """Multi-step laerning rate scheduler with warmup.
+
     :param optimizer: Wrapped optimizer
     :type optimizer: torch.optim.Optimizer
-    :param total_steps: number of total training steps
+    :param total_steps: Number of total training steps
     :type total_steps: int
-    :param warmup_steps: number of warmup steps, defaults to 0
+    :param warmup_steps: Number of warmup steps, defaults to 0
     :type warmup_steps: int, optional
     :param milestones: List of epoch indices. Must be increasing, defaults to None
     :type milestones: List[int], optional
     :param gamma: Multiplicative factor of learning rate decay, defaults to 0.1
     :type gamma: float, optional
-    :param num_steps_per_epoch: number of steps per epoch, defaults to -1
+    :param num_steps_per_epoch: Number of steps per epoch, defaults to -1
     :type num_steps_per_epoch: int, optional
     :param last_epoch: The index of last epoch, defaults to -1
     :type last_epoch: int, optional