Add docstring for DistSamplerSeedHook (#850)

ba30d98a · Miao Zheng · GitHub · 823b62ed · ba30d98a
Unverified Commit ba30d98a authored Feb 24, 2021 by Miao Zheng Committed by GitHub Feb 24, 2021
Show whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

mmcv/runner/hooks/sampler_seed.py mmcv/runner/hooks/sampler_seed.py +6 -0

No files found.
--- a/mmcv/runner/hooks/sampler_seed.py
+++ b/mmcv/runner/hooks/sampler_seed.py
@@ -4,6 +4,12 @@ from .hook import HOOKS, Hook

 @HOOKS.register_module()
 class DistSamplerSeedHook(Hook):
+    """Data-loading sampler for distributed training.
+
+    When distributed training, it is only useful in conjunction with
+    :obj:`EpochBasedRunner`, while :obj:`IterBasedRunner` achieves the same
+    purpose with :obj:`IterLoader`.
+    """

    def before_epoch(self, runner):
        if hasattr(runner.data_loader.sampler, 'set_epoch'):