Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Update profiler doc #13901

Merged
merged 2 commits into from
Jan 17, 2019
Merged

Update profiler doc #13901

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d70c682
Update c_api_profile.cc
eric-haibin-lin Jan 16, 2019
3d621d9
Update c_api_profile.cc
eric-haibin-lin Jan 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions src/c_api/c_api_profile.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. "
eric-haibin-lin marked this conversation as resolved.
Show resolved Hide resolved
"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.");
eric-haibin-lin marked this conversation as resolved.
Show resolved Hide resolved
DMLC_DECLARE_FIELD(profile_process)
.add_enum("worker", static_cast<int>(ProfileProcess::kWorker))
.add_enum("server", static_cast<int>(ProfileProcess::kServer))
Expand Down