diff --git a/docs/api/api_python/mindspore/mindspore.FixedLossScaleManager.rst b/docs/api/api_python/mindspore/mindspore.FixedLossScaleManager.rst index 5f1bef348c8..39efd5cab6e 100644 --- a/docs/api/api_python/mindspore/mindspore.FixedLossScaleManager.rst +++ b/docs/api/api_python/mindspore/mindspore.FixedLossScaleManager.rst @@ -5,39 +5,34 @@ mindspore.FixedLossScaleManager 损失缩放系数不变的管理器，继承自 :class:`mindspore.LossScaleManager` 。 - **参数：** - - - **loss_scale** (float) - 梯度放大系数。注：如果将 `drop_overflow_update` 设为False，则定义优化器时需要将优化器的 `loss_scale` 设为相同的值。默认值：128.0。 - - **drop_overflow_update** (bool) - 出现溢出时，是否执行优化器。如果值为True，则出现溢出时不会执行优化器。默认值：True。 + 参数： + - **loss_scale** (float) - 梯度放大系数。注：如果将 `drop_overflow_update` 设为False，则定义优化器时需要将优化器的 `loss_scale` 设为相同的值。默认值：128.0。 + - **drop_overflow_update** (bool) - 出现溢出时，是否执行优化器。如果值为True，则出现溢出时不会执行优化器。默认值：True。 .. py:method:: get_drop_overflow_update() 返回 `drop_overflow_update` ，该值表示是否在发生溢出时放弃本轮参数更新。 - **返回：** - - bool, `drop_overflow_update` 的值。 + 返回： + bool，`drop_overflow_update` 的值。 .. py:method:: get_loss_scale() 获取loss scale值。 - **返回：** - - bool，`loss_scale` 的值。 + 返回： + bool，`loss_scale` 的值。 .. py:method:: get_update_cell() 返回用于更新 `loss_scale` 值的 `Cell` 实例， :class:`mindspore.nn.TrainOneStepWithLossScaleCell` 会调用该实例。该类使用固定的梯度放大系数，因此该实例不执行任何操作。 - **返回：** - - None或 `Cell` 。当 `drop_overflow_update` 为True时，返回 :class:`mindspore.nn.FixedLossScaleUpdateCell` 实例，当 `drop_overflow_update` 为False时，返回None。 + 返回： + None或 `Cell` 。当 `drop_overflow_update` 为True时，返回 :class:`mindspore.nn.FixedLossScaleUpdateCell` 实例，当 `drop_overflow_update` 为False时，返回None。 .. py:method:: update_loss_scale(overflow) 更新loss scale值。类 :class:`mindspore.FixedLossScaleManager` 中，该方法不执行任何操作。 - **参数：** - - - **overflow** (bool) - 表示是否溢出。 + 参数： + - **overflow** (bool) - 表示是否溢出。 diff --git a/docs/api/api_python/mindspore/mindspore.History.rst b/docs/api/api_python/mindspore/mindspore.History.rst index 77da7db28fc..6815dcd78d6 100644 --- a/docs/api/api_python/mindspore/mindspore.History.rst +++ b/docs/api/api_python/mindspore/mindspore.History.rst @@ -14,14 +14,12 @@ mindspore.History 璁粌寮濮嬫椂鍒濆鍖朒istory瀵硅薄鐨別poch灞炴с - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 .. py:method:: epoch_end(run_context) epoch缁撴潫鏃惰褰曠綉缁滆緭鍑哄拰璇勪及鎸囨爣鐨勭浉鍏充俊鎭 - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 diff --git a/docs/api/api_python/mindspore/mindspore.JitConfig.rst b/docs/api/api_python/mindspore/mindspore.JitConfig.rst index 1b09ed65b12..efbf6482ea7 100644 --- a/docs/api/api_python/mindspore/mindspore.JitConfig.rst +++ b/docs/api/api_python/mindspore/mindspore.JitConfig.rst @@ -8,13 +8,12 @@ mindspore.JitConfig .. note:: - 杩欐槸涓涓疄楠屾ф帴鍙ｏ紝鍚庣画鍙兘鍒犻櫎鎴栦慨鏀广 - **鍙傛暟锛** + 鍙傛暟锛 + - **jit_level** (str) - 璁剧疆缂栬瘧浼樺寲鐨勭骇鍒紝鏀寔["O0", "O1", "O2"]銆傞粯璁ゅ硷細"O1"銆 - - **jit_level** (str) - 璁剧疆缂栬瘧浼樺寲鐨勭骇鍒紝鏀寔["O0", "O1", "O2"]銆傞粯璁ゅ: "O1"銆 + - "O0": 鍩虹浼樺寲銆 + - "O1": 鎵嬪姩浼樺寲銆 + - "O2": 鎵嬪姩浼樺寲涓庡浘绠椾紭鍖栫粨鍚堛 - - "O0": 鍩虹浼樺寲銆 - - "O1": 鎵嬪姩浼樺寲銆 - - "O2": 鎵嬪姩浼樺寲涓庡浘绠椾紭鍖栫粨鍚堛 - - - **task_sink** (bool) - 鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆傞粯璁ゅ硷細True銆 - - **kwargs** (dict) - 鍏抽敭瀛楀弬鏁板瓧鍏搞 + - **task_sink** (bool) - 鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆傞粯璁ゅ硷細True銆 + - **kwargs** (dict) - 鍏抽敭瀛楀弬鏁板瓧鍏搞 diff --git a/docs/api/api_python/mindspore/mindspore.LambdaCallback.rst b/docs/api/api_python/mindspore/mindspore.LambdaCallback.rst index 0f9643708f0..fc1f484b558 100644 --- a/docs/api/api_python/mindspore/mindspore.LambdaCallback.rst +++ b/docs/api/api_python/mindspore/mindspore.LambdaCallback.rst @@ -12,17 +12,16 @@ mindspore.LambdaCallback .. note:: - 杩欐槸涓涓細鍙樻洿鎴栧垹闄ょ殑瀹為獙鎬ф帴鍙ｃ - **鍙傛暟锛** - - - **on_train_epoch_begin** (Function) - 璁粌姣忎釜epoch寮濮嬫椂琚皟鐢ㄣ - - **on_train_epoch_end** (Function) - 璁粌姣忎釜epoch缁撴潫鏃惰璋冪敤銆 - - **on_train_step_begin** (Function) - 璁粌姣忎釜step寮濮嬫椂琚皟鐢ㄣ - - **on_train_step_end** (Function) - 璁粌姣忎釜step缁撴潫鏃惰璋冪敤銆 - - **on_train_begin** (Function) - 妯″瀷璁粌寮濮嬫椂琚皟鐢ㄣ - - **on_train_end** (Function) - 妯″瀷璁粌缁撴潫鏃惰璋冪敤銆 - - **on_eval_epoch_begin** (Function) - 鎺ㄧ悊鐨別poch寮濮嬫椂琚皟鐢ㄣ - - **on_eval_epoch_end** (Function) - 鎺ㄧ悊鐨別poch缁撴潫鏃惰璋冪敤銆 - - **on_eval_step_begin** (Function) - 鎺ㄧ悊鐨勬瘡涓猻tep寮濮嬫椂琚皟鐢ㄣ - - **on_eval_step_end** (Function) - 鎺ㄧ悊鐨勬瘡涓猻tep缁撴潫鏃惰璋冪敤銆 - - **on_eval_begin** (Function) - 妯″瀷鎺ㄧ悊寮濮嬫椂琚皟鐢ㄣ - - **on_eval_end** (Function) - 妯″瀷鎺ㄧ悊缁撴潫鏃惰璋冪敤銆 + 鍙傛暟锛 + - **on_train_epoch_begin** (Function) - 璁粌姣忎釜epoch寮濮嬫椂琚皟鐢ㄣ + - **on_train_epoch_end** (Function) - 璁粌姣忎釜epoch缁撴潫鏃惰璋冪敤銆 + - **on_train_step_begin** (Function) - 璁粌姣忎釜step寮濮嬫椂琚皟鐢ㄣ + - **on_train_step_end** (Function) - 璁粌姣忎釜step缁撴潫鏃惰璋冪敤銆 + - **on_train_begin** (Function) - 妯″瀷璁粌寮濮嬫椂琚皟鐢ㄣ + - **on_train_end** (Function) - 妯″瀷璁粌缁撴潫鏃惰璋冪敤銆 + - **on_eval_epoch_begin** (Function) - 鎺ㄧ悊鐨別poch寮濮嬫椂琚皟鐢ㄣ + - **on_eval_epoch_end** (Function) - 鎺ㄧ悊鐨別poch缁撴潫鏃惰璋冪敤銆 + - **on_eval_step_begin** (Function) - 鎺ㄧ悊鐨勬瘡涓猻tep寮濮嬫椂琚皟鐢ㄣ + - **on_eval_step_end** (Function) - 鎺ㄧ悊鐨勬瘡涓猻tep缁撴潫鏃惰璋冪敤銆 + - **on_eval_begin** (Function) - 妯″瀷鎺ㄧ悊寮濮嬫椂琚皟鐢ㄣ + - **on_eval_end** (Function) - 妯″瀷鎺ㄧ悊缁撴潫鏃惰璋冪敤銆 diff --git a/docs/api/api_python/mindspore/mindspore.LearningRateScheduler.rst b/docs/api/api_python/mindspore/mindspore.LearningRateScheduler.rst index b23230a04be..edce63697e8 100644 --- a/docs/api/api_python/mindspore/mindspore.LearningRateScheduler.rst +++ b/docs/api/api_python/mindspore/mindspore.LearningRateScheduler.rst @@ -5,14 +5,12 @@ mindspore.LearningRateScheduler 鐢ㄤ簬鍦ㄨ缁冩湡闂存洿鏀瑰涔犵巼銆 - **鍙傛暟锛** - - - **learning_rate_function** (Function) - 鍦ㄨ缁冩湡闂存洿鏀瑰涔犵巼鐨勫嚱鏁般 + 鍙傛暟锛 + - **learning_rate_function** (Function) - 鍦ㄨ缁冩湡闂存洿鏀瑰涔犵巼鐨勫嚱鏁般 .. py:method:: step_end(run_context) 鍦╯tep缁撴潫鏃舵洿鏀瑰涔犵巼銆 - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭 diff --git a/docs/api/api_python/mindspore/mindspore.LossMonitor.rst b/docs/api/api_python/mindspore/mindspore.LossMonitor.rst index 7697b1f5c44..fad62190b44 100644 --- a/docs/api/api_python/mindspore/mindspore.LossMonitor.rst +++ b/docs/api/api_python/mindspore/mindspore.LossMonitor.rst @@ -10,26 +10,22 @@ mindspore.LossMonitor .. note:: 濡傛灉 `per_print_times` 涓0锛屽垯涓嶆墦鍗發oss銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **per_print_times** (int) - 琛ㄧず姣忛殧澶氬皯涓猻tep鎵撳嵃涓娆oss銆傞粯璁ゅ硷細1銆 - - **per_print_times** (int) - 琛ㄧず姣忛殧澶氬皯涓猻tep鎵撳嵃涓娆oss銆傞粯璁ゅ硷細1銆 - - **寮傚父锛** - - - **ValueError** - 褰 `per_print_times` 涓嶆槸鏁存暟鎴栧皬浜庨浂銆 + 寮傚父锛 + - **ValueError** - 褰 `per_print_times` 涓嶆槸鏁存暟鎴栧皬浜庨浂銆 .. py:method:: step_end(run_context) step缁撴潫鏃舵墦鍗拌缁僱oss銆 - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勭浉鍏充俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勭浉鍏充俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 .. py:method:: on_train_epoch_end(run_context) LossMoniter鐢ㄤ簬 `model.fit`锛屽嵆杈硅缁冭竟鎺ㄧ悊鍦烘櫙鏃讹紝鎵撳嵃璁粌鐨刲oss鍜屽綋鍓峞poch鎺ㄧ悊鐨刴etrics銆 - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勭浉鍏充俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勭浉鍏充俊鎭傝鎯呰鍙傝 :class:`mindspore.RunContext`銆 diff --git a/docs/api/api_python/mindspore/mindspore.LossScaleManager.rst b/docs/api/api_python/mindspore/mindspore.LossScaleManager.rst index 09ca7248cca..848575ad526 100644 --- a/docs/api/api_python/mindspore/mindspore.LossScaleManager.rst +++ b/docs/api/api_python/mindspore/mindspore.LossScaleManager.rst @@ -21,6 +21,5 @@ mindspore.LossScaleManager 根据 `overflow` 状态更新梯度放大系数（loss scale)。 - **参数：** - - - **overflow** (bool) - 表示训练过程是否溢出。 \ No newline at end of file + 参数： + - **overflow** (bool) - 表示训练过程是否溢出。 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/mindspore.Model.rst b/docs/api/api_python/mindspore/mindspore.Model.rst index f5eec79e094..90b112c26ef 100644 --- a/docs/api/api_python/mindspore/mindspore.Model.rst +++ b/docs/api/api_python/mindspore/mindspore.Model.rst @@ -9,34 +9,33 @@ 濡傛灉浣跨敤娣峰悎绮惧害鍔熻兘锛岄渶瑕佸悓鏃惰缃 `optimizer` 鍙傛暟锛屽惁鍒欐贩鍚堢簿搴﹀姛鑳戒笉鐢熸晥銆 褰撲娇鐢ㄦ贩鍚堢簿搴︽椂锛屼紭鍖栧櫒涓殑 `global_step` 鍙兘涓庢ā鍨嬩腑鐨 `cur_step_num` 涓嶅悓銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **network** (Cell) - 鐢ㄤ簬璁粌鎴栨帹鐞嗙殑绁炵粡缃戠粶銆 + - **loss_fn** (Cell) - 鎹熷け鍑芥暟銆傚鏋 `loss_fn` 涓篘one锛宍network` 涓渶瑕佽繘琛屾崯澶卞嚱鏁拌绠楋紝蹇呰鏃朵篃闇瑕佽繘琛屽苟琛岃绠椼傞粯璁ゅ硷細None銆 + - **optimizer** (Cell) - 鐢ㄤ簬鏇存柊缃戠粶鏉冮噸鐨勪紭鍖栧櫒銆傚鏋 `optimizer` 涓篘one锛 `network` 涓渶瑕佽繘琛屽弽鍚戜紶鎾拰缃戠粶鏉冮噸鏇存柊銆傞粯璁ゅ硷細None銆 + - **metrics** (Union[dict, set]) - 鐢ㄤ簬妯″瀷璇勪及鐨勪竴缁勮瘎浠峰嚱鏁般備緥濡傦細{'accuracy', 'recall'}銆傞粯璁ゅ硷細None銆 + - **eval_network** (Cell) - 鐢ㄤ簬璇勪及鐨勭缁忕綉缁溿傛湭瀹氫箟鎯呭喌涓嬶紝`Model` 浼氫娇鐢 `network` 鍜 `loss_fn` 灏佽涓涓 `eval_network` 銆傞粯璁ゅ硷細None銆 + - **eval_indexes** (list) - 鍦ㄥ畾涔 `eval_network` 鐨勬儏鍐典笅浣跨敤銆傚鏋 `eval_indexes` 涓洪粯璁ゅ糔one锛宍Model` 浼氬皢 `eval_network` 鐨勬墍鏈夎緭鍑轰紶缁 `metrics` 銆傚鏋滈厤缃 `eval_indexes` 锛屽繀椤诲寘鍚笁涓厓绱狅紝鍒嗗埆涓烘崯澶卞笺侀娴嬪煎拰鏍囩鍦 `eval_network` 杈撳嚭涓殑浣嶇疆锛屾鏃讹紝鎹熷け鍊煎皢浼犵粰鎹熷け璇勪环鍑芥暟锛岄娴嬪煎拰鏍囩灏嗕紶缁欏叾浠栬瘎浠峰嚱鏁般傛帹鑽愪娇鐢ㄨ瘎浠峰嚱鏁扮殑 `mindspore.nn.Metric.set_indexes` 浠ｆ浛 `eval_indexes` 銆傞粯璁ゅ硷細None銆 + - **amp_level** (str) - `mindspore.build_train_network` 鐨勫彲閫夊弬鏁 `level` 锛 `level` 涓烘贩鍚堢簿搴︾瓑绾э紝璇ュ弬鏁版敮鎸乕"O0", "O2", "O3", "auto"]銆傞粯璁ゅ硷細"O0"銆 - - **network** (Cell) 鈥 鐢ㄤ簬璁粌鎴栨帹鐞嗙殑绁炵粡缃戠粶銆 - - **loss_fn** (Cell) - 鎹熷け鍑芥暟銆傚鏋 `loss_fn` 涓篘one锛宍network` 涓渶瑕佽繘琛屾崯澶卞嚱鏁拌绠楋紝蹇呰鏃朵篃闇瑕佽繘琛屽苟琛岃绠椼傞粯璁ゅ硷細None銆 - - **optimizer** (Cell) - 鐢ㄤ簬鏇存柊缃戠粶鏉冮噸鐨勪紭鍖栧櫒銆傚鏋 `optimizer` 涓篘one锛 `network` 涓渶瑕佽繘琛屽弽鍚戜紶鎾拰缃戠粶鏉冮噸鏇存柊銆傞粯璁ゅ硷細None銆 - - **metrics** (Union[dict, set]) - 鐢ㄤ簬妯″瀷璇勪及鐨勪竴缁勮瘎浠峰嚱鏁般備緥濡傦細{'accuracy', 'recall'}銆傞粯璁ゅ硷細None銆 - - **eval_network** (Cell) - 鐢ㄤ簬璇勪及鐨勭缁忕綉缁溿傛湭瀹氫箟鎯呭喌涓嬶紝`Model` 浼氫娇鐢 `network` 鍜 `loss_fn` 灏佽涓涓 `eval_network` 銆傞粯璁ゅ硷細None銆 - - **eval_indexes** (list) - 鍦ㄥ畾涔 `eval_network` 鐨勬儏鍐典笅浣跨敤銆傚鏋 `eval_indexes` 涓洪粯璁ゅ糔one锛宍Model` 浼氬皢 `eval_network` 鐨勬墍鏈夎緭鍑轰紶缁 `metrics` 銆傚鏋滈厤缃 `eval_indexes` 锛屽繀椤诲寘鍚笁涓厓绱狅紝鍒嗗埆涓烘崯澶卞笺侀娴嬪煎拰鏍囩鍦 `eval_network` 杈撳嚭涓殑浣嶇疆锛屾鏃讹紝鎹熷け鍊煎皢浼犵粰鎹熷け璇勪环鍑芥暟锛岄娴嬪煎拰鏍囩灏嗕紶缁欏叾浠栬瘎浠峰嚱鏁般傛帹鑽愪娇鐢ㄨ瘎浠峰嚱鏁扮殑 `mindspore.nn.Metric.set_indexes` 浠ｆ浛 `eval_indexes` 銆傞粯璁ゅ硷細None銆 - - **amp_level** (str) - `mindspore.build_train_network` 鐨勫彲閫夊弬鏁 `level` 锛 `level` 涓烘贩鍚堢簿搴︾瓑绾э紝璇ュ弬鏁版敮鎸乕"O0", "O2", "O3", "auto"]銆傞粯璁ゅ硷細"O0"銆 + - "O0": 涓嶅彉鍖栥 + - "O2": 灏嗙綉缁滅簿搴﹁浆涓篺loat16锛孊atchNorm淇濇寔float32绮惧害锛屼娇鐢ㄥ姩鎬佽皟鏁存崯澶辩缉鏀剧郴鏁帮紙loss scale锛夌殑绛栫暐銆 + - "O3": 灏嗙綉缁滅簿搴︼紙鍖呮嫭BatchNorm锛夎浆涓篺loat16锛屼笉浣跨敤鎹熷け缂╂斁绛栫暐銆 + - auto: 涓轰笉鍚屽鐞嗗櫒璁剧疆涓撳鎺ㄨ崘鐨勬贩鍚堢簿搴︾瓑绾э紝濡傚湪GPU涓婅涓"O2"锛屽湪Ascend涓婅涓"O3"銆傝璁剧疆鏂瑰紡鍙兘鍦ㄩ儴鍒嗗満鏅笅涓嶉傜敤锛屽缓璁敤鎴锋牴鎹叿浣撶殑缃戠粶妯″瀷鑷畾涔夎缃 `amp_level` 銆 - - "O0": 涓嶅彉鍖栥 - - "O2": 灏嗙綉缁滅簿搴﹁浆涓篺loat16锛孊atchNorm淇濇寔float32绮惧害锛屼娇鐢ㄥ姩鎬佽皟鏁存崯澶辩缉鏀剧郴鏁帮紙loss scale锛夌殑绛栫暐銆 - - "O3": 灏嗙綉缁滅簿搴︼紙鍖呮嫭BatchNorm锛夎浆涓篺loat16锛屼笉浣跨敤鎹熷け缂╂斁绛栫暐銆 - - auto: 涓轰笉鍚屽鐞嗗櫒璁剧疆涓撳鎺ㄨ崘鐨勬贩鍚堢簿搴︾瓑绾э紝濡傚湪GPU涓婅涓"O2"锛屽湪Ascend涓婅涓"O3"銆傝璁剧疆鏂瑰紡鍙兘鍦ㄩ儴鍒嗗満鏅笅涓嶉傜敤锛屽缓璁敤鎴锋牴鎹叿浣撶殑缃戠粶妯″瀷鑷畾涔夎缃 `amp_level` 銆 + 鍦℅PU涓婂缓璁娇鐢"O2"锛屽湪Ascend涓婂缓璁娇鐢"O3"銆 + 閫氳繃 `kwargs` 璁剧疆 `keep_batchnorm_fp32` 锛屽彲淇敼BatchNorm鐨勭簿搴︾瓥鐣ワ紝 `keep_batchnorm_fp32` 蹇呴』涓篵ool绫诲瀷锛涢氳繃 `kwargs` 璁剧疆 `loss_scale_manager` 鍙慨鏀规崯澶辩缉鏀剧瓥鐣ワ紝`loss_scale_manager` 蹇呴』涓 :class:`mindspore.LossScaleManager` 鐨勫瓙绫伙紝 + 鍏充簬 `amp_level` 璇﹁ `mindpore.build_train_network` 銆 - 鍦℅PU涓婂缓璁娇鐢"O2"锛屽湪Ascend涓婂缓璁娇鐢"O3"銆 - 閫氳繃 `kwargs` 璁剧疆 `keep_batchnorm_fp32` 锛屽彲淇敼BatchNorm鐨勭簿搴︾瓥鐣ワ紝 `keep_batchnorm_fp32` 蹇呴』涓篵ool绫诲瀷锛涢氳繃 `kwargs` 璁剧疆 `loss_scale_manager` 鍙慨鏀规崯澶辩缉鏀剧瓥鐣ワ紝`loss_scale_manager` 蹇呴』涓 :class:`mindspore.LossScaleManager` 鐨勫瓙绫伙紝 - 鍏充簬 `amp_level` 璇﹁ `mindpore.build_train_network` 銆 + - **boost_level** (str) - `mindspore.boost` 鐨勫彲閫夊弬鏁帮紝涓篵oost妯″紡璁粌绛夌骇銆傛敮鎸乕"O0", "O1", "O2"]. 榛樿鍊硷細"O0"銆 - - **boost_level** (str) 鈥 `mindspore.boost` 鐨勫彲閫夊弬鏁, 涓篵oost妯″紡璁粌绛夌骇銆傛敮鎸乕鈥淥0鈥, 鈥淥1鈥, 鈥淥2鈥漖. 榛樿鍊: 鈥淥0鈥. + - "O0": 涓嶅彉鍖栥 + - "O1": 鍚敤boost妯″紡锛屾ц兘灏嗘彁鍗囩害20%锛屽噯纭巼淇濇寔涓嶅彉銆 + - "O2": 鍚敤boost妯″紡锛屾ц兘灏嗘彁鍗囩害30%锛屽噯纭巼涓嬮檷灏忎簬3%銆 - - "O0": 涓嶅彉鍖栥 - - "O1": 鍚敤boost妯″紡, 鎬ц兘灏嗘彁鍗囩害20%, 鍑嗙‘鐜囦繚鎸佷笉鍙樸 - - "O2": 鍚敤boost妯″紡, 鎬ц兘灏嗘彁鍗囩害30%, 鍑嗙‘鐜囦笅闄嶅皬浜3%銆 - - 濡傛灉鎯宠嚜琛岄厤缃産oost妯″紡, 鍙互灏 `boost_config_dict` 璁剧疆涓 `boost.py`銆 - 涓轰娇鍔熻兘鐢熸晥锛岄渶瑕佸悓鏃惰缃畂ptimizer銆乪val_network鎴杕etric鍙傛暟銆 - 娉ㄦ剰锛氬綋鍓嶉粯璁ゅ紑鍚殑浼樺寲浠呴傜敤閮ㄥ垎缃戠粶锛屽苟闈炴墍鏈夌綉缁滈兘鑳借幏寰楃浉鍚屾敹鐩娿傚缓璁湪鍥炬ā寮+Ascend骞冲彴涓嬪紑鍚妯″紡锛屽悓鏃朵负浜嗚幏鍙栨洿濂界殑鍔犻熸晥鏋滐紝璇峰弬鑰冩枃妗ｉ厤缃産oost_config_dict銆 + 濡傛灉鎯宠嚜琛岄厤缃産oost妯″紡锛屽彲浠ュ皢 `boost_config_dict` 璁剧疆涓 `boost.py`銆 + 涓轰娇鍔熻兘鐢熸晥锛岄渶瑕佸悓鏃惰缃畂ptimizer銆乪val_network鎴杕etric鍙傛暟銆 + 娉ㄦ剰锛氬綋鍓嶉粯璁ゅ紑鍚殑浼樺寲浠呴傜敤閮ㄥ垎缃戠粶锛屽苟闈炴墍鏈夌綉缁滈兘鑳借幏寰楃浉鍚屾敹鐩娿傚缓璁湪鍥炬ā寮+Ascend骞冲彴涓嬪紑鍚妯″紡锛屽悓鏃朵负浜嗚幏鍙栨洿濂界殑鍔犻熸晥鏋滐紝璇峰弬鑰冩枃妗ｉ厤缃産oost_config_dict銆 .. py:method:: build(train_dataset=None, valid_dataset=None, sink_size=-1, epoch=1) @@ -46,12 +45,11 @@ .. note:: 濡傛灉棰勫厛璋冪敤璇ユ帴鍙ｆ瀯寤鸿绠楀浘锛岄偅涔 `Model.train` 浼氱洿鎺ユ墽琛岃绠楀浘銆傞鏋勫缓璁＄畻鍥剧洰鍓嶄粎鏀寔GRAPH_MOD妯″紡鍜孉scend澶勭悊鍣紝浠呮敮鎸佹暟鎹笅娌夋ā寮忋 - **鍙傛暟锛** - - - **train_dataset** (Dataset) 鈥 涓涓缁冮泦杩唬鍣ㄣ傚鏋滃畾涔変簡 `train_dataset` 锛屽皢浼氭瀯寤鸿缁冭绠楀浘銆傞粯璁ゅ硷細None銆 - - **valid_dataset** (Dataset) - 涓涓獙璇侀泦杩唬鍣ㄣ傚鏋滃畾涔変簡 `valid_dataset` 锛屽皢浼氭瀯寤洪獙璇佽绠楀浘锛屾鏃 `Model` 涓殑 `metrics` 涓嶈兘涓篘one銆傞粯璁ゅ硷細None銆 - - **sink_size** (int) - 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺銆傞粯璁ゅ硷細-1銆 - - **epoch** (int) - 鎺у埗璁粌杞銆傞粯璁ゅ硷細1銆 + 鍙傛暟锛 + - **train_dataset** (Dataset) - 涓涓缁冮泦杩唬鍣ㄣ傚鏋滃畾涔変簡 `train_dataset` 锛屽皢浼氭瀯寤鸿缁冭绠楀浘銆傞粯璁ゅ硷細None銆 + - **valid_dataset** (Dataset) - 涓涓獙璇侀泦杩唬鍣ㄣ傚鏋滃畾涔変簡 `valid_dataset` 锛屽皢浼氭瀯寤洪獙璇佽绠楀浘锛屾鏃 `Model` 涓殑 `metrics` 涓嶈兘涓篘one銆傞粯璁ゅ硷細None銆 + - **sink_size** (int) - 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺銆傞粯璁ゅ硷細-1銆 + - **epoch** (int) - 鎺у埗璁粌杞銆傞粯璁ゅ硷細1銆 .. py:method:: eval(valid_dataset, callbacks=None, dataset_sink_mode=True) @@ -63,24 +61,21 @@ 濡傛灉 `dataset_sink_mode` 閰嶇疆涓篢rue锛屾暟鎹皢琚彂閫佸埌澶勭悊鍣ㄤ腑銆傛鏃舵暟鎹泦涓庢ā鍨嬬粦瀹氾紝鏁版嵁闆嗕粎鑳藉湪褰撳墠妯″瀷涓娇鐢ㄣ傚鏋滃鐞嗗櫒鏄疉scend锛屾暟鎹壒寰佸皢琚愪竴浼犺緭锛屾瘡娆℃暟鎹紶杈撶殑涓婇檺鏄256M銆 璇ユ帴鍙ｄ細鏋勫缓骞舵墽琛岃绠楀浘锛屽鏋滀娇鐢ㄥ墠鍏堟墽琛屼簡 `Model.build` 锛岄偅涔堝畠浼氱洿鎺ユ墽琛岃绠楀浘鑰屼笉鏋勫缓銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **valid_dataset** (Dataset) - 璇勪及妯″瀷鐨勬暟鎹泦銆 + - **callbacks** (Optional[list(Callback), Callback]) - 璇勪及杩囩▼涓渶瑕佹墽琛岀殑鍥炶皟瀵硅薄鎴栧洖璋冨璞″垪琛ㄣ傞粯璁ゅ硷細None銆 + - **dataset_sink_mode** (bool) - 鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆傞粯璁ゅ硷細True銆 - - **valid_dataset** (Dataset) 鈥 璇勪及妯″瀷鐨勬暟鎹泦銆 - - **callbacks** (Optional[list(Callback), Callback]) - 璇勪及杩囩▼涓渶瑕佹墽琛岀殑鍥炶皟瀵硅薄鎴栧洖璋冨璞″垪琛ㄣ傞粯璁ゅ硷細None銆 - - **dataset_sink_mode** (bool) - 鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆傞粯璁ゅ硷細True銆 - - **杩斿洖锛** - - Dict锛宬ey鏄敤鎴峰畾涔夌殑璇勪环鎸囨爣鍚嶇О锛寁alue鏄互鎺ㄧ悊妯″紡杩愯鐨勮瘎浼扮粨鏋溿 + 杩斿洖锛 + Dict锛宬ey鏄敤鎴峰畾涔夌殑璇勪环鎸囨爣鍚嶇О锛寁alue鏄互鎺ㄧ悊妯″紡杩愯鐨勮瘎浼扮粨鏋溿 .. py:method:: eval_network :property: 鑾峰彇璇ユā鍨嬬殑璇勪环缃戠粶銆 - **杩斿洖锛** - - 璇勪及缃戠粶瀹炰緥銆 + 杩斿洖锛 + 璇勪及缃戠粶瀹炰緥銆 .. py:method:: infer_predict_layout(*predict_data) @@ -88,17 +83,14 @@ .. note:: 鍚屼竴鎵规鏁版嵁搴旀斁鍦ㄤ竴涓紶閲忎腑銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **predict_data** (Tensor) - 棰勬祴鏍锋湰锛屾暟鎹彲浠ユ槸鍗曚釜寮犻噺銆佸紶閲忓垪琛ㄦ垨寮犻噺鍏冪粍銆 - - **predict_data** (Tensor) 鈥 棰勬祴鏍锋湰锛屾暟鎹彲浠ユ槸鍗曚釜寮犻噺銆佸紶閲忓垪琛ㄦ垨寮犻噺鍏冪粍銆 + 杩斿洖锛 + Dict锛岀敤浜庡姞杞藉垎甯冨紡checkpoint鐨勫弬鏁發ayout瀛楀吀銆傚畠鎬绘槸浣滀负 `load_distributed_checkpoint()` 鍑芥暟鐨勪竴涓叆鍙傘 - **杩斿洖锛** - - Dict锛岀敤浜庡姞杞藉垎甯冨紡checkpoint鐨勫弬鏁發ayout瀛楀吀銆傚畠鎬绘槸浣滀负 `load_distributed_checkpoint()` 鍑芥暟鐨勪竴涓叆鍙傘 - - **寮傚父锛** - - - **RuntimeError** 鈥 闈炲浘妯″紡锛圙RAPH_MODE锛夊皢浼氭姏鍑鸿寮傚父銆 + 寮傚父锛 + - **RuntimeError** - 闈炲浘妯″紡锛圙RAPH_MODE锛夊皢浼氭姏鍑鸿寮傚父銆 .. py:method:: infer_train_layout(train_dataset, dataset_sink_mode=True, sink_size=-1) @@ -108,36 +100,31 @@ .. note:: 杩欐槸涓涓缂栬瘧鍑芥暟銆傚弬鏁板繀椤讳笌Model.train()鍑芥暟鐩稿悓銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **train_dataset** (Dataset) - 涓涓缁冩暟鎹泦杩唬鍣ㄣ傚鏋滄病鏈夋崯澶卞嚱鏁帮紙loss_fn锛夛紝杩斿洖涓涓寘鍚涓暟鎹殑鍏冪粍锛坉ata1, data2, data3, ...锛夊苟浼犻掔粰缃戠粶銆傚惁鍒欙紝杩斿洖涓涓厓缁勶紙data, label锛夛紝鏁版嵁鍜屾爣绛惧皢琚垎鍒紶閫掔粰缃戠粶鍜屾崯澶卞嚱鏁般 + - **dataset_sink_mode** (bool) - 鍐冲畾鏄惁浠ユ暟鎹泦涓嬫矇妯″紡杩涜璁粌銆傞粯璁ゅ硷細True銆侾yNative妯″紡涓嬫垨澶勭悊鍣ㄤ负CPU鏃讹紝璁粌妯″瀷娴佺▼浣跨敤鐨勬槸鏁版嵁涓嶄笅娌夛紙non-sink锛夋ā寮忋傞粯璁ゅ硷細True銆 + - **sink_size** (int) - 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺锛屽鏋 `sink_size` =-1锛屽垯姣忎竴娆poch涓嬫矇瀹屾暣鏁版嵁闆嗐傚鏋 `sink_size` >0锛屽垯姣忎竴娆poch涓嬫矇鏁版嵁閲忎负 `sink_size` 鐨勬暟鎹泦銆傚鏋 `dataset_sink_mode` 涓篎alse锛屽垯璁剧疆 `sink_size` 涓烘棤鏁堛傞粯璁ゅ硷細-1銆 - - **train_dataset** (Dataset) 鈥 涓涓缁冩暟鎹泦杩唬鍣ㄣ傚鏋滄病鏈夋崯澶卞嚱鏁帮紙loss_fn锛夛紝杩斿洖涓涓寘鍚涓暟鎹殑鍏冪粍锛坉ata1, data2, data3, ...锛夊苟浼犻掔粰缃戠粶銆傚惁鍒欙紝杩斿洖涓涓厓缁勶紙data, label锛夛紝鏁版嵁鍜屾爣绛惧皢琚垎鍒紶閫掔粰缃戠粶鍜屾崯澶卞嚱鏁般 - - **dataset_sink_mode** (bool) 鈥 鍐冲畾鏄惁浠ユ暟鎹泦涓嬫矇妯″紡杩涜璁粌銆傞粯璁ゅ硷細True銆侾yNative妯″紡涓嬫垨澶勭悊鍣ㄤ负CPU鏃讹紝璁粌妯″瀷娴佺▼浣跨敤鐨勬槸鏁版嵁涓嶄笅娌夛紙non-sink锛夋ā寮忋傞粯璁ゅ硷細True銆 - - **sink_size** (int) 鈥 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺锛屽鏋 `sink_size` =-1锛屽垯姣忎竴娆poch涓嬫矇瀹屾暣鏁版嵁闆嗐傚鏋 `sink_size` >0锛屽垯姣忎竴娆poch涓嬫矇鏁版嵁閲忎负 `sink_size` 鐨勬暟鎹泦銆傚鏋 `dataset_sink_mode` 涓篎alse锛屽垯璁剧疆 `sink_size` 涓烘棤鏁堛傞粯璁ゅ硷細-1銆 - - **杩斿洖锛** - - Dict锛岀敤浜庡姞杞藉垎甯冨紡checkpoint鐨勫弬鏁發ayout瀛楀吀銆 + 杩斿洖锛 + Dict锛岀敤浜庡姞杞藉垎甯冨紡checkpoint鐨勫弬鏁發ayout瀛楀吀銆 .. py:method:: predict(*predict_data) 杈撳叆鏍锋湰寰楀埌棰勬祴缁撴灉銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **predict_data** (Tensor) - 棰勬祴鏍锋湰锛屾暟鎹彲浠ユ槸鍗曚釜寮犻噺銆佸紶閲忓垪琛ㄦ垨寮犻噺鍏冪粍銆 - **predict_data** (Tensor) 鈥 棰勬祴鏍锋湰锛屾暟鎹彲浠ユ槸鍗曚釜寮犻噺銆佸紶閲忓垪琛ㄦ垨寮犻噺鍏冪粍銆 - - **杩斿洖锛** - - 杩斿洖棰勬祴缁撴灉锛岀被鍨嬫槸Tensor鎴朤ensor鍏冪粍銆 + 杩斿洖锛 + 杩斿洖棰勬祴缁撴灉锛岀被鍨嬫槸Tensor鎴朤ensor鍏冪粍銆 .. py:method:: predict_network :property: 鑾峰緱璇ユā鍨嬬殑棰勬祴缃戠粶銆 - **杩斿洖锛** - - 棰勬祴缃戠粶瀹炰緥銆 + 杩斿洖锛 + 棰勬祴缃戠粶瀹炰緥銆 .. py:method:: train(epoch, train_dataset, callbacks=None, dataset_sink_mode=True, sink_size=-1, initial_epoch=0) @@ -152,14 +139,13 @@ - 濡傛灉 `sink_size` 澶т簬闆讹紝姣忔epoch鍙互鏃犻檺娆￠亶鍘嗘暟鎹泦锛岀洿鍒伴亶鍘嗘暟鎹噺绛変簬 `sink_size` 涓烘銆 - 姣忔epoch灏嗕粠涓婁竴娆￠亶鍘嗙殑鏈鍚庝綅缃户缁紑濮嬮亶鍘嗐傝鎺ュ彛浼氭瀯寤哄苟鎵ц璁＄畻鍥撅紝濡傛灉浣跨敤鍓嶅厛鎵ц浜 `Model.build` 锛岄偅涔堝畠浼氱洿鎺ユ墽琛岃绠楀浘鑰屼笉鏋勫缓銆 - **鍙傛暟锛** - - - **epoch** (int) 鈥 璁粌鎵ц杞銆傞氬父姣忎釜epoch閮戒細浣跨敤鍏ㄩ噺鏁版嵁闆嗚繘琛岃缁冦傚綋 `dataset_sink_mode` 璁剧疆涓篢rue涓 `sink_size` 澶т簬闆舵椂锛屽垯姣忎釜epoch璁粌娆℃暟涓 `sink_size` 鑰屼笉鏄暟鎹泦鐨勬绘鏁般傚鏋 `epoch` 涓 `initial_epoch` 涓璧蜂娇鐢紝瀹冭〃绀鸿缁冪殑鏈鍚庝竴涓 `epoch` 鏄灏戙 - - **train_dataset** (Dataset) 鈥 涓涓缁冩暟鎹泦杩唬鍣ㄣ傚鏋滃畾涔変簡 `loss_fn` 锛屽垯鏁版嵁鍜屾爣绛句細琚垎鍒紶缁 `network` 鍜 `loss_fn` 锛屾鏃舵暟鎹泦闇瑕佽繑鍥炰竴涓厓缁勶紙data, label锛夈傚鏋滄暟鎹泦涓湁澶氫釜鏁版嵁鎴栬呮爣绛撅紝鍙互璁剧疆 `loss_fn` 涓篘one锛屽苟鍦 `network` 涓疄鐜版崯澶卞嚱鏁拌绠楋紝姝ゆ椂鏁版嵁闆嗚繑鍥炵殑鎵鏈夋暟鎹粍鎴愮殑鍏冪粍锛坉ata1, data2, data3, ...锛変細浼犵粰 `network` 銆 - - **callbacks** (Optional[list[Callback], Callback]) 鈥 璁粌杩囩▼涓渶瑕佹墽琛岀殑鍥炶皟瀵硅薄鎴栬呭洖璋冨璞″垪琛ㄣ傞粯璁ゅ硷細None銆 - - **dataset_sink_mode** (bool) 鈥 鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆備娇鐢≒YNATIVE_MODE妯″紡鎴朇PU澶勭悊鍣ㄦ椂锛屾ā鍨嬭缁冩祦绋嬪皢浠ラ潪涓嬫矇妯″紡鎵ц銆傞粯璁ゅ硷細True銆 - - **sink_size** (int) 鈥 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺銆俙dataset_sink_mode` 涓篎alse鏃 `sink_size` 鏃犳晥銆傚鏋渟ink_size=-1锛屽垯姣忎竴娆poch涓嬫矇瀹屾暣鏁版嵁闆嗐傚鏋渟ink_size>0锛屽垯姣忎竴娆poch涓嬫矇鏁版嵁閲忎负sink_size鐨勬暟鎹泦銆傞粯璁ゅ硷細-1銆 - - **initial_epoch** (int) - 浠庡摢涓猠poch寮濮嬭缁冿紝涓鑸敤浜庝腑鏂仮澶嶈缁冨満鏅 + 鍙傛暟锛 + - **epoch** (int) - 璁粌鎵ц杞銆傞氬父姣忎釜epoch閮戒細浣跨敤鍏ㄩ噺鏁版嵁闆嗚繘琛岃缁冦傚綋 `dataset_sink_mode` 璁剧疆涓篢rue涓 `sink_size` 澶т簬闆舵椂锛屽垯姣忎釜epoch璁粌娆℃暟涓 `sink_size` 鑰屼笉鏄暟鎹泦鐨勬绘鏁般傚鏋 `epoch` 涓 `initial_epoch` 涓璧蜂娇鐢紝瀹冭〃绀鸿缁冪殑鏈鍚庝竴涓 `epoch` 鏄灏戙 + - **train_dataset** (Dataset) - 涓涓缁冩暟鎹泦杩唬鍣ㄣ傚鏋滃畾涔変簡 `loss_fn` 锛屽垯鏁版嵁鍜屾爣绛句細琚垎鍒紶缁 `network` 鍜 `loss_fn` 锛屾鏃舵暟鎹泦闇瑕佽繑鍥炰竴涓厓缁勶紙data, label锛夈傚鏋滄暟鎹泦涓湁澶氫釜鏁版嵁鎴栬呮爣绛撅紝鍙互璁剧疆 `loss_fn` 涓篘one锛屽苟鍦 `network` 涓疄鐜版崯澶卞嚱鏁拌绠楋紝姝ゆ椂鏁版嵁闆嗚繑鍥炵殑鎵鏈夋暟鎹粍鎴愮殑鍏冪粍锛坉ata1, data2, data3, ...锛変細浼犵粰 `network` 銆 + - **callbacks** (Optional[list[Callback], Callback]) - 璁粌杩囩▼涓渶瑕佹墽琛岀殑鍥炶皟瀵硅薄鎴栬呭洖璋冨璞″垪琛ㄣ傞粯璁ゅ硷細None銆 + - **dataset_sink_mode** (bool) - 鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆備娇鐢≒YNATIVE_MODE妯″紡鎴朇PU澶勭悊鍣ㄦ椂锛屾ā鍨嬭缁冩祦绋嬪皢浠ラ潪涓嬫矇妯″紡鎵ц銆傞粯璁ゅ硷細True銆 + - **sink_size** (int) - 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺銆俙dataset_sink_mode` 涓篎alse鏃 `sink_size` 鏃犳晥銆傚鏋渟ink_size=-1锛屽垯姣忎竴娆poch涓嬫矇瀹屾暣鏁版嵁闆嗐傚鏋渟ink_size>0锛屽垯姣忎竴娆poch涓嬫矇鏁版嵁閲忎负sink_size鐨勬暟鎹泦銆傞粯璁ゅ硷細-1銆 + - **initial_epoch** (int) - 浠庡摢涓猠poch寮濮嬭缁冿紝涓鑸敤浜庝腑鏂仮澶嶈缁冨満鏅 .. py:method:: fit(epoch, train_dataset, valid_dataset=None, valid_frequency=1, callbacks=None, dataset_sink_mode=True, valid_dataset_sink_mode=True, sink_size=-1, initial_epoch=0) @@ -167,23 +153,21 @@ 濡傛灉 `valid_dataset` 涓嶄负None锛屽湪璁粌杩囩▼涓悓鏃舵墽琛屾帹鐞嗐傛洿澶氳缁嗕俊鎭鍙傝 `mindspore.Model.model.train`銆 - **鍙傛暟锛** - - - **epoch** (int) 鈥 璁粌鎵ц杞銆傞氬父姣忎釜epoch閮戒細浣跨敤鍏ㄩ噺鏁版嵁闆嗚繘琛岃缁冦傚綋 `dataset_sink_mode` 璁剧疆涓篢rue涓 `sink_size` 澶т簬闆舵椂锛屽垯姣忎釜epoch璁粌娆℃暟涓 `sink_size` 鑰屼笉鏄暟鎹泦鐨勬绘鏁般傚鏋 `epoch` 涓 `initial_epoch` 涓璧蜂娇鐢紝瀹冭〃绀鸿缁冪殑鏈鍚庝竴涓 `epoch` 鏄灏戙 - - **train_dataset** (Dataset) 鈥 璁粌鏁版嵁闆嗚凯浠ｅ櫒銆傚鏋滃畾涔変簡 `loss_fn` 锛屽垯鏁版嵁鍜屾爣绛句細琚垎鍒紶缁 `network` 鍜 `loss_fn` 锛屾鏃舵暟鎹泦闇瑕佽繑鍥炰竴涓厓缁勶紙data, label锛夈傚鏋滄暟鎹泦涓湁澶氫釜鏁版嵁鎴栬呮爣绛撅紝鍙互璁剧疆 `loss_fn` 涓篘one锛屽苟鍦 `network` 涓疄鐜版崯澶卞嚱鏁拌绠楋紝姝ゆ椂鏁版嵁闆嗚繑鍥炵殑鎵鏈夋暟鎹粍鎴愮殑鍏冪粍锛坉ata1, data2, data3, ...锛変細浼犵粰 `network` 銆 - - **valid_dataset** (Dataset) 鈥 璇勪及妯″瀷鐨勬暟鎹泦杩唬鍣ㄣ傞粯璁ゅ硷細None銆 - - **valid_frequency** (int, list) 鈥 姝ゅ弬鏁板彧鏈夊湪valid_dataset涓嶄负None鏃剁敓鏁堛傚鏋滀负int绫诲瀷锛岃〃绀烘墽琛屾帹鐞嗙殑棰戠巼锛屼緥濡 `valid_frequency=2`锛屽垯姣2涓缁僥poch鎵ц涓娆℃帹鐞嗭紱濡傛灉涓簂ist绫诲瀷锛屾寚鏄庡湪鍝嚑涓猠poch鏃舵墽琛屾帹鐞嗭紝渚嬪 `valid_frequency=[1, 5]`锛屽垯鍦ㄧ1涓拰绗5涓猠poch鎵ц鎺ㄧ悊銆傞粯璁ゅ硷細1銆 - - **callbacks** (Optional[list[Callback], Callback]) 鈥 璁粌杩囩▼涓渶瑕佹墽琛岀殑鍥炶皟瀵硅薄鎴栬呭洖璋冨璞″垪琛ㄣ傞粯璁ゅ硷細None銆 - - **dataset_sink_mode** (bool) 鈥 璁粌鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆備娇鐢≒YNATIVE_MODE妯″紡鎴朇PU澶勭悊鍣ㄦ椂锛屾ā鍨嬭缁冩祦绋嬪皢浠ラ潪涓嬫矇妯″紡鎵ц銆傞粯璁ゅ硷細True銆 - - **valid_dataset_sink_mode** (bool) - 鎺ㄧ悊鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆傞粯璁ゅ硷細True銆 - - **sink_size** (int) 鈥 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺銆俙dataset_sink_mode` 涓篎alse鏃 `sink_size` 鏃犳晥銆傚鏋渟ink_size=-1锛屽垯姣忎竴娆poch涓嬫矇瀹屾暣鏁版嵁闆嗐傚鏋渟ink_size>0锛屽垯姣忎竴娆poch涓嬫矇鏁版嵁閲忎负sink_size鐨勬暟鎹泦銆傞粯璁ゅ硷細-1銆 - - **initial_epoch** (int) - 浠庡摢涓猠poch寮濮嬭缁冿紝涓鑸敤浜庝腑鏂仮澶嶈缁冨満鏅 + 鍙傛暟锛 + - **epoch** (int) - 璁粌鎵ц杞銆傞氬父姣忎釜epoch閮戒細浣跨敤鍏ㄩ噺鏁版嵁闆嗚繘琛岃缁冦傚綋 `dataset_sink_mode` 璁剧疆涓篢rue涓 `sink_size` 澶т簬闆舵椂锛屽垯姣忎釜epoch璁粌娆℃暟涓 `sink_size` 鑰屼笉鏄暟鎹泦鐨勬绘鏁般傚鏋 `epoch` 涓 `initial_epoch` 涓璧蜂娇鐢紝瀹冭〃绀鸿缁冪殑鏈鍚庝竴涓 `epoch` 鏄灏戙 + - **train_dataset** (Dataset) - 璁粌鏁版嵁闆嗚凯浠ｅ櫒銆傚鏋滃畾涔変簡 `loss_fn` 锛屽垯鏁版嵁鍜屾爣绛句細琚垎鍒紶缁 `network` 鍜 `loss_fn` 锛屾鏃舵暟鎹泦闇瑕佽繑鍥炰竴涓厓缁勶紙data, label锛夈傚鏋滄暟鎹泦涓湁澶氫釜鏁版嵁鎴栬呮爣绛撅紝鍙互璁剧疆 `loss_fn` 涓篘one锛屽苟鍦 `network` 涓疄鐜版崯澶卞嚱鏁拌绠楋紝姝ゆ椂鏁版嵁闆嗚繑鍥炵殑鎵鏈夋暟鎹粍鎴愮殑鍏冪粍锛坉ata1, data2, data3, ...锛変細浼犵粰 `network` 銆 + - **valid_dataset** (Dataset) - 璇勪及妯″瀷鐨勬暟鎹泦杩唬鍣ㄣ傞粯璁ゅ硷細None銆 + - **valid_frequency** (int, list) - 姝ゅ弬鏁板彧鏈夊湪valid_dataset涓嶄负None鏃剁敓鏁堛傚鏋滀负int绫诲瀷锛岃〃绀烘墽琛屾帹鐞嗙殑棰戠巼锛屼緥濡 `valid_frequency=2`锛屽垯姣2涓缁僥poch鎵ц涓娆℃帹鐞嗭紱濡傛灉涓簂ist绫诲瀷锛屾寚鏄庡湪鍝嚑涓猠poch鏃舵墽琛屾帹鐞嗭紝渚嬪 `valid_frequency=[1, 5]`锛屽垯鍦ㄧ1涓拰绗5涓猠poch鎵ц鎺ㄧ悊銆傞粯璁ゅ硷細1銆 + - **callbacks** (Optional[list[Callback], Callback]) - 璁粌杩囩▼涓渶瑕佹墽琛岀殑鍥炶皟瀵硅薄鎴栬呭洖璋冨璞″垪琛ㄣ傞粯璁ゅ硷細None銆 + - **dataset_sink_mode** (bool) - 璁粌鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆備娇鐢≒YNATIVE_MODE妯″紡鎴朇PU澶勭悊鍣ㄦ椂锛屾ā鍨嬭缁冩祦绋嬪皢浠ラ潪涓嬫矇妯″紡鎵ц銆傞粯璁ゅ硷細True銆 + - **valid_dataset_sink_mode** (bool) - 鎺ㄧ悊鏁版嵁鏄惁鐩存帴涓嬫矇鑷冲鐞嗗櫒杩涜澶勭悊銆傞粯璁ゅ硷細True銆 + - **sink_size** (int) - 鎺у埗姣忔鏁版嵁涓嬫矇鐨勬暟鎹噺銆俙dataset_sink_mode` 涓篎alse鏃 `sink_size` 鏃犳晥銆傚鏋渟ink_size=-1锛屽垯姣忎竴娆poch涓嬫矇瀹屾暣鏁版嵁闆嗐傚鏋渟ink_size>0锛屽垯姣忎竴娆poch涓嬫矇鏁版嵁閲忎负sink_size鐨勬暟鎹泦銆傞粯璁ゅ硷細-1銆 + - **initial_epoch** (int) - 浠庡摢涓猠poch寮濮嬭缁冿紝涓鑸敤浜庝腑鏂仮澶嶈缁冨満鏅 .. py:method:: train_network :property: 鑾峰緱璇ユā鍨嬬殑璁粌缃戠粶銆 - **杩斿洖锛** - - 棰勬祴缃戠粶瀹炰緥銆 + 杩斿洖锛 + 棰勬祴缃戠粶瀹炰緥銆 diff --git a/docs/api/api_python/mindspore/mindspore.ModelCheckpoint.rst b/docs/api/api_python/mindspore/mindspore.ModelCheckpoint.rst index a14ed42c34d..ec1cd5d039c 100644 --- a/docs/api/api_python/mindspore/mindspore.ModelCheckpoint.rst +++ b/docs/api/api_python/mindspore/mindspore.ModelCheckpoint.rst @@ -11,26 +11,22 @@ mindspore.ModelCheckpoint 鍦ㄥ垎甯冨紡璁粌鍦烘櫙涓嬶紝璇蜂负姣忎釜璁粌杩涚▼鎸囧畾涓嶅悓鐨勭洰褰曟潵淇濆瓨checkpoint鏂囦欢銆傚惁鍒欙紝鍙兘浼氳缁冨け璐ャ 濡備綍鍦 `model` 鏂规硶涓娇鐢ㄦ鍥炶皟鍑芥暟锛岄粯璁ゅ皢浼氭妸浼樺寲鍣ㄤ腑鐨勫弬鏁颁繚瀛樺埌checkpoint鏂囦欢涓 - **鍙傛暟锛** - - - **prefix** (str) - checkpoint鏂囦欢鐨勫墠缂鍚嶇О銆傞粯璁ゅ硷細'CKP'銆 - - **directory** (str) - 淇濆瓨checkpoint鏂囦欢鐨勬枃浠跺す璺緞銆傞粯璁ゆ儏鍐典笅锛屾枃浠朵繚瀛樺湪褰撳墠鐩綍涓嬨傞粯璁ゅ硷細None銆 - - **config** (CheckpointConfig) - checkpoint绛栫暐閰嶇疆銆傞粯璁ゅ硷細None銆 - - **寮傚父锛** - - - **ValueError** - 濡傛灉prefix鍙傛暟涓嶆槸str绫诲瀷鎴栧寘鍚'/'瀛楃銆 - - **ValueError** - 濡傛灉directory鍙傛暟涓嶆槸str绫诲瀷銆 - - **TypeError** - config涓嶆槸CheckpointConfig绫诲瀷銆 + 鍙傛暟锛 + - **prefix** (str) - checkpoint鏂囦欢鐨勫墠缂鍚嶇О銆傞粯璁ゅ硷細'CKP'銆 + - **directory** (str) - 淇濆瓨checkpoint鏂囦欢鐨勬枃浠跺す璺緞銆傞粯璁ゆ儏鍐典笅锛屾枃浠朵繚瀛樺湪褰撳墠鐩綍涓嬨傞粯璁ゅ硷細None銆 + - **config** (CheckpointConfig) - checkpoint绛栫暐閰嶇疆銆傞粯璁ゅ硷細None銆 + 寮傚父锛 + - **ValueError** - 濡傛灉prefix鍙傛暟涓嶆槸str绫诲瀷鎴栧寘鍚'/'瀛楃銆 + - **ValueError** - 濡傛灉directory鍙傛暟涓嶆槸str绫诲瀷銆 + - **TypeError** - config涓嶆槸CheckpointConfig绫诲瀷銆 .. py:method:: end(run_context) 鍦ㄨ缁冪粨鏉熷悗锛屼細淇濆瓨鏈鍚庝竴涓猻tep鐨刢heckpoint銆 - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭 .. py:method:: latest_ckpt_file_name :property: @@ -41,6 +37,5 @@ mindspore.ModelCheckpoint 鍦╯tep缁撴潫鏃朵繚瀛榗heckpoint銆 - **鍙傛暟锛** - - - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭 + 鍙傛暟锛 + - **run_context** (RunContext) - 鍖呭惈妯″瀷鐨勪竴浜涘熀鏈俊鎭 diff --git a/docs/api/api_python/mindspore/mindspore.Parameter.rst b/docs/api/api_python/mindspore/mindspore.Parameter.rst index 108ad686654..a425bfe3963 100644 --- a/docs/api/api_python/mindspore/mindspore.Parameter.rst +++ b/docs/api/api_python/mindspore/mindspore.Parameter.rst @@ -10,13 +10,12 @@ - 骞惰鍦烘櫙涓嬪瓨鍦ㄥ弬鏁扮殑褰㈢姸鍙戠敓鍙樺寲鐨勬儏鍐碉紝鐢ㄦ埛鍙互璋冪敤 `Parameter` 鐨 `init_data` 鏂规硶寰楀埌鍘熷鏁版嵁銆 - 濡傛灉缃戠粶涓瓨鍦ㄩ渶瑕侀儴鍒嗚緭鍏ヤ负 `Parameter` 鐨勭畻瀛愶紝鍒欎笉鍏佽杩欓儴鍒嗚緭鍏ョ殑 `Parameter` 杩涜杞崲銆 - **鍙傛暟锛** - - - **default_input** (Union[Tensor, int, float, numpy.ndarray, list]) - 鍒濆鍖栧弬鏁扮殑杈撳叆鍊笺 - - **name** (str) - 鍙傛暟鐨勫悕绉般傞粯璁ゅ硷細None銆傚鏋滀竴涓綉缁滀腑瀛樺湪涓や釜鍙婁互涓婄浉鍚屽悕绉扮殑 `Parameter` 瀵硅薄锛屽湪瀹氫箟鏃跺皢鎻愮ず璁剧疆涓涓壒鏈夌殑鍚嶇О銆 - - **requires_grad** (bool) - 鏄惁闇瑕佸井鍒嗘眰姊害銆傞粯璁ゅ硷細True銆 - - **layerwise_parallel** (bool) - 鍦ㄦ暟鎹/娣峰悎骞惰妯″紡涓嬶紝`layerwise_parallel` 閰嶇疆涓篢rue鏃讹紝鍙傛暟骞挎挱鍜屾搴﹁仛鍚堟椂浼氳繃婊ゆ帀璇ュ弬鏁般傞粯璁ゅ硷細False銆 - - **parallel_optimizer** (bool) - 鐢ㄤ簬鍦 `semi_auto_parallel` 鎴 `auto_parallel` 骞惰妯″紡涓嬪尯鍒嗗弬鏁版槸鍚﹁繘琛屼紭鍖栧櫒鍒囧垎銆備粎鍦 `mindspore.context.set_auto_parallel_context()` 骞惰閰嶇疆妯″潡涓缃 `enable_parallel_optimizer` 鍚敤浼樺寲鍣ㄥ苟琛屾椂鏈夋晥銆傞粯璁ゅ硷細True銆 + 鍙傛暟锛 + - **default_input** (Union[Tensor, int, float, numpy.ndarray, list]) - 鍒濆鍖栧弬鏁扮殑杈撳叆鍊笺 + - **name** (str) - 鍙傛暟鐨勫悕绉般傞粯璁ゅ硷細None銆傚鏋滀竴涓綉缁滀腑瀛樺湪涓や釜鍙婁互涓婄浉鍚屽悕绉扮殑 `Parameter` 瀵硅薄锛屽湪瀹氫箟鏃跺皢鎻愮ず璁剧疆涓涓壒鏈夌殑鍚嶇О銆 + - **requires_grad** (bool) - 鏄惁闇瑕佸井鍒嗘眰姊害銆傞粯璁ゅ硷細True銆 + - **layerwise_parallel** (bool) - 鍦ㄦ暟鎹/娣峰悎骞惰妯″紡涓嬶紝`layerwise_parallel` 閰嶇疆涓篢rue鏃讹紝鍙傛暟骞挎挱鍜屾搴﹁仛鍚堟椂浼氳繃婊ゆ帀璇ュ弬鏁般傞粯璁ゅ硷細False銆 + - **parallel_optimizer** (bool) - 鐢ㄤ簬鍦 `semi_auto_parallel` 鎴 `auto_parallel` 骞惰妯″紡涓嬪尯鍒嗗弬鏁版槸鍚﹁繘琛屼紭鍖栧櫒鍒囧垎銆備粎鍦 `mindspore.context.set_auto_parallel_context()` 骞惰閰嶇疆妯″潡涓缃 `enable_parallel_optimizer` 鍚敤浼樺寲鍣ㄥ苟琛屾椂鏈夋晥銆傞粯璁ゅ硷細True銆 .. py:method:: cache_enable :property: @@ -32,13 +31,11 @@ 鍏嬮殕鍙傛暟銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **init** (Union[Tensor, str, numbers.Number]) - 鍒濆鍖栧弬鏁扮殑褰㈢姸鍜屾暟鎹被鍨嬨傚鏋 `init` 鏄 `Tensor` 鎴 `numbers.Number` 锛屽垯鍏嬮殕涓涓叿鏈夌浉鍚屾暟鍊笺佸舰鐘跺拰鏁版嵁绫诲瀷鐨勬柊鍙傛暟銆 濡傛灉 `init` 鏄 `str` 锛屽垯 `init` 灏嗙户鎵 `Initializer` 妯″潡涓搴旂殑鍚屽悕鐨勭被銆備緥濡傦紝濡傛灉 `init` 鏄'same'锛屽垯鍏嬮殕涓涓叿鏈夌浉鍚屾暟鎹佸舰鐘跺拰鏁版嵁绫诲瀷鐨勬柊鍙傛暟銆傞粯璁ゅ硷細'same'銆 - - **init** (Union[Tensor, str, numbers.Number]) - 鍒濆鍖栧弬鏁扮殑褰㈢姸鍜屾暟鎹被鍨嬨傚鏋 `init` 鏄 `Tensor` 鎴 `numbers.Number` 锛屽垯鍏嬮殕涓涓叿鏈夌浉鍚屾暟鍊笺佸舰鐘跺拰鏁版嵁绫诲瀷鐨勬柊鍙傛暟銆 濡傛灉 `init` 鏄 `str` 锛屽垯 `init` 灏嗙户鎵 `Initializer` 妯″潡涓搴旂殑鍚屽悕鐨勭被銆備緥濡傦紝濡傛灉 `init` 鏄'same'锛屽垯鍏嬮殕涓涓叿鏈夌浉鍚屾暟鎹佸舰鐘跺拰鏁版嵁绫诲瀷鐨勬柊鍙傛暟銆傞粯璁ゅ硷細'same'銆 - - **杩斿洖锛** - - Parameter锛岃繑鍥炲厠闅嗙殑鏂板弬鏁般 + 杩斿洖锛 + Parameter锛岃繑鍥炲厠闅嗙殑鏂板弬鏁般 .. py:method:: comm_fusion :property: @@ -56,28 +53,25 @@ 鍒濆鍖栧弬鏁扮殑鏁版嵁銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **layout** (Union[None, tuple]) - 鍙傛暟鐨刲ayout淇℃伅銆俵ayout[dev_mat, tensor_map, slice_shape, filed_size, uniform_split, opt_shard_group]锛氶粯璁ゅ硷細None銆備粎鍦 `SEMI_AUTO_PARALLEL` 鎴 `AUTO_PARALLEL` 妯″紡涓媗ayout涓嶆槸None銆 - - **layout** (Union[None, tuple]) - 鍙傛暟鐨刲ayout淇℃伅銆俵ayout[dev_mat, tensor_map, slice_shape, filed_size, uniform_split, opt_shard_group]锛氶粯璁ゅ硷細None銆備粎鍦 `SEMI_AUTO_PARALLEL` 鎴 `AUTO_PARALLEL` 妯″紡涓媗ayout涓嶆槸None銆 + - **dev_mat** (list(int)) - 璇ュ弬鏁扮殑璁惧鐭╅樀銆 + - **tensor_map** (list(int)) - 璇ュ弬鏁扮殑寮犻噺鏄犲皠銆 + - **slice_shape** (list(int)) - 璇ュ弬鏁扮殑鍒囩墖shape銆 + - **filed_size** (int) - 璇ユ潈閲嶇殑琛屾暟銆 + - **uniform_split** (bool) - 璇ュ弬鏁版槸鍚﹁繘琛屽潎鍖鍒囧垎銆 + - **opt_shard_group** (str) - 璇ュ弬鏁拌繘琛屼紭鍖栧櫒鍒囧垎鏃剁殑group銆 - - **dev_mat** (list(int)) - 璇ュ弬鏁扮殑璁惧鐭╅樀銆 - - **tensor_map** (list(int)) - 璇ュ弬鏁扮殑寮犻噺鏄犲皠銆 - - **slice_shape** (list(int)) - 璇ュ弬鏁扮殑鍒囩墖shape銆 - - **filed_size** (int) - 璇ユ潈閲嶇殑琛屾暟銆 - - **uniform_split** (bool) - 璇ュ弬鏁版槸鍚﹁繘琛屽潎鍖鍒囧垎銆 - - **opt_shard_group** (str) - 璇ュ弬鏁拌繘琛屼紭鍖栧櫒鍒囧垎鏃剁殑group銆 + - **set_sliced** (bool) - 鍙傛暟鍒濆鍖栨椂琚瀹氫负鍒嗙墖锛屽垯涓篢rue銆傞粯璁ゅ硷細False銆 - - **set_sliced** (bool) - 鍙傛暟鍒濆鍖栨椂琚瀹氫负鍒嗙墖锛屽垯涓篢rue銆傞粯璁ゅ硷細False銆 + 杩斿洖锛 + 鍒濆鍖栨暟鎹悗鐨 `Parameter` 銆傚鏋滃綋鍓 `Parameter` 宸插垵濮嬪寲锛屽垯鏇存柊 `Parameter` 鏁版嵁銆 - **杩斿洖锛** - - 鍒濆鍖栨暟鎹悗鐨 `Parameter` 銆傚鏋滃綋鍓 `Parameter` 宸插垵濮嬪寲锛屽垯鏇存柊 `Parameter` 鏁版嵁銆 - - **寮傚父锛** - - - **RuntimeError** - 鍙傛暟浣跨敤 `Initializer` 妯″潡杩涜鍒濆鍖栵紝鍒濆鍖栧悗骞惰妯″紡鍙戠敓鏇存敼銆 - - **ValueError** - `layout` 闀垮害灏忎簬6銆 - - **TypeError** - `layout` 涓嶆槸鍏冪粍銆 + 寮傚父锛 + - **RuntimeError** - 鍙傛暟浣跨敤 `Initializer` 妯″潡杩涜鍒濆鍖栵紝鍒濆鍖栧悗骞惰妯″紡鍙戠敓鏇存敼銆 + - **ValueError** - `layout` 闀垮害灏忎簬6銆 + - **TypeError** - `layout` 涓嶆槸鍏冪粍銆 .. py:method:: inited_param :property: @@ -130,24 +124,21 @@ 璁剧疆鍙傛暟鏁版嵁銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **data** (Union[Tensor, int, float]) - 鏂版暟鎹 + - **slice_shape** (bool) - 濡傛灉 `slice_shape` 璁句负True锛屽垯涓嶆鏌 `data` 鍜屽綋鍓嶅弬鏁皊hape鐨勪竴鑷存с傞粯璁ゅ硷細False銆 - - **data** (Union[Tensor, int, float]) - 鏂版暟鎹 - - **slice_shape** (bool) - 濡傛灉 `slice_shape` 璁句负True锛屽垯涓嶆鏌 `data` 鍜屽綋鍓嶅弬鏁皊hape鐨勪竴鑷存с傞粯璁ゅ硷細False銆 - - **杩斿洖锛** - - 瀹屾垚鏁版嵁璁剧疆鐨勬柊鍙傛暟銆 + 杩斿洖锛 + 瀹屾垚鏁版嵁璁剧疆鐨勬柊鍙傛暟銆 .. py:method:: set_param_fl(push_to_server=False, pull_from_server=False, requires_aggr=True) 璁剧疆鍙傛暟鍜屾湇鍔″櫒鐨勪簰鍔ㄦ柟寮忋 - **鍙傛暟锛** - - - **push_to_server** (bool) - 琛ㄧず鏄惁灏嗗弬鏁版帹閫佸埌鏈嶅姟鍣ㄣ傞粯璁ゅ硷細False銆 - - **pull_from_server** (bool) - 琛ㄧず鏄惁搴斾粠鏈嶅姟鍣ㄤ腑鎷夊彇鍙傛暟銆傞粯璁ゅ硷細False銆 - - **requires_aggr** (bool) - 琛ㄧず鏄惁搴斿湪鏈嶅姟鍣ㄤ腑鑱氬悎鍙傛暟銆傞粯璁ゅ硷細True銆 + 鍙傛暟锛 + - **push_to_server** (bool) - 琛ㄧず鏄惁灏嗗弬鏁版帹閫佸埌鏈嶅姟鍣ㄣ傞粯璁ゅ硷細False銆 + - **pull_from_server** (bool) - 琛ㄧず鏄惁搴斾粠鏈嶅姟鍣ㄤ腑鎷夊彇鍙傛暟銆傞粯璁ゅ硷細False銆 + - **requires_aggr** (bool) - 琛ㄧず鏄惁搴斿湪鏈嶅姟鍣ㄤ腑鑱氬悎鍙傛暟銆傞粯璁ゅ硷細True銆 .. py:method:: set_param_ps(init_in_server=False) @@ -155,9 +146,8 @@ .. note:: 浠呭綋杩愯鐨勪换鍔″浜庡弬鏁版湇鍔″櫒妯″紡涓嬫湁鏁堛 - **鍙傛暟锛** - - - **init_in_server** (bool) - 琛ㄧず鍙傛暟鏈嶅姟鍣ㄦ洿鏂扮殑鍙缁冨弬鏁版槸鍚﹀湪鏈嶅姟鍣ㄤ笂鍒濆鍖栥傞粯璁ゅ硷細False銆 + 鍙傛暟锛 + - **init_in_server** (bool) - 琛ㄧず鍙傛暟鏈嶅姟鍣ㄦ洿鏂扮殑鍙缁冨弬鏁版槸鍚﹀湪鏈嶅姟鍣ㄤ笂鍒濆鍖栥傞粯璁ゅ硷細False銆 .. py:method:: sliced :property: diff --git a/docs/api/api_python/mindspore/mindspore.ParameterTuple.rst b/docs/api/api_python/mindspore/mindspore.ParameterTuple.rst index 25515143d84..1a4ca6607cb 100644 --- a/docs/api/api_python/mindspore/mindspore.ParameterTuple.rst +++ b/docs/api/api_python/mindspore/mindspore.ParameterTuple.rst @@ -12,15 +12,14 @@ mindspore.ParameterTuple 閫愪釜瀵筆arameterTuple涓殑Parameter杩涜鍏嬮殕锛岀敓鎴愭柊鐨凱arameterTuple銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **prefix** (str) - Parameter鐨刵amespace锛屾鍓嶇紑灏嗕細琚坊鍔犲埌Parametertuple涓殑Parameter鐨刵ame灞炴т腑銆 + - **init** (Union[Tensor, str, numbers.Number]) - 瀵筆arametertuple涓璓arameter鐨剆hape鍜岀被鍨嬭繘琛屽厠闅嗭紝骞舵牴鎹紶鍏ョ殑 `init` 璁剧疆鏁板笺傞粯璁ゅ硷細'same'銆 - - **prefix** (str) - Parameter鐨刵amespace锛屾鍓嶇紑灏嗕細琚坊鍔犲埌Parametertuple涓殑Parameter鐨刵ame灞炴т腑銆 - - **init** (Union[Tensor, str, numbers.Number]) - 瀵筆arametertuple涓璓arameter鐨剆hape鍜岀被鍨嬭繘琛屽厠闅嗭紝骞舵牴鎹紶鍏ョ殑 `init` 璁剧疆鏁板笺傞粯璁ゅ硷細'same'銆 - 濡傛灉 `init` 鏄 `Tensor` 锛屽垯鏂板弬鏁扮殑鏁板间笌璇ensor鐩稿悓锛 - 濡傛灉 `init` 鏄 `numbers.Number` 锛屽垯璁剧疆鏂板弬鏁扮殑鏁板间负璇ュ硷紱 - 濡傛灉 `init` 鏄 `str` 锛屽垯鎸夌収 `Initializer` 妯″潡涓搴旂殑鍚屽悕鐨勫垵濮嬪寲鏂规硶杩涜鏁板艰瀹氾紱 - 濡傛灉 `init` 鏄'same'锛屽垯鏂板弬鏁扮殑鏁板间笌鍘烶arameter鐩稿悓銆 + - 濡傛灉 `init` 鏄 `Tensor` 锛屽垯鏂板弬鏁扮殑鏁板间笌璇ensor鐩稿悓銆 + - 濡傛灉 `init` 鏄 `numbers.Number` 锛屽垯璁剧疆鏂板弬鏁扮殑鏁板间负璇ュ笺 + - 濡傛灉 `init` 鏄 `str` 锛屽垯鎸夌収 `Initializer` 妯″潡涓搴旂殑鍚屽悕鐨勫垵濮嬪寲鏂规硶杩涜鏁板艰瀹氥 + - 濡傛灉 `init` 鏄'same'锛屽垯鏂板弬鏁扮殑鏁板间笌鍘烶arameter鐩稿悓銆 - **杩斿洖锛** - - 鏂扮殑鍙傛暟鍏冪粍銆 + 杩斿洖锛 + 鏂扮殑鍙傛暟鍏冪粍銆 diff --git a/docs/api/api_python/mindspore/mindspore.Profiler.rst b/docs/api/api_python/mindspore/mindspore.Profiler.rst index 21d7ca40668..62797b6ef43 100644 --- a/docs/api/api_python/mindspore/mindspore.Profiler.rst +++ b/docs/api/api_python/mindspore/mindspore.Profiler.rst @@ -5,16 +5,14 @@ mindspore.Profiler MindSpore鐢ㄦ埛鑳藉閫氳繃璇ョ被瀵圭缁忕綉缁滅殑鎬ц兘杩涜閲囬泦銆傚彲浠ラ氳繃瀵煎叆 `mindspore.Profiler` 鐒跺悗鍒濆鍖朠rofiler瀵硅薄浠ュ紑濮嬪垎鏋愶紝浣跨敤 `Profiler.analyse()` 鍋滄鏀堕泦鍜屽垎鏋愩傚彲閫氳繃Mindinsight宸ュ叿鍙鍖栧垎鏋愮粨鏋溿傜洰鍓嶏紝Profiler鏀寔AICORE绠楀瓙銆丄ICPU绠楀瓙銆丠ostCPU绠楀瓙銆佸唴瀛樸佽澶囬氫俊銆侀泦缇ょ瓑鏁版嵁鐨勫垎鏋愩 - **鍙傛暟锛** - - - **output_path** (str, 鍙) 鈥 琛ㄧず杈撳嚭鏁版嵁鐨勮矾寰勩傞粯璁ゅ硷細"./data"銆 - - **profile_communication** (bool, 鍙) 鈥 锛堜粎闄怉scend锛夎〃绀烘槸鍚﹀湪澶氳澶囪缁冧腑鏀堕泦閫氫俊鎬ц兘鏁版嵁銆傚綋鍊间负True鏃讹紝鏀堕泦杩欎簺鏁版嵁銆傚湪鍗曞彴璁惧璁粌涓紝璇ュ弬鏁扮殑璁剧疆鏃犳晥銆傞粯璁ゅ硷細False銆 - - **profile_memory** (bool, 鍙) 鈥 锛堜粎闄怉scend锛夎〃绀烘槸鍚︽敹闆員ensor鍐呭瓨鏁版嵁銆傚綋鍊间负True鏃讹紝鏀堕泦杩欎簺鏁版嵁銆傞粯璁ゅ硷細False銆 - - **start_profile** (bool, 鍙) 鈥 璇ュ弬鏁版帶鍒舵槸鍚﹀湪Profiler鍒濆鍖栫殑鏃跺欏紑鍚暟鎹噰闆嗐傞粯璁ゅ硷細True銆 + 鍙傛暟锛 + - **output_path** (str, 鍙) - 琛ㄧず杈撳嚭鏁版嵁鐨勮矾寰勩傞粯璁ゅ硷細"./data"銆 + - **profile_communication** (bool, 鍙) - 锛堜粎闄怉scend锛夎〃绀烘槸鍚﹀湪澶氳澶囪缁冧腑鏀堕泦閫氫俊鎬ц兘鏁版嵁銆傚綋鍊间负True鏃讹紝鏀堕泦杩欎簺鏁版嵁銆傚湪鍗曞彴璁惧璁粌涓紝璇ュ弬鏁扮殑璁剧疆鏃犳晥銆傞粯璁ゅ硷細False銆 + - **profile_memory** (bool, 鍙) - 锛堜粎闄怉scend锛夎〃绀烘槸鍚︽敹闆員ensor鍐呭瓨鏁版嵁銆傚綋鍊间负True鏃讹紝鏀堕泦杩欎簺鏁版嵁銆傞粯璁ゅ硷細False銆 + - **start_profile** (bool, 鍙) - 璇ュ弬鏁版帶鍒舵槸鍚﹀湪Profiler鍒濆鍖栫殑鏃跺欏紑鍚暟鎹噰闆嗐傞粯璁ゅ硷細True銆 - **寮傚父锛** - - - **RuntimeError** 鈥 褰揅ANN鐨勭増鏈笌MindSpore鐗堟湰涓嶅尮閰嶆椂锛岀敓鎴愮殑ascend_job_id鐩綍缁撴瀯MindSpore鏃犳硶瑙ｆ瀽銆 + 寮傚父锛 + - **RuntimeError** - 褰揅ANN鐨勭増鏈笌MindSpore鐗堟湰涓嶅尮閰嶆椂锛岀敓鎴愮殑ascend_job_id鐩綍缁撴瀯MindSpore鏃犳硶瑙ｆ瀽銆 .. py:method:: analyse() @@ -24,35 +22,27 @@ mindspore.Profiler 鑾峰彇primitive绫诲瀷鐨勭畻瀛愭ц兘鏁版嵁銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **op_name** (str 鎴 list) - 琛ㄧず瑕佹煡璇㈢殑primitive绠楀瓙绫诲瀷銆 + - **device_id** (int, 鍙) - 璁惧鍗″彿锛岃〃绀烘寚瀹氳В鏋愬摢寮犲崱鐨勭畻瀛愭ц兘鏁版嵁銆傚湪缃戠粶璁粌鎴栬呮帹鐞嗘椂浣跨敤锛岃鍙傛暟鍙夈傚熀浜庣绾挎暟鎹В鏋愪娇鐢ㄨ鎺ュ彛鏃讹紝榛樿鍊硷細0銆 - - **op_name** (str 鎴 list) 鈥 琛ㄧず瑕佹煡璇㈢殑primitive绠楀瓙绫诲瀷銆 - - **device_id** (int, 鍙) 鈥 璁惧鍗″彿锛岃〃绀烘寚瀹氳В鏋愬摢寮犲崱鐨勭畻瀛愭ц兘鏁版嵁銆傚湪缃戠粶璁粌鎴栬呮帹鐞嗘椂浣跨敤锛岃鍙傛暟鍙夈傚熀浜庣绾挎暟鎹В鏋愪娇鐢ㄨ鎺ュ彛鏃讹紝榛樿鍊硷細0銆 - - **寮傚父锛** - - - **TypeError** 鈥 op_name鍙傛暟绫诲瀷涓嶆纭 - - **TypeError** 鈥 device_id鍙傛暟绫诲瀷涓嶆纭 - - **RunTimeError** 鈥 鍦ˋscend涓婁娇鐢ㄨ鎺ュ彛鑾峰彇鎬ц兘鏁版嵁銆 - - **鏀寔骞冲彴锛** - - ``GPU`` ``CPU`` + 寮傚父锛 + - **TypeError** - op_name鍙傛暟绫诲瀷涓嶆纭 + - **TypeError** - device_id鍙傛暟绫诲瀷涓嶆纭 + - **RunTimeError** - 鍦ˋscend涓婁娇鐢ㄨ鎺ュ彛鑾峰彇鎬ц兘鏁版嵁銆 .. py:method:: start() 寮鍚疨rofiler鏁版嵁閲囬泦锛屽彲浠ユ寜鏉′欢寮鍚疨rofiler銆 - **寮傚父锛** - - - **RuntimeError** 鈥 profiler宸茬粡寮鍚 - - **RuntimeError** 鈥 鍋滄Minddata閲囬泦鍚庯紝涓嶆敮鎸侀噸澶嶅紑鍚 - - **RuntimeError** 鈥 濡傛灉start_profile鍙傛暟鏈缃垨璁剧疆涓篢rue銆 + 寮傚父锛 + - **RuntimeError** - profiler宸茬粡寮鍚 + - **RuntimeError** - 鍋滄Minddata閲囬泦鍚庯紝涓嶆敮鎸侀噸澶嶅紑鍚 + - **RuntimeError** - 濡傛灉start_profile鍙傛暟鏈缃垨璁剧疆涓篢rue銆 .. py:method:: stop() 鍋滄Profiler锛屽彲浠ユ寜鏉′欢鍋滄Profiler銆 - **寮傚父锛** - - - **RuntimeError** 鈥 profiler娌℃湁寮鍚 + 寮傚父锛 + - **RuntimeError** - profiler娌℃湁寮鍚 diff --git a/docs/api/api_python/mindspore/mindspore.get_algo_parameters.rst b/docs/api/api_python/mindspore/mindspore.get_algo_parameters.rst index ab2f270187a..b7275ef3958 100644 --- a/docs/api/api_python/mindspore/mindspore.get_algo_parameters.rst +++ b/docs/api/api_python/mindspore/mindspore.get_algo_parameters.rst @@ -8,15 +8,12 @@ mindspore.get_algo_parameters .. note:: 灞炴у悕绉颁负蹇呭～椤广傛鎺ュ彛浠呭湪AUTO_PARALLEL妯″紡涓嬪伐浣溿 - **鍙傛暟锛** + 鍙傛暟锛 + - **attr_key** (str) - 灞炴х殑key銆俴ey鍖呮嫭"fully_use_devices"銆"elementwise_op_strategy_follow"銆"enable_algo_approxi"銆"algo_approxi_epsilon"銆"tensor_slice_align_enable"鍜"tensor_slice_align_size"銆 - - **attr_key** (str) - 灞炴х殑key銆俴ey鍖呮嫭"fully_use_devices"銆"elementwise_op_strategy_follow"銆"enable_algo_approxi"銆"algo_approxi_epsilon"銆"tensor_slice_align_enable鈥濆拰"tensor_slice_align_size"銆 + 杩斿洖锛 + 鏍规嵁key杩斿洖灞炴у笺 - **杩斿洖锛** - - 鏍规嵁key杩斿洖灞炴у笺 - - **寮傚父锛** - - - **ValueError** - 鏃犳硶璇嗗埆浼犲叆鐨勫叧閿瓧銆 + 寮傚父锛 + - **ValueError** - 鏃犳硶璇嗗埆浼犲叆鐨勫叧閿瓧銆 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/mindspore.get_auto_parallel_context.rst b/docs/api/api_python/mindspore/mindspore.get_auto_parallel_context.rst index 14d537ea40e..befa74114f0 100644 --- a/docs/api/api_python/mindspore/mindspore.get_auto_parallel_context.rst +++ b/docs/api/api_python/mindspore/mindspore.get_auto_parallel_context.rst @@ -5,14 +5,11 @@ mindspore.get_auto_parallel_context 鏍规嵁key鑾峰彇鑷姩骞惰鐨勯厤缃 - **鍙傛暟锛** + 鍙傛暟锛 + - **attr_key** (str) - 閰嶇疆鐨刱ey銆 - - **attr_key** (str) - 閰嶇疆鐨刱ey銆 + 杩斿洖锛 + 鏍规嵁key杩斿洖閰嶇疆鐨勫笺 - **杩斿洖锛** - - 鏍规嵁key杩斿洖閰嶇疆鐨勫笺 - - **寮傚父锛** - - **ValueError**锛氳緭鍏ey涓嶅湪鑷姩骞惰鐨勯厤缃垪琛ㄤ腑銆 + 寮傚父锛 + - **ValueError** - 杈撳叆key涓嶅湪鑷姩骞惰鐨勯厤缃垪琛ㄤ腑銆 diff --git a/docs/api/api_python/mindspore/mindspore.get_context.rst b/docs/api/api_python/mindspore/mindspore.get_context.rst index 09f54209865..7c3e6d77bd2 100644 --- a/docs/api/api_python/mindspore/mindspore.get_context.rst +++ b/docs/api/api_python/mindspore/mindspore.get_context.rst @@ -1,19 +1,15 @@ mindspore.get_context ====================== - .. py:function:: mindspore.get_context(attr_key) 鏍规嵁杈撳叆key鑾峰彇context涓殑灞炴у笺傚鏋滆key娌℃湁璁剧疆锛屽垯浼氳幏鍙栧畠浠繖浜涚殑榛樿鍊笺 - **鍙傛暟锛** + 鍙傛暟锛 + - **attr_key** (str) - 灞炴х殑key銆 - - **attr_key** (str) - 灞炴х殑key銆 + 杩斿洖锛 + Object锛岃〃绀虹粰瀹氬睘鎬ey鐨勫笺 - **杩斿洖锛** - - Object锛岃〃绀虹粰瀹氬睘鎬ey鐨勫笺 - - **寮傚父锛** - - **ValueError**锛氳緭鍏ey涓嶆槸context涓殑灞炴с + 寮傚父锛 + - **ValueError** - 杈撳叆key涓嶆槸context涓殑灞炴с diff --git a/docs/api/api_python/mindspore/mindspore.get_level.rst b/docs/api/api_python/mindspore/mindspore.get_level.rst index 7fb93b405c3..c0b34ac7c81 100644 --- a/docs/api/api_python/mindspore/mindspore.get_level.rst +++ b/docs/api/api_python/mindspore/mindspore.get_level.rst @@ -5,6 +5,5 @@ mindspore.get_level 鑾峰彇鏃ュ織璁板綍鍣ㄧ殑绾у埆銆 - **杩斿洖锛** - - string锛屾棩蹇楃骇鍒寘鎷4(EXCEPTION)銆3(ERROR)銆2(WARNING)銆1(INFO)鍜0(DEBUG)銆 + 杩斿洖锛 + string锛屾棩蹇楃骇鍒寘鎷4(EXCEPTION)銆3(ERROR)銆2(WARNING)銆1(INFO)鍜0(DEBUG)銆 diff --git a/docs/api/api_python/mindspore/mindspore.get_log_config.rst b/docs/api/api_python/mindspore/mindspore.get_log_config.rst index 0a307a7afdc..8ef50a51ea1 100644 --- a/docs/api/api_python/mindspore/mindspore.get_log_config.rst +++ b/docs/api/api_python/mindspore/mindspore.get_log_config.rst @@ -5,6 +5,5 @@ mindspore.get_log_config 鑾峰彇鏃ュ織閰嶇疆銆 - **杩斿洖锛** - - Dict锛屾棩蹇楅厤缃瓧鍏搞 + 杩斿洖锛 + Dict锛屾棩蹇楅厤缃瓧鍏搞 diff --git a/docs/api/api_python/mindspore/mindspore.get_ps_context.rst b/docs/api/api_python/mindspore/mindspore.get_ps_context.rst index 8aea4561353..47f2951c39f 100644 --- a/docs/api/api_python/mindspore/mindspore.get_ps_context.rst +++ b/docs/api/api_python/mindspore/mindspore.get_ps_context.rst @@ -5,21 +5,18 @@ mindspore.get_ps_context 鏍规嵁key鑾峰彇鍙傛暟鏈嶅姟鍣ㄨ缁冩ā寮忎笂涓嬫枃涓殑灞炴у笺 - **鍙傛暟锛** + 鍙傛暟锛 + - **attr_key** (str) - 灞炴х殑key銆 - - **attr_key** (str) - 灞炴х殑key銆 + - enable_ps (bool)锛氳〃绀烘槸鍚﹀惎鐢ㄥ弬鏁版湇鍔″櫒璁粌妯″紡銆傞粯璁ゅ硷細False銆 + - config_file_path (string)锛氶厤缃枃浠惰矾寰勶紝鐢ㄤ簬瀹圭伨鎭㈠绛夈傞粯璁ゅ硷細''銆 + - scheduler_manage_port (int)锛氳皟搴﹀櫒HTTP绔彛锛屽澶栧紑鏀剧敤浜庢帴鏀跺拰澶勭悊鐢ㄦ埛鎵╁/缂╁绛夎姹傘傞粯璁ゅ硷細11202銆 + - enable_ssl (bool)锛氳缃槸鍚︽墦寮SSL璁よ瘉銆傞粯璁ゅ硷細False銆 + - client_password (str)锛氱敤浜庤В瀵嗗鎴风璇佷功瀵嗛挜鐨勫瘑鐮併傞粯璁ゅ硷細''銆 + - server_password (str)锛氱敤浜庤В瀵嗘湇鍔＄璇佷功瀵嗛挜鐨勫瘑鐮併傞粯璁ゅ硷細''銆 - - enable_ps (bool)锛氳〃绀烘槸鍚﹀惎鐢ㄥ弬鏁版湇鍔″櫒璁粌妯″紡銆傞粯璁ゅ硷細False銆 - - config_file_path (string)锛氶厤缃枃浠惰矾寰勶紝鐢ㄤ簬瀹圭伨鎭㈠绛夈傞粯璁ゅ硷細''銆 - - scheduler_manage_port (int)锛氳皟搴﹀櫒HTTP绔彛锛屽澶栧紑鏀剧敤浜庢帴鏀跺拰澶勭悊鐢ㄦ埛鎵╁/缂╁绛夎姹傘傞粯璁ゅ硷細11202銆 - - enable_ssl (bool)锛氳缃槸鍚︽墦寮SSL璁よ瘉銆傞粯璁ゅ硷細False銆 - - client_password (str)锛氱敤浜庤В瀵嗗鎴风璇佷功瀵嗛挜鐨勫瘑鐮併傞粯璁ゅ硷細''銆 - - server_password (str)锛氱敤浜庤В瀵嗘湇鍔＄璇佷功瀵嗛挜鐨勫瘑鐮併傞粯璁ゅ硷細''銆 + 杩斿洖锛 + 鏍规嵁key杩斿洖灞炴у笺 - **杩斿洖锛** - - 鏍规嵁key杩斿洖灞炴у笺 - - **寮傚父锛** - - **ValueError** - 杈撳叆key涓嶆槸鍙傛暟鏈嶅姟鍣ㄨ缁冩ā寮忎笂涓嬫枃涓殑灞炴с + 寮傚父锛 + - **ValueError** - 杈撳叆key涓嶆槸鍙傛暟鏈嶅姟鍣ㄨ缁冩ā寮忎笂涓嬫枃涓殑灞炴с diff --git a/docs/api/api_python/mindspore/mindspore.get_py_obj_dtype.rst b/docs/api/api_python/mindspore/mindspore.get_py_obj_dtype.rst index 1bfe58cf021..b8ce914c547 100644 --- a/docs/api/api_python/mindspore/mindspore.get_py_obj_dtype.rst +++ b/docs/api/api_python/mindspore/mindspore.get_py_obj_dtype.rst @@ -5,10 +5,8 @@ mindspore.get_py_obj_dtype 灏哖ython鏁版嵁绫诲瀷杞崲涓篗indSpore鏁版嵁绫诲瀷銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **obj** (type) - Python鏁版嵁瀵硅薄锛屾垨鍦≒ython鐜涓畾涔夌殑鍙橀噺銆 - - **obj** (type) 鈥 Python鏁版嵁瀵硅薄锛屾垨鍦≒ython鐜涓畾涔夌殑鍙橀噺銆 - - **杩斿洖锛** - - MindSpore鐨勬暟鎹被鍨嬨 \ No newline at end of file + 杩斿洖锛 + MindSpore鐨勬暟鎹被鍨嬨 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/mindspore.get_seed.rst b/docs/api/api_python/mindspore/mindspore.get_seed.rst index 084005207e3..38a65d0dfff 100644 --- a/docs/api/api_python/mindspore/mindspore.get_seed.rst +++ b/docs/api/api_python/mindspore/mindspore.get_seed.rst @@ -5,6 +5,5 @@ mindspore.get_seed 鑾峰彇闅忔満绉嶅瓙銆 - **杩斿洖锛** - - int锛岄殢鏈虹瀛愩 + 杩斿洖锛 + int锛岄殢鏈虹瀛愩 diff --git a/docs/api/api_python/mindspore/mindspore.issubclass_.rst b/docs/api/api_python/mindspore/mindspore.issubclass_.rst index b073556711f..df0cc630b13 100644 --- a/docs/api/api_python/mindspore/mindspore.issubclass_.rst +++ b/docs/api/api_python/mindspore/mindspore.issubclass_.rst @@ -5,11 +5,9 @@ mindspore.issubclass\_ 鍒ゆ柇 `type_` 鏄惁涓 `dtype` 鐨勫瓙绫汇 - **鍙傛暟锛** + 鍙傛暟锛 + - **type_** (mindspore.dtype) - MindSpore涓殑鐩爣dtype銆 + - **dtype** (mindspore.dtype) - dtype鐨勬瘮杈冨璞° - - **type_** (mindspore.dtype) 鈥 MindSpore涓殑鐩爣dtype銆 - - **dtype** (mindspore.dtype) 鈥 dtype鐨勬瘮杈冨璞° - - **杩斿洖锛** - - bool锛孴rue鎴朏alse銆 \ No newline at end of file + 杩斿洖锛 + bool锛孴rue鎴朏alse銆 \ No newline at end of file diff --git a/docs/api/api_python/mindspore/mindspore.load.rst b/docs/api/api_python/mindspore/mindspore.load.rst index b64841ed929..bb687e98331 100644 --- a/docs/api/api_python/mindspore/mindspore.load.rst +++ b/docs/api/api_python/mindspore/mindspore.load.rst @@ -7,20 +7,17 @@ mindspore.load 杩斿洖涓涓彲浠ョ敱 `GraphCell` 鎵ц鐨勫璞★紝鏇村缁嗚妭鍙傝绫 :class:`mindspore.nn.GraphCell` 銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **file_name** (str) - MindIR鏂囦欢鐨勫叏璺緞鍚嶃 + - **kwargs** (dict) - 閰嶇疆椤瑰瓧鍏搞 - - **file_name** (str) 鈥 MindIR鏂囦欢鐨勫叏璺緞鍚嶃 - - **kwargs** (dict) 鈥 閰嶇疆椤瑰瓧鍏搞 + - **dec_key** (bytes) - 鐢ㄤ簬瑙ｅ瘑鐨勫瓧鑺傜被鍨嬪瘑閽ャ傛湁鏁堥暱搴︿负 16銆24 鎴 32銆 + - **dec_mode** (Union[str, function]) - 鎸囧畾瑙ｅ瘑妯″紡锛岃缃甦ec_key鏃剁敓鏁堛傚彲閫夐」锛'AES-GCM' | 'AES-CBC' 锝 鑷畾涔夎В瀵嗗嚱鏁般傞粯璁ゅ硷細"AES-GCM"銆 + - 鍏充簬浣跨敤鑷畾涔夎В瀵嗗姞杞界殑璇︽儏锛岃鏌ョ湅 `鏁欑▼ `_銆 - - **dec_key** (bytes) - 鐢ㄤ簬瑙ｅ瘑鐨勫瓧鑺傜被鍨嬪瘑閽ャ 鏈夋晥闀垮害涓 16銆24 鎴 32銆 - - **dec_mode** (Union[str, function]) - 鎸囧畾瑙ｅ瘑妯″紡锛岃缃甦ec_key鏃剁敓鏁堛傚彲閫夐」锛'AES-GCM' | 'AES-CBC' 锝 鑷畾涔夎В瀵嗗嚱鏁般傞粯璁ゅ硷細"AES-GCM"銆 - - 鍏充簬浣跨敤鑷畾涔夎В瀵嗗姞杞界殑璇︽儏, 璇锋煡鐪 `鏁欑▼ `_銆 + 杩斿洖锛 + GraphCell锛屼竴涓彲浠ョ敱 `GraphCell` 鏋勬垚鐨勫彲鎵ц鐨勭紪璇戝浘銆 - **杩斿洖锛** - - GraphCell锛屼竴涓彲浠ョ敱 `GraphCell` 鏋勬垚鐨勫彲鎵ц鐨勭紪璇戝浘銆 - - **寮傚父锛** - - - **ValueError** 鈥 MindIR 鏂囦欢鍚嶄笉瀛樺湪鎴 `file_name` 涓嶆槸string绫诲瀷銆 - - **RuntimeError** - 瑙ｆ瀽MindIR鏂囦欢澶辫触銆 + 寮傚父锛 + - **ValueError** - MindIR鏂囦欢鍚嶄笉瀛樺湪鎴 `file_name` 涓嶆槸string绫诲瀷銆 + - **RuntimeError** - 瑙ｆ瀽MindIR鏂囦欢澶辫触銆 diff --git a/docs/api/api_python/mindspore/mindspore.load_checkpoint.rst b/docs/api/api_python/mindspore/mindspore.load_checkpoint.rst index 3a359482796..4839e93097f 100644 --- a/docs/api/api_python/mindspore/mindspore.load_checkpoint.rst +++ b/docs/api/api_python/mindspore/mindspore.load_checkpoint.rst @@ -9,23 +9,20 @@ mindspore.load_checkpoint - `specify_prefix` 鍜 `filter_prefix` 鐨勫姛鑳界浉浜掍箣闂存病鏈夊奖鍝嶃 - 濡傛灉鍙戠幇娌℃湁鍙傛暟琚垚鍔熷姞杞斤紝灏嗕細鎶alueError. - **鍙傛暟锛** + 鍙傛暟锛 + - **ckpt_file_name** (str) - checkpoint鐨勬枃浠跺悕绉般 + - **net** (Cell) - 鍔犺浇checkpoint鍙傛暟鐨勭綉缁溿傞粯璁ゅ硷細None銆 + - **strict_load** (bool) - 鏄惁灏嗕弗鏍煎姞杞藉弬鏁板埌缃戠粶涓傚鏋滄槸False, 瀹冨皢鏍规嵁鐩稿悓鐨勫悗缂鍚嶅皢鍙傛暟瀛楀吀涓殑鍙傛暟鍔犺浇鍒扮綉缁滀腑锛屽苟浼氬湪绮惧害涓嶅尮閰嶆椂锛岃繘琛屽己鍒剁簿搴﹁浆鎹紝姣斿灏 `float32` 杞崲涓 `float16` 銆傞粯璁ゅ硷細False銆 + - **filter_prefix** (Union[str, list[str], tuple[str]]) - 浠 `filter_prefix` 寮澶寸殑鍙傛暟灏嗕笉浼氳鍔犺浇銆傞粯璁ゅ硷細None銆 + - **dec_key** (Union[None, bytes]) - 鐢ㄤ簬瑙ｅ瘑鐨勫瓧鑺傜被鍨嬪瘑閽ワ紝濡傛灉鍊间负None锛屽垯涓嶉渶瑕佽В瀵嗐傞粯璁ゅ硷細None銆 + - **dec_mode** (str) - 璇ュ弬鏁颁粎褰 `dec_key` 涓嶄负None鏃舵湁鏁堛傛寚瀹氳В瀵嗘ā寮忥紝鐩墠鏀寔"AES-GCM"鍜"AES-CBC"銆傞粯璁ゅ硷細"AES-GCM"銆 + - **specify_prefix** (Union[str, list[str], tuple[str]]) - 浠 `specify_prefix` 寮澶寸殑鍙傛暟灏嗕細琚姞杞姐傞粯璁ゅ硷細None銆 - - **ckpt_file_name** (str) 鈥 checkpoint鐨勬枃浠跺悕绉般 - - **net** (Cell) 鈥 鍔犺浇checkpoint鍙傛暟鐨勭綉缁溿傞粯璁ゅ硷細None銆 - - **strict_load** (bool) 鈥 鏄惁灏嗕弗鏍煎姞杞藉弬鏁板埌缃戠粶涓傚鏋滄槸False, 瀹冨皢鏍规嵁鐩稿悓鐨勫悗缂鍚嶅皢鍙傛暟瀛楀吀涓殑鍙傛暟鍔犺浇鍒扮綉缁滀腑锛屽苟浼氬湪绮惧害涓嶅尮閰嶆椂锛岃繘琛屽己鍒剁簿搴﹁浆鎹紝姣斿灏 `float32` 杞崲涓 `float16` 銆傞粯璁ゅ硷細False銆 - - **filter_prefix** (Union[str, list[str], tuple[str]]) 鈥 浠 `filter_prefix` 寮澶寸殑鍙傛暟灏嗕笉浼氳鍔犺浇銆傞粯璁ゅ硷細None銆 - - **dec_key** (Union[None, bytes]) 鈥 鐢ㄤ簬瑙ｅ瘑鐨勫瓧鑺傜被鍨嬪瘑閽ワ紝濡傛灉鍊间负None锛屽垯涓嶉渶瑕佽В瀵嗐傞粯璁ゅ硷細None銆 - - **dec_mode** (str) 鈥 璇ュ弬鏁颁粎褰 `dec_key` 涓嶄负None鏃舵湁鏁堛傛寚瀹氳В瀵嗘ā寮忥紝鐩墠鏀寔鈥淎ES-GCM鈥濆拰鈥淎ES-CBC鈥濄傞粯璁ゅ硷細鈥淎ES-GCM鈥濄 - - **specify_prefix** (Union[str, list[str], tuple[str]]) 鈥 浠 `specify_prefix` 寮澶寸殑鍙傛暟灏嗕細琚姞杞姐傞粯璁ゅ硷細None銆 + 杩斿洖锛 + 瀛楀吀锛宬ey鏄弬鏁板悕绉帮紝value鏄疨arameter绫诲瀷銆傚綋浣跨敤 :func:`mindspore.save_checkpoint` 鐨 `append_dict` 鍙傛暟鍜 :class:`CheckpointConfig` 鐨 `append_info` 鍙傛暟淇濆瓨 + checkpoint锛 `append_dict` 鍜 `append_info` 鏄痙ict绫诲瀷锛屼笖瀹冧滑鐨勫紇alue鏄痵tring鏃讹紝鍔犺浇checkpoint寰楀埌鐨勮繑鍥炲兼槸string绫诲瀷锛屽叾瀹冩儏鍐佃繑鍥炲煎潎鏄疨arameter绫诲瀷銆 - **杩斿洖锛** - - 瀛楀吀锛宬ey鏄弬鏁板悕绉帮紝value鏄疨arameter绫诲瀷銆傚綋浣跨敤 :func:`mindspore.save_checkpoint` 鐨 `append_dict` 鍙傛暟鍜 :class:`CheckpointConfig` 鐨 `append_info` 鍙傛暟淇濆瓨 - checkpoint锛 `append_dict` 鍜 `append_info` 鏄痙ict绫诲瀷锛屼笖瀹冧滑鐨勫紇alue鏄痵tring鏃讹紝鍔犺浇checkpoint寰楀埌鐨勮繑鍥炲兼槸string绫诲瀷锛屽叾瀹冩儏鍐佃繑鍥炲煎潎鏄疨arameter绫诲瀷銆 - - **寮傚父锛** - - - **ValueError** 鈥 checkpoint鏂囦欢鏍煎紡涓嶆纭 - - **ValueError** 鈥 娌℃湁涓涓弬鏁拌鎴愬姛鍔犺浇銆 - - **TypeError** `specify_prefix` 鎴栬 `filter_prefix` 鐨勬暟鎹被鍨嬩笉姝ｇ‘銆 + 寮傚父锛 + - **ValueError** - checkpoint鏂囦欢鏍煎紡涓嶆纭 + - **ValueError** - 娌℃湁涓涓弬鏁拌鎴愬姛鍔犺浇銆 + - **TypeError** - `specify_prefix` 鎴栬 `filter_prefix` 鐨勬暟鎹被鍨嬩笉姝ｇ‘銆 diff --git a/docs/api/api_python/mindspore/mindspore.load_distributed_checkpoint.rst b/docs/api/api_python/mindspore/mindspore.load_distributed_checkpoint.rst index b5c03c49727..56ebda69a1a 100644 --- a/docs/api/api_python/mindspore/mindspore.load_distributed_checkpoint.rst +++ b/docs/api/api_python/mindspore/mindspore.load_distributed_checkpoint.rst @@ -3,19 +3,17 @@ mindspore.load_distributed_checkpoint .. py:function:: mindspore.load_distributed_checkpoint(network, checkpoint_filenames, predict_strategy=None, train_strategy_filename=None, strict_load=False, dec_key=None, dec_mode='AES-GCM') - 缁欏垎甯冨紡棰勬祴鍔犺浇checkpoint鏂囦欢鍒扮綉缁滐紝鐢ㄤ簬鍒嗗竷寮忔帹鐞嗐傚叧浜庡垎甯冨紡鎺ㄧ悊鐨勭粏鑺傦紝璇峰弬鑰冿細 https://www.mindspore.cn/tutorials/experts/zh-CN/master/parallel/distributed_inference.html 銆 + 缁欏垎甯冨紡棰勬祴鍔犺浇checkpoint鏂囦欢鍒扮綉缁滐紝鐢ㄤ簬鍒嗗竷寮忔帹鐞嗐傚叧浜庡垎甯冨紡鎺ㄧ悊鐨勭粏鑺傦紝璇峰弬鑰冿細https://www.mindspore.cn/tutorials/experts/zh-CN/master/parallel/distributed_inference.html銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **network** (Cell) - 鍒嗗竷寮忛娴嬬綉缁溿 + - **checkpoint_filenames** (list[str]) - checkpoint鏂囦欢鐨勫悕绉帮紝鎸塺ank id椤哄簭鎺掑垪銆 + - **predict_strategy** (dict) - 棰勬祴鏃跺弬鏁扮殑鍒囧垎绛栫暐銆 + - **train_strategy_filename** (str) - 璁粌绛栫暐proto鏂囦欢鍚嶃傞粯璁ゅ硷細None銆 + - **strict_load** (bool) - 琛ㄧず鏄惁涓ユ牸鍔犺浇鍙傛暟鍒扮綉缁溿傚鏋滃间负False锛屽垯褰揷heckpoint鏂囦欢涓弬鏁板悕绉扮殑鍚庣紑涓庣綉缁滀腑鐨勫弬鏁扮浉鍚屾椂锛屽姞杞藉弬鏁板埌缃戠粶銆傚綋绫诲瀷涓嶄竴鑷存椂锛屽鐩稿悓绫诲瀷鐨勫弬鏁拌繘琛岀被鍨嬭浆鎹紝濡備粠float32鍒癴loat16銆傞粯璁ゅ硷細False銆 + - **dec_key** (Union[None, bytes]) - 鐢ㄤ簬瑙ｅ瘑鐨勫瓧鑺傜被鍨媖ey銆傚鏋渧alue涓篘one锛屽垯涓嶉渶瑕佽В瀵嗐傞粯璁ゅ硷細None銆 + - **dec_mode** (str) - 浠呭綋dec_key涓嶈涓篘one鏃讹紝璇ュ弬鏁版湁鏁堛傛寚瀹氫簡瑙ｅ瘑妯″紡锛岀洰鍓嶆敮鎸丄ES-GCM鍜孉ES-CBC銆傞粯璁ゅ硷細AES-GCM銆 - - **network** (Cell) - 鍒嗗竷寮忛娴嬬綉缁溿 - - **checkpoint_filenames** (list[str]) - checkpoint鏂囦欢鐨勫悕绉帮紝鎸塺ank id 椤哄簭鎺掑垪銆 - - **predict_strategy** (dict) - 棰勬祴鏃跺弬鏁扮殑鍒囧垎绛栫暐銆 - - **train_strategy_filename** (str) - 璁粌绛栫暐proto鏂囦欢鍚嶃傞粯璁ゅ硷細None銆 - - **strict_load** (bool) - 琛ㄧず鏄惁涓ユ牸鍔犺浇鍙傛暟鍒扮綉缁溿傚鏋滃间负False锛屽垯褰揷heckpoint鏂囦欢涓弬鏁板悕绉扮殑鍚庣紑涓庣綉缁滀腑鐨勫弬鏁扮浉鍚屾椂锛屽姞杞藉弬鏁板埌缃戠粶銆傚綋绫诲瀷涓嶄竴鑷存椂锛屽鐩稿悓绫诲瀷鐨勫弬鏁拌繘琛岀被鍨嬭浆鎹紝濡備粠float32鍒癴loat16銆傞粯璁ゅ硷細False銆 - - **dec_key** (Union[None, bytes]) - 鐢ㄤ簬瑙ｅ瘑鐨勫瓧鑺傜被鍨媖ey銆傚鏋渧alue涓篘one锛屽垯涓嶉渶瑕佽В瀵嗐傞粯璁ゅ硷細None銆 - - **dec_mode** (str) - 浠呭綋dec_key涓嶈涓篘one鏃讹紝璇ュ弬鏁版湁鏁堛傛寚瀹氫簡瑙ｅ瘑妯″紡锛岀洰鍓嶆敮鎸丄ES-GCM鍜孉ES-CBC銆傞粯璁ゅ硷細AES-GCM銆 - - **寮傚父锛** - - - **TypeError锛** 杈撳叆绫诲瀷涓嶇鍚堣姹傘 - - **ValueError锛** 鏃犳硶鍔犺浇checkpoint鏂囦欢鍒扮綉缁溿 + 寮傚父锛 + - **TypeError** - 杈撳叆绫诲瀷涓嶇鍚堣姹傘 + - **ValueError** - 鏃犳硶鍔犺浇checkpoint鏂囦欢鍒扮綉缁溿 diff --git a/docs/api/api_python/mindspore/mindspore.load_param_into_net.rst b/docs/api/api_python/mindspore/mindspore.load_param_into_net.rst index b378a53c457..2e7f19bf816 100644 --- a/docs/api/api_python/mindspore/mindspore.load_param_into_net.rst +++ b/docs/api/api_python/mindspore/mindspore.load_param_into_net.rst @@ -5,16 +5,13 @@ mindspore.load_param_into_net 灏嗗弬鏁板姞杞藉埌缃戠粶涓紝杩斿洖缃戠粶涓病鏈夎鍔犺浇鐨勫弬鏁板垪琛ㄣ - **鍙傛暟锛** + 鍙傛暟锛 + - **net** (Cell) - 灏嗚鍔犺浇鍙傛暟鐨勭綉缁溿 + - **parameter_dict** (dict) - 鍔犺浇checkpoint鏂囦欢寰楀埌鐨勫瓧鍏搞 + - **strict_load** (bool) - 鏄惁灏嗗弬鏁颁弗鏍煎姞杞藉埌缃戠粶涓傚鏋滄槸False, 瀹冨皢浠ョ浉鍚岀殑鍚庣紑鍚嶅皢鍙傛暟瀛楀吀涓殑鍙傛暟鍔犺浇鍒扮綉缁滀腑锛屽苟浼氬湪绮惧害涓嶅尮閰嶆椂锛岃繘琛岀簿搴﹁浆鎹紝姣斿灏 `float32` 杞崲涓 `float16` 銆傞粯璁ゅ硷細False銆 - - **net** (Cell) 鈥 灏嗚鍔犺浇鍙傛暟鐨勭綉缁溿 - - **parameter_dict** (dict) 鈥 鍔犺浇checkpoint鏂囦欢寰楀埌鐨勫瓧鍏搞 - - **strict_load** (bool) 鈥 鏄惁灏嗗弬鏁颁弗鏍煎姞杞藉埌缃戠粶涓傚鏋滄槸False, 瀹冨皢浠ョ浉鍚岀殑鍚庣紑鍚嶅皢鍙傛暟瀛楀吀涓殑鍙傛暟鍔犺浇鍒扮綉缁滀腑锛屽苟浼氬湪绮惧害涓嶅尮閰嶆椂锛岃繘琛岀簿搴﹁浆鎹紝姣斿灏 `float32` 杞崲涓 `float16` 銆傞粯璁ゅ硷細False銆 + 杩斿洖锛 + List锛岀綉缁滀腑娌℃湁琚姞杞界殑鍙傛暟銆 - **杩斿洖锛** - - List锛岀綉缁滀腑娌℃湁琚姞杞界殑鍙傛暟銆 - - **寮傚父锛** - - - **TypeError** 鈥 濡傛灉鍙傛暟涓嶆槸Cell锛屾垨鑰 `parameter_dict` 涓嶆槸Parameter绫诲瀷鐨勫瓧鍏搞 + 寮傚父锛 + - **TypeError** - 濡傛灉鍙傛暟涓嶆槸Cell锛屾垨鑰 `parameter_dict` 涓嶆槸Parameter绫诲瀷鐨勫瓧鍏搞 diff --git a/docs/api/api_python/mindspore/mindspore.merge_sliced_parameter.rst b/docs/api/api_python/mindspore/mindspore.merge_sliced_parameter.rst index 8fac2af39b6..7ca3aefe8ec 100644 --- a/docs/api/api_python/mindspore/mindspore.merge_sliced_parameter.rst +++ b/docs/api/api_python/mindspore/mindspore.merge_sliced_parameter.rst @@ -5,17 +5,14 @@ mindspore.merge_sliced_parameter 灏嗗弬鏁板垏鐗囧悎骞朵负涓涓畬鏁寸殑鍙傛暟锛岀敤浜庡垎甯冨紡鎺ㄧ悊銆傚叧浜庡畠鐨勭粏鑺傦紝璇峰弬鑰冿細`淇濆瓨鍜屽姞杞芥ā鍨嬶紙HyBrid Parallel妯″紡锛 `_銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **sliced_parameters** (list[Parameter]) - 鍙傛暟鍒囩墖锛屾寜rank id杩涜鎺掑垪銆 + - **strategy** (Optional[dict]) - 鍙傛暟鍒囩墖绛栫暐锛宬ey涓哄弬鏁板悕绉帮紝value涓鸿鍙傛暟鐨勫垏鐗囩瓥鐣ャ傚鏋 `strategy` 涓篘one锛屽垯鍙渶鎸0杞撮『搴忓悎骞跺弬鏁板垏鐗囥傞粯璁ゅ硷細None銆 - - **sliced_parameters** (list[Parameter]) - 鍙傛暟鍒囩墖锛屾寜rank id杩涜鎺掑垪銆 - - **strategy** (Optional[dict]) - 鍙傛暟鍒囩墖绛栫暐锛宬ey涓哄弬鏁板悕绉帮紝value涓鸿鍙傛暟鐨勫垏鐗囩瓥鐣ャ傚鏋 `strategy` 涓篘one锛屽垯鍙渶鎸0杞撮『搴忓悎骞跺弬鏁板垏鐗囥傞粯璁ゅ硷細None銆 + 杩斿洖锛 + 鍚堝苟鍚庣殑鍙傛暟锛屽寘鍚墍鏈夋暟鎹 - **杩斿洖锛** - - 鍚堝苟鍚庣殑鍙傛暟锛屽寘鍚墍鏈夋暟鎹 - - **寮傚父锛** - - - **ValueError** - 鍚堝苟澶辫触銆 - - **TypeError** - `sliced_parameters` 涓嶆纭垨 `strategy` 涓嶆槸dict銆 - - **KeyError** - 鍙傛暟鍚嶇О涓嶅湪绛栫暐鐨刱ey涓 + 寮傚父锛 + - **ValueError** - 鍚堝苟澶辫触銆 + - **TypeError** - `sliced_parameters` 涓嶆纭垨 `strategy` 涓嶆槸dict銆 + - **KeyError** - 鍙傛暟鍚嶇О涓嶅湪绛栫暐鐨刱ey涓 diff --git a/docs/api/api_python/mindspore/mindspore.ms_class.rst b/docs/api/api_python/mindspore/mindspore.ms_class.rst index 0d882be09a0..ead00ebd9b5 100644 --- a/docs/api/api_python/mindspore/mindspore.ms_class.rst +++ b/docs/api/api_python/mindspore/mindspore.ms_class.rst @@ -7,15 +7,12 @@ mindspore.ms_class MindSpore鍙互閫氳繃ms_class璇嗗埆鐢ㄦ埛瀹氫箟鐨勭被锛屼粠鑰岃幏鍙栬繖浜涚被鐨勫睘鎬у拰鏂规硶銆 - **鍙傛暟锛** + 鍙傛暟锛 + - **cls** (Class) - 鐢ㄦ埛鑷畾涔夌殑绫汇 - - **cls** (Class) - 鐢ㄦ埛鑷畾涔夌殑绫汇 + 杩斿洖锛 + 甯︽湁 __ms_class__ 灞炴х殑绫汇 - **杩斿洖锛** - - 甯︽湁 __ms_class__ 灞炴х殑绫汇 - - **寮傚父锛** - - - **TypeError** 鈥 濡傛灉 ms_class 鐢ㄤ簬闈 class 绫诲瀷鎴栬 nn.Cell銆 - - **AttributeError** 鈥 濡傛灉璋冪敤浜 ms_class 瑁呴グ鐨勭被鐨勭鏈夊睘鎬ф垨榄旀湳鏂规硶銆 + 寮傚父锛 + - **TypeError** - 濡傛灉 ms_class 鐢ㄤ簬闈 class 绫诲瀷鎴栬 nn.Cell銆 + - **AttributeError** - 濡傛灉璋冪敤浜 ms_class 瑁呴グ鐨勭被鐨勭鏈夊睘鎬ф垨榄旀湳鏂规硶銆 diff --git a/docs/api/api_python/mindspore/mindspore.ms_function.rst b/docs/api/api_python/mindspore/mindspore.ms_function.rst index b22ccaeb7c2..63ae9929e57 100644 --- a/docs/api/api_python/mindspore/mindspore.ms_function.rst +++ b/docs/api/api_python/mindspore/mindspore.ms_function.rst @@ -7,17 +7,15 @@ mindspore.ms_function MindSpore鍙互鍦ㄨ繍琛屾椂瀵瑰浘杩涜浼樺寲銆 - **鍙傛暟锛** - - - **fn** (Function) - 瑕佺紪璇戞垚鍥剧殑Python鍑芥暟銆傞粯璁ゅ硷細None銆 - - **input_signature** (Tensor) - 鐢ㄤ簬琛ㄧず杈撳叆鍙傛暟鐨凾ensor銆俆ensor鐨剆hape鍜宒type灏嗕綔涓哄嚱鏁扮殑杈撳叆shape鍜宒type銆傞粯璁ゅ硷細None銆 - - **hash_args** (Union[Object, List or Tuple of Objects]) - `fn` 閲岄潰鐢ㄥ埌鐨勮嚜鐢卞彉閲忥紝姣斿澶栭儴鍑芥暟鎴栫被瀵硅薄锛屽啀娆¤皟鐢ㄦ椂鑻 `hash_args` 鍑虹幇鍙樺寲浼氳Е鍙戦噸鏂扮紪璇戙傞粯璁ゅ硷細None銆 - - **jit_config** (JitConfig) - 缂栬瘧鏃舵墍浣跨敤鐨凧itConfig閰嶇疆椤癸紝璇︾粏鍙弬鑰 :class:`mindspore.JitConfig`銆傞粯璁ゅ硷細None銆 + 鍙傛暟锛 + - **fn** (Function) - 瑕佺紪璇戞垚鍥剧殑Python鍑芥暟銆傞粯璁ゅ硷細None銆 + - **input_signature** (Tensor) - 鐢ㄤ簬琛ㄧず杈撳叆鍙傛暟鐨凾ensor銆俆ensor鐨剆hape鍜宒type灏嗕綔涓哄嚱鏁扮殑杈撳叆shape鍜宒type銆傞粯璁ゅ硷細None銆 + - **hash_args** (Union[Object, List or Tuple of Objects]) - `fn` 閲岄潰鐢ㄥ埌鐨勮嚜鐢卞彉閲忥紝姣斿澶栭儴鍑芥暟鎴栫被瀵硅薄锛屽啀娆¤皟鐢ㄦ椂鑻 `hash_args` 鍑虹幇鍙樺寲浼氳Е鍙戦噸鏂扮紪璇戙傞粯璁ゅ硷細None銆 + - **jit_config** (JitConfig) - 缂栬瘧鏃舵墍浣跨敤鐨凧itConfig閰嶇疆椤癸紝璇︾粏鍙弬鑰 :class:`mindspore.JitConfig`銆傞粯璁ゅ硷細None銆 .. note:: - 濡傛灉鎸囧畾浜 `input_signature` 锛屽垯 `fn` 鐨勬瘡涓緭鍏ラ兘蹇呴』鏄疶ensor銆傚苟涓 `fn` 鐨勮緭鍏ュ弬鏁板皢涓嶄細鎺ュ彈 `**kwargs` 鍙傛暟銆 - **杩斿洖锛** - - 鍑芥暟锛屽鏋 `fn` 涓嶆槸None锛屽垯杩斿洖涓涓凡缁忓皢杈撳叆 `fn` 缂栬瘧鎴愬浘鐨勫彲鎵ц鍑芥暟锛涘鏋 `fn` 涓篘one锛屽垯杩斿洖涓涓楗板櫒銆傚綋杩欎釜瑁呴グ鍣ㄤ娇鐢ㄥ崟涓 `fn` 鍙傛暟杩涜璋冪敤鏃讹紝绛変环浜 `fn` 涓嶆槸None鐨勫満鏅 + 杩斿洖锛 + 鍑芥暟锛屽鏋 `fn` 涓嶆槸None锛屽垯杩斿洖涓涓凡缁忓皢杈撳叆 `fn` 缂栬瘧鎴愬浘鐨勫彲鎵ц鍑芥暟锛涘鏋 `fn` 涓篘one锛屽垯杩斿洖涓涓楗板櫒銆傚綋杩欎釜瑁呴グ鍣ㄤ娇鐢ㄥ崟涓 `fn` 鍙傛暟杩涜璋冪敤鏃讹紝绛変环浜 `fn` 涓嶆槸None鐨勫満鏅 diff --git a/docs/api/api_python/mindspore/mindspore.mutable.rst b/docs/api/api_python/mindspore/mindspore.mutable.rst index a4ba64ec9a7..5766b58b523 100644 --- a/docs/api/api_python/mindspore/mindspore.mutable.rst +++ b/docs/api/api_python/mindspore/mindspore.mutable.rst @@ -8,11 +8,10 @@ mindspore.mutable 褰撳墠闄や簡Tensor锛屾墍鏈夐《灞傜綉缁滅殑杈撳叆锛屼緥濡傛爣閲忋乼uple銆乴ist鍜宒ict锛岄兘琚綋鍋氬父閲忓笺傚父閲忓兼槸涓嶈兘姹傚鐨勶紝鑰屼笖鍦ㄧ紪璇戜紭鍖栭樁娈典細琚父閲忔姌鍙犳帀銆 鍙﹀锛屽綋缃戠粶鐨勮緭鍏ユ槸tuple[Tensor], list[Tensor]鎴朌ict[Tensor]鏃讹紝鍗充娇閲岄潰Tensor鐨剆hape鍜宒type娌℃湁鍙戠敓鍙樺寲锛屽湪澶氭璋冪敤鍚屼竴涓綉缁滅殑鏃跺欙紝杩欎釜缃戠粶姣忔閮戒細琚噸鏂扮紪璇戯紝杩欐槸鍥犱负杩欎簺绫诲瀷鐨勮緭鍏ヨ褰撳仛甯搁噺鍊煎鐞嗕簡銆 - 涓鸿В鍐充互涓婄殑闂锛屾垜浠彁渚涗簡 `mutable` 鎺ュ彛鍘昏缃綉缁滅殑甯搁噺杈撳叆涓衡滃彲鍙樼殑鈥濄備竴涓滃彲鍙樼殑鈥濊緭鍏ユ剰鍛崇潃杩欎釜杈撳叆鎴愪负浜嗗儚Tensor涓鏍风殑鍙橀噺銆傛渶閲嶈鐨勬槸锛屾垜浠彲浠ュ鍏惰繘琛屾眰瀵间簡銆 + 涓鸿В鍐充互涓婄殑闂锛屾垜浠彁渚涗簡 `mutable` 鎺ュ彛鍘昏缃綉缁滅殑甯搁噺杈撳叆涓"鍙彉鐨"銆備竴涓"鍙彉鐨"杈撳叆鎰忓懗鐫杩欎釜杈撳叆鎴愪负浜嗗儚Tensor涓鏍风殑鍙橀噺銆傛渶閲嶈鐨勬槸锛屾垜浠彲浠ュ鍏惰繘琛屾眰瀵间簡銆 - **鍙傛暟锛** - - - **input_data** (Union[Tensor, tuple[Tensor], list[Tensor], dict[Tensor]]) - 瑕佽缃负鍙彉鐨勮緭鍏ユ暟鎹 + 鍙傛暟锛 + - **input_data** (Union[Tensor, tuple[Tensor], list[Tensor], dict[Tensor]]) - 瑕佽缃负鍙彉鐨勮緭鍏ユ暟鎹 .. warning:: - 杩欐槸涓涓疄楠岀壒鎬э紝鏈潵鏈夊彲鑳借淇敼鎴栧垹闄ゃ @@ -21,10 +20,8 @@ mindspore.mutable - 褰撳墠鏆傛椂鍙敮鎸佸湪缃戠粶澶栭儴浣跨敤璇ユ帴鍙ｃ - 褰撳墠璇ユ帴鍙ｅ彧鍦ㄥ浘妯″紡涓嬬敓鏁堛 - **杩斿洖锛** + 杩斿洖锛 + 鐘舵佽缃负鍙彉鐨勫師杈撳叆鏁版嵁銆 - 鐘舵佽缃负鍙彉鐨勫師杈撳叆鏁版嵁銆 - - **寮傚父锛** - - - **TypeError** 鈥 濡傛灉 `input_data` 涓嶆槸Tensor銆乼uple[Tensor]銆乴ist[Tensor]鎴杁ict[Tensor]鐨勫叾涓竴绉嶇被鍨嬫垨鑰呬笉鏄畠浠殑宓屽缁撴瀯銆 + 寮傚父锛 + - **TypeError** - 濡傛灉 `input_data` 涓嶆槸Tensor銆乼uple[Tensor]銆乴ist[Tensor]鎴杁ict[Tensor]鐨勫叾涓竴绉嶇被鍨嬫垨鑰呬笉鏄畠浠殑宓屽缁撴瀯銆 diff --git a/docs/api/api_python/mindspore/mindspore.parse_print.rst b/docs/api/api_python/mindspore/mindspore.parse_print.rst index 99716c43aaa..44474bcbc0b 100644 --- a/docs/api/api_python/mindspore/mindspore.parse_print.rst +++ b/docs/api/api_python/mindspore/mindspore.parse_print.rst @@ -5,15 +5,12 @@ mindspore.parse_print 瑙ｆ瀽鐢 mindspore.ops.Print 鐢熸垚鐨勬暟鎹枃浠躲 - **鍙傛暟锛** + 鍙傛暟锛 + - **print_file_name** (str) - 闇瑕佽В鏋愮殑鏂囦欢鍚嶃 - **print_file_name** (str) 鈥 闇瑕佽В鏋愮殑鏂囦欢鍚嶃 + 杩斿洖锛 + List锛岀敱Tensor缁勬垚鐨刲ist銆 - **杩斿洖锛** - - List锛岀敱Tensor缁勬垚鐨刲ist銆 - - **寮傚父锛** - - - **ValueError** 鈥 鎸囧畾鐨勬枃浠朵笉瀛樺湪鎴栦负绌恒 - - **RuntimeError** - 瑙ｆ瀽鏂囦欢澶辫触銆 + 寮傚父锛 + - **ValueError** - 鎸囧畾鐨勬枃浠朵笉瀛樺湪鎴栦负绌恒 + - **RuntimeError** - 瑙ｆ瀽鏂囦欢澶辫触銆