mindspore2022/docs/api/api_python/mindspore.train/mindspore.train.callback.CheckpointConfig.txt

Class mindspore.train.callback.CheckpointConfig(save_checkpoint_steps=1, save_checkpoint_seconds=0, keep_checkpoint_max=5, keep_checkpoint_per_n_minutes=0, integrated_save=True, async_save=False, saved_network=None, append_info=None, enc_key=None, enc_mode='AES-GCM')

    保存checkpoint时的配置策略。

    注：
        在训练过程中，如果数据集是通过数据通道传输的，建议将save_checkpoint_steps设为循环下沉step数量的整数倍数，
        否则，保存checkpoint的时机可能会有偏差。
        建议同时只设置一种触发保存checkpoint策略和一种保留checkpoint文件总数策略。
        如果同时设置了`save_checkpoint_steps`和`save_checkpoint_seconds`，则`save_checkpoint_seconds`无效。
        如果同时设置了`keep_checkpoint_max`和`keep_checkpoint_per_n_minutes`，则`keep_checkpoint_per_n_minutes`无效。

    参数：
        save_checkpoint_steps (int)：每隔多少个step保存一次checkpoint。默认值：1。
        save_checkpoint_seconds (int)：每隔多少秒保存一次checkpoint。
            不能同时与save_checkpoint_steps一起使用。默认值：0。
        keep_checkpoint_max (int)：最多保存多少个checkpoint文件。默认值：5。
        keep_checkpoint_per_n_minutes (int)：每隔多少分钟保存一个checkpoint文件。
            不能同时与keep_checkpoint_max一起使用。默认值：0。
        integrated_save (bool)：在自动并行场景下，是否合并保存拆分后的Tensor。
            合并保存功能仅支持在自动并行场景中使用，在手动并行场景中不支持。默认值：True。
        async_save (bool)：是否异步执行保存checkpoint文件。默认值：False。
        saved_network (Cell)：保存在checkpoint文件中的网络。如果`saved_network`没有被训练，则保存`saved_network`的初始值。默认值：None。
        append_info (list)：保存在checkpoint文件中的信息。支持"epoch_num"、"step_num"和dict类型。
            dict的key必须是str，dict的value必须是int、float或bool中的一个。默认值：None。
        enc_key (Union[None, bytes])：用于加密的字节类型key。如果值为None，则不需要加密。默认值：None。
        enc_mode (str)：仅当enc_key不设为None时，该参数有效。指定了加密模式，目前支持AES-GCM和AES-CBC。默认值：AES-GCM。

    异常：
        ValueError：输入参数的类型不正确。

    示例：
        >>> from mindspore import Model, nn
        >>> from mindspore.train.callback import ModelCheckpoint, CheckpointConfig
        >>>
        >>> class LeNet5(nn.Cell)：
        ...     def __init__(self, num_class=10, num_channel=1)：
        ...         super(LeNet5, self).__init__()
        ...         self.conv1 = nn.Conv2d(num_channel, 6, 5, pad_mode='valid')
        ...         self.conv2 = nn.Conv2d(6, 16, 5, pad_mode='valid')
        ...         self.fc1 = nn.Dense(16 * 5 * 5, 120, weight_init=Normal(0.02))
        ...         self.fc2 = nn.Dense(120, 84, weight_init=Normal(0.02))
        ...         self.fc3 = nn.Dense(84, num_class, weight_init=Normal(0.02))
        ...         self.relu = nn.ReLU()
        ...         self.max_pool2d = nn.MaxPool2d(kernel_size=2, stride=2)
        ...         self.flatten = nn.Flatten()
        ...
        ...     def construct(self, x)：
        ...         x = self.max_pool2d(self.relu(self.conv1(x)))
        ...         x = self.max_pool2d(self.relu(self.conv2(x)))
        ...         x = self.flatten(x)
        ...         x = self.relu(self.fc1(x))
        ...         x = self.relu(self.fc2(x))
        ...         x = self.fc3(x)
        ...         return x
        >>>
        >>> net = LeNet5()
        >>> loss = nn.SoftmaxCrossEntropyWithLogits(sparse=True, reduction='mean')
        >>> optim = nn.Momentum(net.trainable_params(), 0.01, 0.9)
        >>> model = Model(net, loss_fn=loss, optimizer=optim)
        >>> data_path = './MNIST_Data'
        >>> dataset = create_dataset(data_path)
        >>> config = CheckpointConfig(saved_network=net)
        >>> ckpoint_cb = ModelCheckpoint(prefix='LeNet5', directory='./checkpoint', config=config)
        >>> model.train(10, dataset, callbacks=ckpoint_cb)
    

append_dict
获取checkpoint中添加字典里面的值。

async_save
获取是否异步保存checkpoint。

enc_key
获取加密的key值。

enc_mode
获取加密模式。

get_checkpoint_policy()
获取checkpoint的保存策略。

integrated_save
获取是否合并保存拆分后的Tensor。

keep_checkpoint_max
获取最多保存checkpoint文件的数量。

keep_checkpoint_per_n_minutes
获取每隔多少分钟保存一个checkpoint文件。

saved_network
获取_保存的网络。

save_checkpoint_seconds
获取每隔多少秒保存一次checkpoint文件。。

save_checkpoint_steps
获取每隔多少个step保存一次checkpoint文件。