SummaryFileWriter

Writes Summary protocol buffers to event files for use with TensorBoard.

The SummaryFileWriter 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.

On construction the summary writer creates a new event file in workingDir. This event file will contain Event protocol buffers constructed when you call one of the following functions: writeGraph(), writeSummary(), writeSessionLog(), or writeRunMetadata().

If you pass a Graph to the constructor it is write to the event file, which is equivalent to calling writeGraph() later on.

TensorBoard will pick up the graph from the file and display it graphically so you can interactively explore it. You will usually pass the graph from the session in which you launched it:

// Create a graph.
val graph = Graph()
...
// Launch the graph in a session.
val session = Session(graph)
// Create a summary file writer and add the graph to the event file.
val writer = SummaryWriter(workingDir, session.graph)

Linear Supertypes

EventFileWriter, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Calls flush() and then closes the current event file.
Calls flush() and then closes the current event file.

Definition Classes
EventFileWriter
def closed: Boolean

Returns true if this event file writer has been closed.
Returns true if this event file writer has been closed.

Definition Classes
EventFileWriter
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val filenameSuffix: String

Filename suffix to use for the event file.
Filename suffix to use for the event file.

Definition Classes
SummaryFileWriter → EventFileWriter
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flush(): Unit

Pushes outstanding events to disk.
Pushes outstanding events to disk.

Definition Classes
EventFileWriter
val flushFrequency: Int

Specifies how often to flush the written events to disk (in seconds).
Specifies how often to flush the written events to disk (in seconds).

Definition Classes
SummaryFileWriter → EventFileWriter
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val queueCapacity: Int

Maximum number of events pending to be written to disk before a call to write() blocks.
Maximum number of events pending to be written to disk before a call to write() blocks.

Definition Classes
SummaryFileWriter → EventFileWriter
def reopen(): Unit

Reopens this event file writer.
Reopens this event file writer.

Definition Classes
EventFileWriter
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val workingDir: Path

Directory in which to write the event file.
Directory in which to write the event file.

Definition Classes
SummaryFileWriter → EventFileWriter
def write(event: Event): Unit

Writes the provided event to the event file.
Writes the provided event to the event file.

Definition Classes
EventFileWriter
def writeGraph(graph: core.Graph, step: Long = 0L): Unit

Writes a Graph to the event file along with its meta-information.
Writes a Graph to the event file along with its meta-information.
This method wraps the provided graph in an Event protocol buffer and writes it to the event file. The provided graph will be displayed by TensorBoard. Most users pass a graph in the constructor instead.
graph
Graph to write.
step
Global step number to record with the graph.
def writeGraphDef(graphDef: GraphDef, step: Long = 0L): Unit

Writes a GraphDef to the event file.
Writes a GraphDef to the event file.
This method wraps the provided GraphDef in an Event protocol buffer and writes it to the event file.
graphDef
GraphDef to write.
step
Global step number to record with the GraphDef.
def writeMetaGraphDef(metaGraphDef: MetaGraphDef, step: Long = 0L): Unit

Writes a MetaGraphDef to the event file.
Writes a MetaGraphDef to the event file.
This method wraps the provided MetaGraphDef in an Event protocol buffer and writes it to the event file.
metaGraphDef
MetaGraphDef to write.
step
Global step number to record with the MetaGraphDef.
def writeRunMetadata(runMetadata: RunMetadata, tag: String, step: Long): Unit

Writes run metadata information for a single Session.run() call to the event file.
Writes run metadata information for a single Session.run() call to the event file.
runMetadata
Run metadata to write.
tag
Tag name for these metadata.
step
Global step number to record with the summary.

Annotations
@throws( ... )
Exceptions thrown
IllegalArgumentException If the provided tag has already been used for this event type.
def writeSessionLog(sessionLog: SessionLog, step: Long): Unit

Writes a SessionLog to the event file.
Writes a SessionLog to the event file.
This method wraps the provided session log in an Event protocol buffer and writes it to the event file.
sessionLog
Session log to write.
step
Global step number to record with the session log.
def writeSummary(summary: Summary, step: Long): Unit

Writes a Summary protocol buffer to the event file.
Writes a Summary protocol buffer to the event file.
This method wraps the provided summary in an Event protocol buffer and writes it to the event file.
summary
Summary to write.
step
Global step number to record with the summary.
def writeSummaryString(summary: String, step: Long): Unit

Writes a Summary protocol buffer to the event file given a string representation of that protocol buffer.
Writes a Summary protocol buffer to the event file given a string representation of that protocol buffer.
This method wraps the provided summary in an Event protocol buffer and writes it to the event file.
You can pass the result of evaluating any summary op (e.g., using Session.run()) to this function.
summary
String representation of the summary to write.
step
Global step number to record with the summary.

Related Docs: object SummaryFileWriter | package events

class SummaryFileWriter extends EventFileWriter

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Unit

def closed: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val filenameSuffix: String

def finalize(): Unit

def flush(): Unit

val flushFrequency: Int

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val queueCapacity: Int

def reopen(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val workingDir: Path

def write(event: Event): Unit

def writeGraph(graph: core.Graph, step: Long = 0L): Unit

def writeGraphDef(graphDef: GraphDef, step: Long = 0L): Unit

def writeMetaGraphDef(metaGraphDef: MetaGraphDef, step: Long = 0L): Unit

def writeRunMetadata(runMetadata: RunMetadata, tag: String, step: Long): Unit

def writeSessionLog(sessionLog: SessionLog, step: Long): Unit

def writeSummary(summary: Summary, step: Long): Unit

def writeSummaryString(summary: String, step: Long): Unit

Inherited from EventFileWriter

Inherited from AnyRef

Inherited from Any

Ungrouped