szha commented on a change in pull request #13901: Update profiler doc
URL: https://github.com/apache/incubator-mxnet/pull/13901#discussion_r248166623
##########
File path: 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) priofling 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 anegative performance impact. Default is False.");
Review comment:
another typo
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
