!30172 Add chinese api for ms_memory_recycle

Merge pull request !30172 from huangbingjian/code_docs_memory
2022-02-17 10:42:52 +00:00 · 2022-02-17 10:42:52 +00:00 · abe8b8422a
parent f9da3f44dc e1005e9d63
commit abe8b8422a
2 changed files with 10 additions and 3 deletions
--- a/docs/api/api_python/mindspore.rst
+++ b/docs/api/api_python/mindspore.rst
@ -134,8 +134,5 @@ mindspore

 .. mscnautosummary::
    :toctree: mindspore
-    :nosignatures:
-    :template: classtemplate.rst

    mindspore.ms_memory_recycle
-    
--- a/docs/api/api_python/mindspore/mindspore.ms_memory_recycle.rst
+++ b/docs/api/api_python/mindspore/mindspore.ms_memory_recycle.rst
@ -0,0 +1,10 @@
+mindspore.ops.ms_memory_recycle
+================================
+
+.. py:function:: mindspore.ops.ms_memory_recycle()
+
+    回收MindSpore使用的内存。
+
+    在一个进程中训练多个神经网络模型时，MindSpore使用的内存非常大，这是因为MindSpore为每个模型缓存了运行时的内存。
+
+    为了回收这些缓存的内存，用户可以在训练一个模型后调用这个函数。