Skip to content

Commit a770ce0

Browse files
authored
add doc for memory_optimize, test=develop (#17010)
* add doc for memory_optimize, test=develop * update doc, test=develop * doc update, test=develop
1 parent d9991dc commit a770ce0

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

paddle/fluid/pybind/pybind.cc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1347,7 +1347,16 @@ All parameter, weight, gradient are variables in Paddle.
13471347
.def_property(
13481348
"memory_optimize",
13491349
[](const BuildStrategy &self) { return self.memory_optimize_; },
1350-
[](BuildStrategy &self, bool b) { self.memory_optimize_ = b; })
1350+
[](BuildStrategy &self, bool b) { self.memory_optimize_ = b; },
1351+
R"DOC(The type is BOOL, memory opitimize aims to save total memory
1352+
consumption, set to True to enable it.
1353+
1354+
Memory Optimize is our experimental feature, some variables
1355+
may be reused/removed by optimize strategy. If you need to
1356+
fetch some variable values when using this feature, please
1357+
set the persistable property of the variables to True.
1358+
1359+
Default False)DOC")
13511360
.def_property(
13521361
"is_distribution",
13531362
[](const BuildStrategy &self) { return self.is_distribution_; },

0 commit comments

Comments
 (0)