tf.compat.v1.summary.FileWriter：将Summary协议缓冲区写入事件文件。
tf.compat.v1.summary.FileWriter(
logdir, graph=None, max_queue=10, flush_secs=120, graph_def=None,
filename_suffix=None, session=None
)本FileWriter类提供了一个机制来创建指定目录的事件文件，并添加摘要和事件给它。该类异步更新文件内容。这样，训练程序就可以直接从训练循环中调用将数据添加到文件的方法，而不会减慢训练速度。
当使用tf.compat.v1.Session参数构造时，FileWriter会在新的基于图的摘要上形成一个兼容层，以便于将新的摘要编写与需要FileWriter实例的现有代码配合使用。
此类不是线程安全的。
Args |
|
|---|---|
logdir |
一个字符串。将要写入事件文件的目录。 |
graph |
一个Graph对象，如：sess.graph |
max_queue |
整数。等待事件和摘要的队列的大小。 |
flush_secs |
数。将要挂起的事件和摘要刷新到磁盘的频率（以秒为单位）。 |
graph_def |
已弃用：请改用graph参数。 |
filename_suffix |
一个字符串。每个事件文件的名称都带有后缀 suffix。 |
session |
一个tf.compat.v1.Session对象。 |
Raises |
|
|---|---|
RuntimeError |
如果在启用急切执行的情况下调用。 |
Methods:
add_event:
add_event(
event
)将事件添加到事件文件。
| Args | |
|---|---|
event |
一个Event协议缓冲器。 |
add_graph:
add_graph(
graph, global_step=None, graph_def=None
)向事件文件添加一个Graph。
协议缓冲区描述的图形将由TensorBoard显示。大多数用户改为在构造函数中传递图形。
| Args | |
|---|---|
graph |
一个Graph对象，如。 sess.graph |
global_step |
数。可选的全局步数计数器，用于与图形一起记录。 |
graph_def |
已弃用。请改用graph参数。 |
| Raises | |
|---|---|
ValueError |
如果graph和graph_def都传递给该方法。 |
add_meta_graph:
add_meta_graph(
meta_graph_def, global_step=None
)向事件文件添加一个MetaGraphDef。
MetaGraphDef允许运行给定的图通过 saver.import_meta_graph()。
| Args | |
|---|---|
meta_graph_def |
一个MetaGraphDef对象，通常由saver.export_meta_graph()返回 。 |
global_step |
数。可选的全局步数计数器，用于与图形一起记录。 |
| Raises | |
|---|---|
TypeError |
如果两者meta_graph_def都不是MetaGraphDef的实例。 |
add_run_metadata:
add_run_metadata(
run_metadata, tag, global_step=None
)为单个session.run（）调用添加元数据信息。
| Args | |
|---|---|
run_metadata |
一个RunMetadataprotobuf对象。 |
tag |
此元数据的标签名称。 |
global_step |
数。可选的全局步骤计数器，用于与StepStats一起记录。 |
| Raises | |
|---|---|
ValueError |
如果提供的标签已用于此类事件。 |
add_session_log:
add_session_log(
session_log, global_step=None
)将SessionLog协议缓冲区添加到事件文件。
此方法将提供的会话包装在Event协议缓冲区中，并将其添加到事件文件中。
| Args | |
|---|---|
session_log |
一个SessionLog协议缓冲器。 |
global_step |
数。与摘要一起记录的可选全局步骤值。 |
add_summary:
add_summary(
summary, global_step=None
)将Summary协议缓冲区添加到事件文件。
此方法将提供的摘要包装在Event协议缓冲区中，并将其添加到事件文件中。
可以使用tf.Session.run或 tf.Tensor.eval将任何汇总op的求值结果传递 给此函数。或者，可以传递一个tf.compat.v1.Summary使用自己的数据填充的协议缓冲区。后者通常用于在事件文件中报告评估结果。
| Args | |
|---|---|
summary |
一个Summary协议缓冲，任选序列化为字符串。 |
global_step |
数。与摘要一起记录的可选全局步骤值。 |
close:
close()将事件文件刷新到磁盘并关闭文件。
当您不再需要摘要编写器时，请调用此方法。
flush:
flush()将事件文件刷新到磁盘。
调用此方法以确保所有未决事件均已写入磁盘。
get_logdir:
get_logdir()返回将要写入事件文件的目录。
reopen:
reopen()重新打开EventFileWriter。
之后close()可以在同一目录中添加更多事件后调用。事件将进入新的事件文件。
如果未关闭EventFileWriter，则不执行任何操作。