This is an automated email from the ASF dual-hosted git repository.
haibin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new 86e9180 Update profiler doc (#13901)
86e9180 is described below
commit 86e91806af650d68e20c0cbbefa557ba49a61014
Author: Haibin Lin <[email protected]>
AuthorDate: Wed Jan 16 21:35:35 2019 -0800
Update profiler doc (#13901)
* Update c_api_profile.cc
* Update c_api_profile.cc
---
src/c_api/c_api_profile.cc | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/src/c_api/c_api_profile.cc b/src/c_api/c_api_profile.cc
index 9c03b33..dc1b781 100644
--- a/src/c_api/c_api_profile.cc
+++ b/src/c_api/c_api_profile.cc
@@ -215,25 +215,26 @@ struct ProfileConfigParam : public
dmlc::Parameter<ProfileConfigParam> {
int profile_process;
DMLC_DECLARE_PARAMETER(ProfileConfigParam) {
DMLC_DECLARE_FIELD(profile_all).set_default(false)
- .describe("Profile all.");
+ .describe("Profile all. Default is False.");
DMLC_DECLARE_FIELD(profile_symbolic).set_default(true)
- .describe("Profile symbolic operators.");
+ .describe("Profile symbolic operators. Default is True.");
DMLC_DECLARE_FIELD(profile_imperative).set_default(true)
- .describe("Profile imperative operators.");
+ .describe("Profile imperative operators. Default is True.");
DMLC_DECLARE_FIELD(profile_memory).set_default(true)
- .describe("Profile memory.");
+ .describe("Profile memory. Default is True.");
DMLC_DECLARE_FIELD(profile_api).set_default(true)
- .describe("Profile C API.");
+ .describe("Profile C API. Default is True.");
DMLC_DECLARE_FIELD(filename).set_default("profile.json")
.describe("File name to write profiling info.");
DMLC_DECLARE_FIELD(continuous_dump).set_default(true)
- .describe("Periodically dump (and append) priofling data to file while
running.");
+ .describe("Periodically dump (and append) profiling data to file while
running. "
+ "Default is True.");
DMLC_DECLARE_FIELD(dump_period).set_default(1.0f)
.describe("When continuous dump is enabled, the period between
subsequent "
"profile info dumping.");
DMLC_DECLARE_FIELD(aggregate_stats).set_default(false)
.describe("Maintain aggregate stats, required for MXDumpAggregateStats.
Note that "
- "this can have anegative performance impact.");
+ "this can have a negative performance impact. Default is False.");
DMLC_DECLARE_FIELD(profile_process)
.add_enum("worker", static_cast<int>(ProfileProcess::kWorker))
.add_enum("server", static_cast<int>(ProfileProcess::kServer))
