Add a note for summary only supports linux systems

pull/5989/head
ougongchang 4 years ago
parent 5166fe832d
commit e93365c664

@ -68,6 +68,7 @@ class SummaryCollector(Callback):
1. Multiple SummaryCollector instances in callback list are not allowed.
2. Not all information is collected at the training phase or at the eval phase.
3. SummaryCollector always record the data collected by the summary operator.
4. SummaryCollector only supports Linux systems.
Args:
summary_dir (str): The collected data will be persisted to this directory.

@ -72,6 +72,7 @@ class SummaryRecord:
1. Make sure to close the SummaryRecord at the end, otherwise the process will not exit.
Please see the Example section below to learn how to close properly in two ways.
2. Only one SummaryRecord instance is allowed at a time, otherwise it will cause data writing problems.
3. SummaryRecord only supports Linux systems.
Args:
log_dir (str): The log_dir is a directory location to save the summary.

Loading…
Cancel
Save