# tf.summary.FileWriter

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L283-L431) |

Writes `Summary` protocol buffers to event files.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.summary.FileWriter`](https://www.tensorflow.org/api_docs/python/tf/compat/v1/summary/FileWriter)

<br />

    tf.summary.FileWriter(
        logdir, graph=None, max_queue=10, flush_secs=120, graph_def=None,
        filename_suffix=None, session=None
    )

The `FileWriter` class provides a mechanism to create an event file in a
given directory and add summaries and events to it. The class updates the
file contents asynchronously. This allows a training program to call methods
to add data to the file directly from the training loop, without slowing down
training.

When constructed with a [`tf.compat.v1.Session`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Session) parameter, a `FileWriter`
instead forms a compatibility layer over new graph-based summaries
([`tf.contrib.summary`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/contrib/summary)) to facilitate the use of new summary writing with
pre-existing code that expects a `FileWriter` instance.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `logdir` | A string. Directory where event file will be written. |
| `graph` | A `Graph` object, such as `sess.graph`. |
| `max_queue` | Integer. Size of the queue for pending events and summaries. |
| `flush_secs` | Number. How often, in seconds, to flush the pending events and summaries to disk. |
| `graph_def` | DEPRECATED: Use the `graph` argument instead. |
| `filename_suffix` | A string. Every event file's name is suffixed with `suffix`. |
| `session` | A [`tf.compat.v1.Session`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Session) object. See details above. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `RuntimeError` | If called with eager execution enabled. |

<br />

## Methods

### `add_event`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L394-L401)

    add_event(
        event
    )

Adds an event to the event file.

<br />

<br />

<br />

| Args ||
|---|---|
| `event` | An `Event` protocol buffer. |

<br />

### `add_graph`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L163-L214)

    add_graph(
        graph, global_step=None, graph_def=None
    )

Adds a `Graph` to the event file.

The graph described by the protocol buffer will be displayed by
TensorBoard. Most users pass a graph in the constructor instead.

<br />

<br />

<br />

| Args ||
|---|---|
| `graph` | A `Graph` object, such as `sess.graph`. |
| `global_step` | Number. Optional global step counter to record with the graph. |
| `graph_def` | DEPRECATED. Use the `graph` parameter instead. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If both graph and graph_def are passed to the method. |

<br />

### `add_meta_graph`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L229-L249)

    add_meta_graph(
        meta_graph_def, global_step=None
    )

Adds a `MetaGraphDef` to the event file.

The `MetaGraphDef` allows running the given graph via
`saver.import_meta_graph()`.

<br />

<br />

<br />

| Args ||
|---|---|
| `meta_graph_def` | A `MetaGraphDef` object, often as returned by `saver.export_meta_graph()`. |
| `global_step` | Number. Optional global step counter to record with the graph. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `TypeError` | If both `meta_graph_def` is not an instance of `MetaGraphDef`. |

<br />

### `add_run_metadata`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L251-L273)

    add_run_metadata(
        run_metadata, tag, global_step=None
    )

Adds a metadata information for a single session.run() call.

<br />

<br />

<br />

| Args ||
|---|---|
| `run_metadata` | A `RunMetadata` protobuf object. |
| `tag` | The tag name for this metadata. |
| `global_step` | Number. Optional global step counter to record with the StepStats. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If the provided tag was already used for this type of event. |

<br />

### `add_session_log`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L144-L156)

    add_session_log(
        session_log, global_step=None
    )

Adds a `SessionLog` protocol buffer to the event file.

This method wraps the provided session in an `Event` protocol buffer
and adds it to the event file.

<br />

<br />

<br />

| Args ||
|---|---|
| `session_log` | A `SessionLog` protocol buffer. |
| `global_step` | Number. Optional global step value to record with the summary. |

<br />

### `add_summary`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L101-L142)

    add_summary(
        summary, global_step=None
    )

Adds a `Summary` protocol buffer to the event file.

This method wraps the provided summary in an `Event` protocol buffer
and adds it to the event file.

You can pass the result of evaluating any summary op, using
[`tf.Session.run`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Session#run) or
[`tf.Tensor.eval`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Tensor#eval), to this
function. Alternatively, you can pass a [`tf.compat.v1.Summary`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Summary) protocol
buffer that you populate with your own data. The latter is
commonly done to report evaluation results in event files.

<br />

<br />

<br />

| Args ||
|---|---|
| `summary` | A `Summary` protocol buffer, optionally serialized as a string. |
| `global_step` | Number. Optional global step value to record with the summary. |

<br />

### `close`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L414-L420)

    close()

Flushes the event file to disk and close the file.

Call this method when you do not need the summary writer anymore.

### `flush`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L403-L412)

    flush()

Flushes the event file to disk.

Call this method to make sure that all pending events have been written to
disk.

### `get_logdir`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L380-L382)

    get_logdir()

Returns the directory where event file will be written.

### `reopen`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L422-L431)

    reopen()

Reopens the EventFileWriter.

Can be called after `close()` to add more events in the same directory.
The events will go into a new events file.

Does nothing if the EventFileWriter was not closed.

### `__enter__`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L372-L374)

    __enter__()

Make usable with "with" statement.

### `__exit__`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/writer/writer.py#L376-L378)

    __exit__(
        unused_type, unused_value, unused_traceback
    )

Make usable with "with" statement.