mindstudio-probe 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

msprobe/pytorch/monitor/module_metric.py

@@ -0,0 +1,193 @@
+# Copyright (c) 2024-2024, Huawei Technologies Co., Ltd.
+# All rights reserved.
+#
+# 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.
+import itertools
+import math
+import re
+import statistics
+
+import torch
+
+from msprobe.core.common.const import MonitorConst
+from msprobe.pytorch.monitor.features import square_sum, get_max, get_min, get_zeros, get_nans, get_norm, get_mean
+from msprobe.core.common.log import logger
+
+
+def get_summary_writer_tag_name(module_or_param_name: str, tag: str, rank):
+    if rank is None:
+        return f"{module_or_param_name}/{tag}"
+    else:
+        return f"{module_or_param_name}/rank{rank}/{tag}"
+
+
+def squash_param_name(param_name):
+    name = ''
+    for pattern in ['layers?\.(.*)', 'embeddings?\.(.*)', 'final.*', 'output.*', 'norm.*']:
+        match = re.findall(pattern, param_name)
+        if match:
+            name += match[0]
+            break
+    if name == '':
+        name = param_name
+    return name
+
+
+# 用于存储所有metric实现类的注册表
+config_metric_registry = {}
+
+
+def register_config_metric(key, cls=None):
+    """装饰器 用于注册Metric的实现类"""
+    if cls is None:
+        # 无参数时，返回装饰器函数
+        return lambda cls_: register_config_metric(key, cls_)
+    config_metric_registry[key] = cls()
+    return cls
+
+
+class TensorMetrics:
+    fun_map = {"norm": get_norm, "max": get_max, "min": get_min, "mean": get_mean}
+
+    def __init__(self) -> None:
+        self.metrics = {}  # tensor_tag --> []
+        self.cur_idx = {}
+
+    def stat_insert(self, tensor, stat_ops, module_name, tensor_name, rank, eps=1e-8):
+        """get stats and insert into metrics dictionary"""
+        prefix = get_summary_writer_tag_name(module_name, tensor_name, rank)
+        for stat_op in stat_ops:
+            y = TensorMetrics.fun_map[stat_op](tensor)
+            key = f"{prefix}_{stat_op}"
+            if key not in self.metrics:
+                self.metrics[key] = []
+                self.cur_idx[key] = 0
+            self.metrics[key].append(y)
+
+    def flush(self, tb_writer):
+        for key, metric_list in self.metrics.items():
+            start = self.cur_idx[key]
+            for v in metric_list[start:]:
+                tb_writer.add_scalar(key, v.item(), global_step=self.cur_idx[key])
+                self.cur_idx[key] += 1
+
+
+class Metric(object):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        NotImplementedError
+
+    def get_metric(self, tensor, eps):
+        try:
+            return self.get_metric_value(tensor, eps)
+        except RuntimeError as e:
+            return torch.tensor(torch.nan).to(tensor.device)
+
+
+@register_config_metric("min")
+class MinMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        return get_min(tensor)
+
+
+@register_config_metric("mean")
+class MeanMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        return get_mean(tensor)
+
+
+@register_config_metric("max")
+class MaxMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        return get_max(tensor)
+
+
+@register_config_metric("norm")
+class NormMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        return get_norm(tensor)
+    
+
+@register_config_metric("zeros")
+class ZerosMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        return get_zeros(tensor, eps)
+    
+
+@register_config_metric("nans")
+class NaNsMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        return get_nans(tensor)
+
+
+@register_config_metric("id")
+class IdentMetric(Metric):
+    @staticmethod
+    def get_metric_value(tensor, eps):
+        if tensor.dim() != 0:
+            return None
+        return tensor
+
+
+def get_metrics(ops, tag2tensor, eps, out_dict=None):
+    if out_dict is None:
+        out_dict = {}
+    for tag, tensor in tag2tensor.items():
+        if tag not in out_dict:
+            out_dict[tag] = {}
+        for metric_name in ops:    
+            fun_metric = config_metric_registry.get(metric_name)
+            out_dict[tag][metric_name] = fun_metric.get_metric(tensor, eps)
+    return out_dict
+
+
+def write_metrics_base(ops, summary_writer, metric_value, step, prefix=''):
+    if not metric_value:
+        return
+    tensors = []
+    tags = list(itertools.product(metric_value.keys(), ops))
+    for op2tensor in metric_value.values():
+        tensors.extend(op2tensor.values())
+    with torch.no_grad():
+        metric_list = torch.stack(tensors).cpu()
+    for tag, metric in zip(tags, metric_list):
+        summary_writer.add_scalar(tag, metric, step)
+
+
+def write_metrics_csv(ops, summary_writer, metric_value, step, prefix=''):
+    write_metrics_base(ops, summary_writer, metric_value, step, prefix='')
+
+    if not summary_writer.header:
+        # 前向的norm用input.ops_和output.ops_，反向的用input_grad.ops_和output_grad.ops_
+        if prefix in {"actv", "actv_grad"}:
+            if prefix == "actv":
+                input_and_output = [MonitorConst.ACTV_IN, MonitorConst.ACTV_OUT]
+            else:
+                input_and_output = [MonitorConst.ACTVGRAD_IN, MonitorConst.ACTVGRAD_OUT]
+            ops_ = [MonitorConst.DOT.join(i[::-1]) for i in itertools.product(ops, input_and_output)]
+            summary_writer.header = ["module_name", "step", *ops_]
+        else:
+            summary_writer.header = ["param_name", "step", *ops]
+
+        for key in metric_value.keys():
+            if MonitorConst.VPP_SEP in key:
+                summary_writer.header.insert(0, 'vpp_stage')
+            break
+    summary_writer.write_csv(prefix, step)
+    summary_writer.header = []

msprobe/pytorch/monitor/module_spec_verifier.py

@@ -0,0 +1,93 @@
+# Copyright (c) 2024-2024, Huawei Technologies Co., Ltd.
+# All rights reserved.
+#
+# 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.
+
+import re
+import abc
+import torch
+
+from msprobe.core.common.log import logger
+
+# 用于存储所有validator实现类的注册表
+config_validator_registry = {}
+
+
+def register_config_validator(cls):
+    """装饰器 用于注册ConfigValidator的实现类"""
+    config_validator_registry[cls.__name__] = cls
+    return cls
+
+
+class ConfigValidator(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def check_pattern_match(self, config_spec: str):
+        pass
+
+    @abc.abstractmethod
+    def validate(self, actual_data, module_name: str, data_type: str, pattern_match):
+        pass
+
+
+@register_config_validator
+class TensorValidator(ConfigValidator):
+    def check_pattern_match(self, config_spec: str):
+        pattern = re.compile(r"tensor")
+        return pattern.match(config_spec)
+
+    def validate(self, actual_data, module_name: str, data_type: str, pattern_match):
+        if not torch.is_tensor(actual_data):
+            raise ValueError(
+                f"Format of {module_name} {data_type} does not match the required format 'tensor' in config.")
+
+
+@register_config_validator
+class TupleValidator(ConfigValidator):
+    def check_pattern_match(self, config_spec: str):
+        pattern = re.compile(r"tuple\[(\d+)\]:?(\d+)?")
+        return pattern.match(config_spec)
+
+    def validate(self, actual_data, module_name: str, data_type: str, pattern_match):
+        length, index = pattern_match.groups()
+        if index is None:
+            index = 0
+        length, index = int(length), int(index)
+
+        if not (0 <= index < length):
+            raise ValueError(
+                f"Format of {module_name} {data_type} in config.json does not match the required format 'tuple[x]:y'."
+                f"y must be greater than or equal to 0 and less than x.")
+        if not isinstance(actual_data, tuple):
+            raise ValueError(
+                f"Type of {module_name} {data_type} does not match spec of config.json, should be tuple, please check.")
+        if len(actual_data) != length:
+            raise ValueError(
+                f"Length of {module_name} {data_type} does not match spec of config.json, should be {length}, "
+                f"actual is {len(actual_data)} please check.")
+        return index
+
+
+def validate_config_spec(config_spec: str, actual_data, module_name: str, data_type: str):
+    focused_col = None
+    for _, validator_cls in config_validator_registry.items():
+        config_validator = validator_cls()
+        pattern_match = config_validator.check_pattern_match(config_spec)
+        if pattern_match:
+            try:
+                focused_col = config_validator.validate(actual_data, module_name, data_type, pattern_match)
+            except ValueError as e:
+                logger.warning(f"config spec validate failed: {str(e)}")
+            return focused_col
+    logger.warning(f"config spec in {module_name} {data_type} not supported, "
+                   f"expected spec:'tuple\[(\d+)\]:(\d+)' or 'tensor', actual spec: {config_spec}.")
+    return focused_col

msprobe/pytorch/monitor/optimizer_collect.py

@@ -0,0 +1,295 @@
+# Copyright (c) 2024-2024, Huawei Technologies Co., Ltd.
+# All rights reserved.
+#
+# 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 abc import ABC, abstractmethod
+from collections import defaultdict
+
+import torch
+import torch.distributed as dist
+
+from msprobe.core.common.log import logger
+from msprobe.pytorch.monitor.utils import MVResult, MVGradResult
+
+
+class OptimizerMon(object):
+    wrapped_optimizer = None
+
+    def __init__(self) -> None:
+        self.fp16_to_fp32_param = {}
+        self.is_stage3 = False
+
+    @classmethod
+    def set_wrapped_optimizer(cls, wrapped_optimizer):
+        cls.wrapped_optimizer = wrapped_optimizer
+
+    def fetch_mv(self, monitor, torch_opt, params2name):
+        pass
+
+    def _fetch_mv_in_adam(self, monitor, torch_opt, params2name):
+        exp_avg_dict = defaultdict(float)
+        exp_avg_sq_dict = defaultdict(float)
+        update_dict = defaultdict()
+        ratio_dict = defaultdict()
+        for param, name in params2name.items():
+            if param in self.fp16_to_fp32_param:
+                param = self.fp16_to_fp32_param[param]
+
+            if param in torch_opt.state:
+                state_param = torch_opt.state.get(param, None)
+                exp_avg = state_param.get("exp_avg", None)
+                exp_avg_sq = state_param.get("exp_avg_sq", None)
+                if exp_avg is None or exp_avg_sq is None:
+                    logger.warning(f"exp_avg or exp_avg_sq of {name} is None, maybe something wrong happened.")
+                    continue
+                if monitor.mv_distribution:
+                    exp_avg_dict[name] = exp_avg
+                    exp_avg_sq_dict[name] = exp_avg_sq
+                if monitor.mg_direction:
+                    exp_avg_dict[name] = exp_avg
+                if monitor.ur_distribution:
+                    if len(torch_opt.param_groups) > 1:
+                        logger.info(f"the length of torch_opt.param_groups is {len(torch_opt.param_groups)}.")
+                    if 'step' in state_param:
+                        step = state_param['step']  # Optimizer from pytorch or FusedAdam from apex(used by megatron)
+                    elif 'step' in torch_opt.param_groups[0]:
+                        step = torch_opt.param_groups[0]['step']  # AdamW from mindspeed
+                    else:
+                        logger.warning(f"step of {name} is None, maybe something wrong happened.")
+                        continue
+                    exp_avg_hat = exp_avg / (1 - torch_opt.defaults['betas'][0] ** step)
+                    exp_avg_sq_hat = exp_avg_sq / (1 - torch_opt.defaults['betas'][1] ** step)
+                    update_dict[name] = exp_avg_hat / (torch.sqrt(exp_avg_sq_hat) + torch_opt.defaults['eps'])
+                    ratio_dict[name] = exp_avg_hat / torch.sqrt(exp_avg_sq_hat)
+                    monitor.update_heatmap_visualizer[name].pre_cal(update_dict[name])
+                    monitor.ratio_heatmap_visualizer[name].pre_cal(ratio_dict[name])
+        return MVResult(exp_avg=exp_avg_dict, exp_avg_sq=exp_avg_sq_dict, update=update_dict, ratio=ratio_dict)
+
+    def _fetch_mv_grad_in_adam(self, monitor, torch_opt, params2name, name2indices, fp32_partitioned_groups_flat):
+        exp_avg_dict = defaultdict(float)
+        exp_avg_sq_dict = defaultdict(float)
+        update_dict = defaultdict()
+        ratio_dict = defaultdict()
+        param2name = defaultdict()
+        fp32_partitioned_groups_flat_grad = defaultdict()
+        mix_prec_opt = OptimizerMon.wrapped_optimizer
+        partition_id = dist.get_rank()
+
+        def get_flatten_grad(self, optimizer, group_idx):
+            if  fp32_partitioned_groups_flat[group_idx].grad is None:
+                if partition_id == dist.get_world_size() - 1 and not self.is_stage3:
+                    fp32_partitioned_groups_flat_grad = optimizer.flatten_dense_tensors_aligned(
+                        optimizer.averaged_gradients[group_idx],
+                        int(optimizer.partition_size[group_idx])
+                    ).to(fp32_partitioned_groups_flat[group_idx].dtype)
+                else:
+                    fp32_partitioned_groups_flat_grad = optimizer.flatten(
+                        optimizer.averaged_gradients[group_idx]
+                    ).to(fp32_partitioned_groups_flat[group_idx].dtype)
+                return fp32_partitioned_groups_flat_grad
+            else:
+                return fp32_partitioned_groups_flat[group_idx].grad
+
+        for group_idx in range(len(fp32_partitioned_groups_flat)):
+            fp32_partitioned_groups_flat_grad[group_idx] = get_flatten_grad(self, mix_prec_opt, group_idx)
+
+        for name in params2name.values():
+            start_idx, end_idx, group_idx, group_with_rank = name2indices[name]
+            if group_with_rank != partition_id and isinstance(group_with_rank, int):
+                continue
+            fp32_param = fp32_partitioned_groups_flat[group_idx][start_idx: end_idx]
+            fp32_param.grad = fp32_partitioned_groups_flat_grad[group_idx][start_idx: end_idx]
+            param2name[fp32_param] = name
+            if not mix_prec_opt.state:
+                continue
+            state_param = list(mix_prec_opt.state.values())[group_idx]
+            exp_avg = state_param.get("exp_avg", None)
+            exp_avg_sq = state_param.get("exp_avg_sq", None)
+            if exp_avg is None or exp_avg_sq is None:
+                logger.warning(f"exp_avg or exp_avg_sq of {name} is None, maybe something wrong happened.")
+                continue
+            exp_avg = exp_avg[start_idx: end_idx]
+            exp_avg_sq = exp_avg_sq[start_idx: end_idx]
+            if monitor.mv_distribution:
+                exp_avg_dict[name] = exp_avg
+                exp_avg_sq_dict[name] = exp_avg_sq
+            if monitor.mg_direction:
+                exp_avg_dict[name] = exp_avg
+            if monitor.ur_distribution:
+                if 'step' in state_param:
+                    step = state_param['step']  # Optimizer from pytorch or FusedAdam from apex(used by megatron)
+                elif 'step' in torch_opt.param_groups[group_idx]:
+                    step = torch_opt.param_groups[group_idx]['step']  # AdamW from mindspeed
+                else:
+                    logger.warning(f"step of {name} is None, maybe something wrong happened.")
+                    continue
+                exp_avg_hat = exp_avg / (1 - torch_opt.defaults['betas'][0] ** step)
+                exp_avg_sq_hat = exp_avg_sq / (1 - torch_opt.defaults['betas'][1] ** step)
+                update_dict[name] = exp_avg_hat / (torch.sqrt(exp_avg_sq_hat) + torch_opt.defaults['eps'])
+                ratio_dict[name] = exp_avg_hat / torch.sqrt(exp_avg_sq_hat)
+                monitor.update_heatmap_visualizer[name].pre_cal(update_dict[name])
+                monitor.ratio_heatmap_visualizer[name].pre_cal(ratio_dict[name])
+        del fp32_partitioned_groups_flat_grad
+        return MVGradResult(exp_avg=exp_avg_dict, exp_avg_sq=exp_avg_sq_dict, update=update_dict, ratio=ratio_dict,
+                            grad=param2name)
+
+
+class MixPrecisionOptimizerMon(OptimizerMon):
+    """
+    混合精度优化器监控类。在混合精度训练中监控和管理优化器。
+    混合精度训练通过适当降低某些计算的精度来加速训练过程并减少内存消耗。
+    """
+
+    def fetch_mv(self, monitor, torch_opt, params2name):
+        mix_prec_opt = self.wrapped_optimizer
+
+        if not self.fp16_to_fp32_param and mix_prec_opt is not None:
+            for fp16_group, fp32_group in zip(mix_prec_opt.float16_groups, mix_prec_opt.fp32_from_float16_groups):
+                for fp16_param, fp32_param in zip(fp16_group, fp32_group):
+                    self.fp16_to_fp32_param[fp16_param] = fp32_param
+        return self._fetch_mv_in_adam(monitor, torch_opt, params2name)
+
+
+class MegatronDistributedOptimizerMon(OptimizerMon):
+    def fetch_mv(self, monitor, torch_opt, params2name):
+        mix_prec_opt = self.wrapped_optimizer
+        if not (hasattr(mix_prec_opt, "model_float16_groups") and
+                hasattr(mix_prec_opt, "shard_fp32_from_float16_groups")):
+            raise Exception(
+                "megatron distributed optimizer should have model_float16_groups and shard_fp32_from_float16_groups, "
+                "if not, please check megatron-lm version")
+        if not self.fp16_to_fp32_param and mix_prec_opt is not None:
+            for fp16_group, shard_fp32_group in zip(mix_prec_opt.model_float16_groups,
+                                                    mix_prec_opt.shard_fp32_from_float16_groups):
+                for fp16_param, shard_fp32_param in zip(fp16_group, shard_fp32_group):
+                    self.fp16_to_fp32_param[fp16_param] = shard_fp32_param
+
+        return self._fetch_mv_in_adam(monitor, torch_opt, params2name)
+
+
+class MegatronFP32OptimizerMon(OptimizerMon):
+    def fetch_mv(self, monitor, torch_opt, params2name):
+        return self._fetch_mv_in_adam(monitor, torch_opt, params2name)
+
+
+class DeepSpeedZeroOptimizerStage0Mon(OptimizerMon):
+    def fetch_mv(self, monitor, torch_opt, params2name):
+        return self._fetch_mv_in_adam(monitor, torch_opt, params2name)
+
+
+class DeepSpeedZeroOptimizerStage3Mon(OptimizerMon):
+    def get_param_index(self, params2name, name2index):
+        mix_prec_opt = OptimizerMon.wrapped_optimizer
+        fp16_groups = mix_prec_opt.fp16_partitioned_groups
+        name2indices = defaultdict()
+        index_length = defaultdict()
+        index = 0
+        idx = 0
+        for group_idx, fp16_group in enumerate(fp16_groups):
+            for param in fp16_group:
+                param_length = len(param.flatten())
+                index_length[idx] = (index, index + param_length, group_idx)
+                index += param_length
+                idx += 1
+        for _, name in params2name.items():
+            idx = name2index[name]
+            start_idx, end_idx, group_idx = index_length[idx]
+            name2indices[name] = (start_idx, end_idx, group_idx, None)
+        return name2indices
+
+    def fetch_mv(self, monitor, torch_opt, params2name, name2indices=None):
+        self.is_stage3 = True
+        mix_prec_opt = OptimizerMon.wrapped_optimizer
+        fp32_partitioned_groups_flat = mix_prec_opt.fp32_partitioned_groups_flat
+        return self._fetch_mv_grad_in_adam(monitor, torch_opt, params2name, name2indices, fp32_partitioned_groups_flat)
+
+
+class DeepSpeedZeroOptimizerStage1or2Mon(OptimizerMon):
+
+    @staticmethod
+    def get_group_index(fp32_length, world_size, index):
+        for i in range(len(fp32_length) - 1):
+            if fp32_length[i] <= index < fp32_length[i + 1]:
+                interval_start = fp32_length[i]
+                interval_length = fp32_length[i + 1] - fp32_length[i]
+                sub_interval_length = interval_length // world_size
+                sub_index = (index - interval_start) // sub_interval_length
+                sub_interval_start = interval_start + sub_index * sub_interval_length
+                return sub_interval_start, min(sub_index, world_size - 1)
+        return fp32_length[-1], 0
+
+    def get_param_index(self, params2name, name2index):
+        mix_prec_opt = OptimizerMon.wrapped_optimizer
+        padding = mix_prec_opt.groups_padding
+        world_size = dist.get_world_size()
+        fp32_length = [0]
+        for fp32_group_index, single_partition_of_fp32_group in enumerate(mix_prec_opt.single_partition_of_fp32_groups):
+            fp32_length.append(len(single_partition_of_fp32_group) * world_size + fp32_length[fp32_group_index])
+
+        bf16_groups = []
+        name2indices = defaultdict()
+        index_length = defaultdict()
+        index = 0
+        idx = 0
+        for group_idx, bf16_group in enumerate(mix_prec_opt.bit16_groups):
+            bf16_groups.extend(bf16_group)
+            for param in bf16_group:
+                param_length = len(param.flatten())
+                group_index, group_with_rank = self.get_group_index(fp32_length, world_size, index)
+                index_length[idx] = (index, index + param_length, group_idx, group_index, group_with_rank)
+                index += param_length
+                idx += 1
+        group_length = len(bf16_groups) / len(mix_prec_opt.bit16_groups)
+        for _, name in params2name.items():
+            name_index = name2index[name]
+            start_idx, end_idx, group_idx, group_index, group_with_rank = index_length[name_index]
+            need_padding = True if group_with_rank == world_size - 1 else False
+            new_start_idx = start_idx - group_index
+            new_end_idx = end_idx - group_index
+            if need_padding and group_length - 1 <= name_index <= len(bf16_groups) - 1 and name_index % (
+                    group_length - 1) == 0:
+                new_end_idx -= padding[int(name_index // (group_length - 1) - 1)]
+            name2indices[name] = (new_start_idx, new_end_idx, group_idx, group_with_rank)
+        return name2indices
+
+    def fetch_mv(self, monitor, torch_opt, params2name, name2indices=None):
+        mix_prec_opt = OptimizerMon.wrapped_optimizer
+        fp32_partitioned_groups_flat = mix_prec_opt.single_partition_of_fp32_groups
+        return self._fetch_mv_grad_in_adam(monitor, torch_opt, params2name, name2indices, fp32_partitioned_groups_flat)
+
+
+class DummyOptimizerMon(OptimizerMon):
+    def fetch_mv(self, monitor, torch_opt, params2name):
+        return MVResult(exp_avg=None, exp_avg_sq=None, update=None, ratio=None)
+
+
+class OptimizerMonFactory:
+    _optimizer_mon_map = {
+        "Megatron_Float16OptimizerWithFloat16Params": MixPrecisionOptimizerMon,
+        "Megatron_DistributedOptimizer": MegatronDistributedOptimizerMon,
+        "Megatron_FP32Optimizer": MegatronFP32OptimizerMon,
+        "DeepSpeedZeroOptimizer_Stage0": DeepSpeedZeroOptimizerStage0Mon,
+        "DeepSpeedZeroOptimizer_Stage1_or_2": DeepSpeedZeroOptimizerStage1or2Mon,
+        "DeepSpeedZeroOptimizer_Stage3": DeepSpeedZeroOptimizerStage3Mon,
+        "unknown": DummyOptimizerMon
+    }
+
+    @staticmethod
+    def create_optimizer_mon(opt_ty: str):
+        if not opt_ty:
+            return DummyOptimizerMon()
+        optimizer_mon_class = OptimizerMonFactory._optimizer_mon_map.get(opt_ty)
+        if not optimizer_mon_class:
+            raise Exception("opt_ty should be one of: " + ", ".join(OptimizerMonFactory._optimizer_mon_map.keys()))
+        return optimizer_mon_class()