• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1mindspore.train.CheckpointConfig
2================================
3
4.. py:class:: mindspore.train.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', exception_save=False, crc_check=False, **kwargs)
5
6    保存checkpoint时的配置策略。
7
8    .. note::
9        - 在训练过程中，如果数据集是通过数据通道传输的，建议将 `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` 无效。
10        - `enc_mode` 和 `crc_check` 参数互斥，不能同时配置。
11
12    参数：
13        - **save_checkpoint_steps** (int) - 每隔多少个step保存一次checkpoint。默认值： ``1`` 。
14        - **save_checkpoint_seconds** (int) - 每隔多少秒保存一次checkpoint。不能同时与 `save_checkpoint_steps` 一起使用。默认值： ``0`` 。
15        - **keep_checkpoint_max** (int) - 最多保存多少个checkpoint文件。默认值： ``5`` 。
16        - **keep_checkpoint_per_n_minutes** (int) - 每隔多少分钟保存一个checkpoint文件。不能同时与 `keep_checkpoint_max` 一起使用。默认值： ``0`` 。
17        - **integrated_save** (bool) - 在自动并行场景下，是否合并保存拆分后的Tensor。合并保存功能仅支持在自动并行场景中使用，在手动并行场景中不支持。默认值： ``True`` 。
18        - **async_save** (bool) - 是否异步执行保存checkpoint文件。默认值： ``False`` 。
19        - **saved_network** (Cell) - 保存在checkpoint文件中的网络。如果 `saved_network` 没有被训练，则保存 `saved_network` 的初始值。默认值： ``None`` 。
20        - **append_info** (list) - 保存在checkpoint文件中的信息。支持"epoch_num"、"step_num"和dict类型。dict的key必须是str，dict的value必须是int、float、bool、string、Parameter或Tensor中的一个。默认值： ``None`` 。
21        - **enc_key** (Union[None, bytes]) - 用于加密的字节类型key。如果值为None，则不需要加密。默认值： ``None`` 。
22        - **enc_mode** (str) - 仅当 `enc_key` 不设为None时，该参数有效。指定了加密模式，目前支持AES-GCM，AES-CBC和SM4-CBC。默认值： ``'AES-GCM'`` 。
23        - **exception_save** (bool) - 当有异常发生时，是否保存当前checkpoint文件。默认值： ``False`` 。
24        - **crc_check** (bool) - 是否在保存checkpoint时进行crc32计算，并将计算结果保存到ckpt尾部。默认值： ``False`` 。
25        - **kwargs** (dict) - 配置选项字典。
26
27    异常：
28        - **ValueError** - 输入参数的类型不正确。
29
30    .. py:method:: append_dict
31        :property:
32
33        获取需要额外保存到checkpoint中的字典的值。
34
35        返回：
36            dict: 字典中的值。
37
38    .. py:method:: async_save
39        :property:
40
41        获取是否异步保存checkpoint。
42
43        返回：
44            bool: 是否异步保存checkpoint。
45
46    .. py:method:: crc_check
47        :property:
48
49        获取是否启用crc校验。
50
51        返回：
52            bool: 是否启用crc校验。
53
54    .. py:method:: enc_key
55        :property:
56
57        获取加密的key值。
58
59        返回：
60            (None, bytes): 加密的key值。
61
62    .. py:method:: enc_mode
63        :property:
64
65        获取加密模式。
66
67        返回：
68            str: 加密模式。
69
70    .. py:method:: get_checkpoint_policy()
71
72        获取checkpoint的保存策略。
73
74        返回：
75            dict: checkpoint的保存策略。
76
77    .. py:method:: integrated_save
78        :property:
79
80        获取是否合并保存拆分后的Tensor。
81
82        返回：
83            bool: 获取是否合并保存拆分后的Tensor。
84
85    .. py:method:: keep_checkpoint_max
86        :property:
87
88        获取最多保存checkpoint文件的数量。
89
90        返回：
91            int: 最多保存checkpoint文件的数量。
92
93    .. py:method:: keep_checkpoint_per_n_minutes
94        :property:
95
96        获取每隔多少分钟保存一个checkpoint文件。
97
98        返回：
99            int: 每隔多少分钟保存一个checkpoint文件。
100
101    .. py:method:: map_param_inc
102        :property:
103
104        获取是否增量保存MapParameter。
105
106        返回：
107            bool: 是否增量保存MapParameter。
108
109    .. py:method:: save_checkpoint_seconds
110        :property:
111
112        获取每隔多少秒保存一次checkpoint文件。
113
114        返回：
115            int: 每隔多少秒保存一次checkpoint文件。
116
117    .. py:method:: save_checkpoint_steps
118        :property:
119
120        获取每隔多少个step保存一次checkpoint文件。
121
122        返回：
123            int: 每隔多少个step保存一次checkpoint文件。
124
125    .. py:method:: saved_network
126        :property:
127
128        获取需要保存的网络。
129
130        返回：
131            Cell: 需要保存的网络。
132