tf.summary.SummaryWriter | TensorFlow v2.16.1 (original) (raw)
tf.summary.SummaryWriter
Stay organized with collections Save and categorize content based on your preferences.
Interface representing a stateful summary writer object.
Methods
as_default
as_default(
step=None
)
Returns a context manager that enables summary writing.
For convenience, if step is not None, this function also sets a default value for the step parameter used in summary-writing functions elsewhere in the API so that it need not be explicitly passed in every such invocation. The value can be a constant or a variable.
For example, step can be used as:
with writer_a.as_default(step=10):
tf.summary.scalar(tag, value) # Logged to writer_a with step 10
with writer_b.as_default(step=20):
tf.summary.scalar(tag, value) # Logged to writer_b with step 20
tf.summary.scalar(tag, value) # Logged to writer_a with step 10
| Args | |
|---|---|
| step | An int64-castable default step value, or None. When not None, the current step is captured, replaced by a given one, and the original one is restored when the context manager exits. When None, the current step is not modified (and not restored when the context manager exits). |
| Returns |
|---|
| The context manager. |
close
close()
Flushes and closes the summary writer.
flush
flush()
Flushes any buffered data.
init
init()
Initializes the summary writer.
set_as_default
set_as_default(
step=None
)
Enables this summary writer for the current thread.
For convenience, if step is not None, this function also sets a default value for the step parameter used in summary-writing functions elsewhere in the API so that it need not be explicitly passed in every such invocation. The value can be a constant or a variable.
| Args | |
|---|---|
| step | An int64-castable default step value, or None. When not None, the current step is modified to the given value. When None, the current step is not modified. |