示例

def parse_config():
    parser = argparse.ArgumentParser(description='arg parser')  # 创建一个 ArgumentParser 对象(parser)
    parser.add_argument('--cfg_file', type=str, default=None, help='specify the config for training')  # 配置文件（路径）

    parser.add_argument('--batch_size', type=int, default=None, required=False, help='batch size for training')  # 单次传递给程序用以训练的数据(样本)个数
    parser.add_argument('--epochs', type=int, default=None, required=False, help='number of epochs to train for')  # 训练次数
    parser.add_argument('--workers', type=int, default=4, help='number of workers for dataloader')  # 线程数，根据自己的电脑设置
    parser.add_argument('--extra_tag', type=str, default='default', help='extra tag for this experiment')  #自定义数据集 pkl 文件中的标签
    parser.add_argument('--ckpt', type=str, default=None, help='checkpoint to start from')  #模型文件路径
    parser.add_argument('--pretrained_model', type=str, default=None, help='pretrained_model')  #  预训练模型
    parser.add_argument('--launcher', choices=['none', 'pytorch', 'slurm'], default='none')  # 分布式训练使用的启动器
    parser.add_argument('--tcp_port', type=int, default=18888, help='tcp port for distrbuted training')
    parser.add_argument('--sync_bn', action='store_true', default=False, help='whether to use sync bn')
    parser.add_argument('--fix_random_seed', action='store_true', default=False, help='')  # 随机种子
    parser.add_argument('--ckpt_save_interval', type=int, default=1, help='number of training epochs')  # 每隔多少个 epoch 保存一次模型
    parser.add_argument('--local_rank', type=int, default=0, help='local rank for distributed training')  # 本地进程编号，此参数 torch.distributed.launch 会自动传入
    parser.add_argument('--max_ckpt_save_num', type=int, default=10, help='max number of saved checkpoint')  # z最多保存多少轮的模型
    parser.add_argument('--merge_all_iters_to_one_epoch', action='store_true', default=False, help='')
    parser.add_argument('--set', dest='set_cfgs', default=None, nargs=argparse.REMAINDER,
                        help='set extra config keys if needed')
    parser.add_argument('--gpu_id', type=str, default='default', help='gpu ids')  # 使用指定 GPU 的 id

    parser.add_argument('--max_waiting_mins', type=int, default=0, help='max waiting minutes')
    parser.add_argument('--start_epoch', type=int, default=0, help='')
    parser.add_argument('--save_to_file', action='store_true', default=False, help='')   # action='store_true'，只要运行时该变量有传参就将该变量设为True

    args = parser.parse_args()

    cfg_from_yaml_file(args.cfg_file, cfg)
    cfg.TAG = Path(args.cfg_file).stem
    cfg.EXP_GROUP_PATH = '/'.join(args.cfg_file.split('/')[1:-1])  # remove 'cfgs' and 'xxxx.yaml'
    # args.cfg_file.split('/'): 这里使用split('/')方法将args.cfg_file按照斜杠（'/'）分割为一个字符串列表。
    # 例如，如果args.cfg_file的值是/path/to/config.yaml，那么args.cfg_file.split('/')将返回['', 'path', 'to', 'config.yaml']
    # [1:-1]: 这是Python切片操作，表示从列表中去掉第一个元素和最后一个元素。
    # 在这里的作用是去掉空字符串和配置文件的文件名部分，只保留路径部分。使用这个切片操作后，上面的示例列表将变成['path', 'to']。

    if args.set_cfgs is not None:
        cfg_from_list(args.set_cfgs, cfg)

    return args, cfg


def main():
    args, cfg = parse_config()

模块介绍

1.parser = argparse.ArgumentParser()

创建一个解析对象。

2.parser.add_argument()

向该对象中添加要关注的命令行参数和选项。
通过调用 add_argument() 方法，可以在 ArgumentParser 中填充有关程序参数的信息。通常，这些调用会告诉ArgumentParser如何获取命令行上的字符串并将其转换为对象。这些信息在调用parse_args()时存储并使用。

>>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
...                     help='an integer for the accumulator')
>>> parser.add_argument('--sum', dest='accumulate', action='store_const',
...                     const=sum, default=max,
...                     help='sum the integers (default: find the max)')

3.parser.parse_args()

解析参数，解析成功之后即可使用命令行参数和选项。

参数介绍

ame or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
action - 命令行遇到参数时的动作，默认值是 store。
action=‘store_true’，只要运行时该变量有传参就将该变量设为 True
store_const，表示赋值为const；
append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
append_const，将参数规范中定义的一个值保存到一个列表；
count，存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
const - action 和 nargs 所需要的常量值。
default - 不指定参数时的默认值。
type - 命令行参数应该被转换成的类型。
choices - 参数可允许的值的一个容器。
required - 可选参数是否可以省略 (仅针对可选参数)。
help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线。