Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Fixing TrainingListener documentation #718

Merged
merged 2 commits into from
Mar 3, 2021
Merged

[DOCS] Fixing TrainingListener documentation #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
270918b
Fixing TrainingListener documentation
aksrajvanshi Mar 2, 2021
f9f8ce1
Fixing PR reviews
aksrajvanshi Mar 3, 2021
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
8 changes: 7 additions & 1 deletion api/src/main/java/ai/djl/training/listener/MemoryTrainingListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ public MemoryTrainingListener() {}
/**
* Constructs a {@link MemoryTrainingListener} that outputs data in the given directory.
*
* <p>If an output directory is provided, the file "$outputDir/memory.log" will be created after
* training with the memory usage results. The log file consists of heap bytes, non-heap bytes,
* cpu percentage and rss bytes consumption along with the timestamps.
*
* @param outputDir the directory to output the tracked memory data in
*/
public MemoryTrainingListener(String outputDir) {
Expand Down Expand Up @@ -81,7 +85,9 @@ public void onTrainingEnd(Trainer trainer) {
}

/**
* Collect memory information.
* Collects memory information. In order to collect metrics, the {@link Trainer} must set
* metrics. Monitor the metrics by enabling the following flag in the command line arguments:
* -Dcollect-memory=true
*
* @param metrics {@link Metrics} to store memory information
*/
Expand Down
5 changes: 3 additions & 2 deletions api/src/main/java/ai/djl/training/listener/SaveModelTrainingListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ public void setOverrideModelName(String overrideModelName) {
}

/**
* Returns the checkpoint frequency (or -1 for no checkpointing).
* Returns the checkpoint frequency (or -1 for no checkpointing) in {@link
* SaveModelTrainingListener}.
*
* @return the checkpoint frequency (or -1 for no checkpointing)
*/
Expand All @@ -117,7 +118,7 @@ public int getCheckpoint() {
}

/**
* Sets the checkpoint frequency.
* Sets the checkpoint frequency in {@link SaveModelTrainingListener}.
*
* @param checkpoint how many epochs between checkpoints (or -1 for no checkpoints)
*/
Expand Down