diff options
author | A. Unique TensorFlower <gardener@tensorflow.org> | 2016-12-01 12:55:08 -0800 |
---|---|---|
committer | TensorFlower Gardener <gardener@tensorflow.org> | 2016-12-01 13:14:51 -0800 |
commit | c3840e07d7ddf319ef6cccee454ccb61a10f2edd (patch) | |
tree | 137ff60c37bd0afda412201b34f206d4149dd96f | |
parent | 6e6deda498b0188bf2c1787730be174c61555386 (diff) |
Update generated Python Op docs.
Change: 140764844
-rw-r--r-- | tensorflow/g3doc/api_docs/python/contrib.learn.monitors.md | 31 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.train.SummaryWriterCache.clear.md | 4 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.monitors.SummaryWriterCache.get.md (renamed from tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.train.SummaryWriterCache.get.md) | 2 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.monitors.SummaryWriterCache.md (renamed from tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriterCache.md) | 4 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.monitors.SummaryWriterCache.clear.md | 4 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriter.md | 207 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/index.md | 3 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/train.md | 247 |
8 files changed, 41 insertions, 461 deletions
diff --git a/tensorflow/g3doc/api_docs/python/contrib.learn.monitors.md b/tensorflow/g3doc/api_docs/python/contrib.learn.monitors.md index d4d200399e..9b9a4e8504 100644 --- a/tensorflow/g3doc/api_docs/python/contrib.learn.monitors.md +++ b/tensorflow/g3doc/api_docs/python/contrib.learn.monitors.md @@ -2655,6 +2655,37 @@ Wraps monitors into a SessionRunHook. - - - +### `class tf.contrib.learn.monitors.SummaryWriterCache` {#SummaryWriterCache} + +Cache for file writers. + +This class caches file writers, one per directory. +- - - + +#### `tf.contrib.learn.monitors.SummaryWriterCache.clear()` {#SummaryWriterCache.clear} + +Clear cached summary writers. Currently only used for unit tests. + + +- - - + +#### `tf.contrib.learn.monitors.SummaryWriterCache.get(logdir)` {#SummaryWriterCache.get} + +Returns the FileWriter for the specified directory. + +##### Args: + + +* <b>`logdir`</b>: str, name of the directory. + +##### Returns: + + A `FileWriter`. + + + +- - - + ### `tf.contrib.learn.monitors.replace_monitors_with_hooks(monitors_or_hooks, estimator)` {#replace_monitors_with_hooks} Wraps monitors with a hook. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.train.SummaryWriterCache.clear.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.train.SummaryWriterCache.clear.md deleted file mode 100644 index adc6984e2e..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.train.SummaryWriterCache.clear.md +++ /dev/null @@ -1,4 +0,0 @@ -#### `tf.train.SummaryWriterCache.clear()` {#SummaryWriterCache.clear} - -Clear cached summary writers. Currently only used for unit tests. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.train.SummaryWriterCache.get.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.monitors.SummaryWriterCache.get.md index d5fee8f7b4..35b49b99cf 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.train.SummaryWriterCache.get.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.monitors.SummaryWriterCache.get.md @@ -1,4 +1,4 @@ -#### `tf.train.SummaryWriterCache.get(logdir)` {#SummaryWriterCache.get} +#### `tf.contrib.learn.monitors.SummaryWriterCache.get(logdir)` {#SummaryWriterCache.get} Returns the FileWriter for the specified directory. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriterCache.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.monitors.SummaryWriterCache.md index 01136ac630..8c700a1899 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriterCache.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.monitors.SummaryWriterCache.md @@ -3,14 +3,14 @@ Cache for file writers. This class caches file writers, one per directory. - - - -#### `tf.train.SummaryWriterCache.clear()` {#SummaryWriterCache.clear} +#### `tf.contrib.learn.monitors.SummaryWriterCache.clear()` {#SummaryWriterCache.clear} Clear cached summary writers. Currently only used for unit tests. - - - -#### `tf.train.SummaryWriterCache.get(logdir)` {#SummaryWriterCache.get} +#### `tf.contrib.learn.monitors.SummaryWriterCache.get(logdir)` {#SummaryWriterCache.get} Returns the FileWriter for the specified directory. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.monitors.SummaryWriterCache.clear.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.monitors.SummaryWriterCache.clear.md new file mode 100644 index 0000000000..b77f11673d --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.monitors.SummaryWriterCache.clear.md @@ -0,0 +1,4 @@ +#### `tf.contrib.learn.monitors.SummaryWriterCache.clear()` {#SummaryWriterCache.clear} + +Clear cached summary writers. Currently only used for unit tests. + diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriter.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriter.md deleted file mode 100644 index 8abe6fba48..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.train.SummaryWriter.md +++ /dev/null @@ -1,207 +0,0 @@ - -- - - - -#### `tf.train.SummaryWriter.__init__(*args, **kwargs)` {#SummaryWriter.__init__} - -Creates a `SummaryWriter` and an event file. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.FileWriter. The interface and behavior is the same; this is just a rename. - - This class is deprecated, and should be replaced with tf.summary.FileWriter. - - On construction the summary writer creates a new event file in `logdir`. - This event file will contain `Event` protocol buffers constructed when you - call one of the following functions: `add_summary()`, `add_session_log()`, - `add_event()`, or `add_graph()`. - - If you pass a `Graph` to the constructor it is added to - the event file. (This is equivalent to calling `add_graph()` later). - - TensorBoard will pick the graph from the file and display it graphically so - you can interactively explore the graph you built. You will usually pass - the graph from the session in which you launched it: - - ```python - ...create a graph... - # Launch the graph in a session. - sess = tf.Session() - # Create a summary writer, add the 'graph' to the event file. - writer = tf.summary.FileWriter(<some-directory>, sess.graph) - ``` - - The other arguments to the constructor control the asynchronous writes to - the event file: - - * `flush_secs`: How often, in seconds, to flush the added summaries - and events to disk. - * `max_queue`: Maximum number of summaries or events pending to be - written to disk before one of the 'add' calls block. - - 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. - - -- - - - -#### `tf.train.SummaryWriter.add_event(event)` {#SummaryWriter.add_event} - -Adds an event to the event file. - -##### Args: - - -* <b>`event`</b>: An `Event` protocol buffer. - - -- - - - -#### `tf.train.SummaryWriter.add_graph(graph, global_step=None, graph_def=None)` {#SummaryWriter.add_graph} - -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. - -##### Args: - - -* <b>`graph`</b>: A `Graph` object, such as `sess.graph`. -* <b>`global_step`</b>: Number. Optional global step counter to record with the - graph. -* <b>`graph_def`</b>: DEPRECATED. Use the `graph` parameter instead. - -##### Raises: - - -* <b>`ValueError`</b>: If both graph and graph_def are passed to the method. - - -- - - - -#### `tf.train.SummaryWriter.add_meta_graph(meta_graph_def, global_step=None)` {#SummaryWriter.add_meta_graph} - -Adds a `MetaGraphDef` to the event file. - -The `MetaGraphDef` allows running the given graph via -`saver.import_meta_graph()`. - -##### Args: - - -* <b>`meta_graph_def`</b>: A `MetaGraphDef` object, often as retured by - `saver.export_meta_graph()`. -* <b>`global_step`</b>: Number. Optional global step counter to record with the - graph. - -##### Raises: - - -* <b>`TypeError`</b>: If both `meta_graph_def` is not an instance of `MetaGraphDef`. - - -- - - - -#### `tf.train.SummaryWriter.add_run_metadata(run_metadata, tag, global_step=None)` {#SummaryWriter.add_run_metadata} - -Adds a metadata information for a single session.run() call. - -##### Args: - - -* <b>`run_metadata`</b>: A `RunMetadata` protobuf object. -* <b>`tag`</b>: The tag name for this metadata. -* <b>`global_step`</b>: Number. Optional global step counter to record with the - StepStats. - -##### Raises: - - -* <b>`ValueError`</b>: If the provided tag was already used for this type of event. - - -- - - - -#### `tf.train.SummaryWriter.add_session_log(session_log, global_step=None)` {#SummaryWriter.add_session_log} - -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. - -##### Args: - - -* <b>`session_log`</b>: A `SessionLog` protocol buffer. -* <b>`global_step`</b>: Number. Optional global step value to record with the - summary. - - -- - - - -#### `tf.train.SummaryWriter.add_summary(summary, global_step=None)` {#SummaryWriter.add_summary} - -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 -[`Session.run()`](client.md#Session.run) or -[`Tensor.eval()`](framework.md#Tensor.eval), to this -function. Alternatively, you can pass a `tf.Summary` protocol -buffer that you populate with your own data. The latter is -commonly done to report evaluation results in event files. - -##### Args: - - -* <b>`summary`</b>: A `Summary` protocol buffer, optionally serialized as a string. -* <b>`global_step`</b>: Number. Optional global step value to record with the - summary. - - -- - - - -#### `tf.train.SummaryWriter.close()` {#SummaryWriter.close} - -Flushes the event file to disk and close the file. - -Call this method when you do not need the summary writer anymore. - - -- - - - -#### `tf.train.SummaryWriter.flush()` {#SummaryWriter.flush} - -Flushes the event file to disk. - -Call this method to make sure that all pending events have been written to -disk. - - -- - - - -#### `tf.train.SummaryWriter.get_logdir()` {#SummaryWriter.get_logdir} - -Returns the directory where event file will be written. - - -- - - - -#### `tf.train.SummaryWriter.reopen()` {#SummaryWriter.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. - - diff --git a/tensorflow/g3doc/api_docs/python/index.md b/tensorflow/g3doc/api_docs/python/index.md index 85260bd046..347df33aa0 100644 --- a/tensorflow/g3doc/api_docs/python/index.md +++ b/tensorflow/g3doc/api_docs/python/index.md @@ -674,8 +674,6 @@ * [`StopAtStepHook`](../../api_docs/python/train.md#StopAtStepHook) * [`summary_iterator`](../../api_docs/python/train.md#summary_iterator) * [`SummarySaverHook`](../../api_docs/python/train.md#SummarySaverHook) - * [`SummaryWriter`](../../api_docs/python/train.md#SummaryWriter) - * [`SummaryWriterCache`](../../api_docs/python/train.md#SummaryWriterCache) * [`Supervisor`](../../api_docs/python/train.md#Supervisor) * [`SyncReplicasOptimizer`](../../api_docs/python/train.md#SyncReplicasOptimizer) * [`SyncReplicasOptimizerV2`](../../api_docs/python/train.md#SyncReplicasOptimizerV2) @@ -1016,6 +1014,7 @@ * [`StepCounter`](../../api_docs/python/contrib.learn.monitors.md#StepCounter) * [`StopAtStep`](../../api_docs/python/contrib.learn.monitors.md#StopAtStep) * [`SummarySaver`](../../api_docs/python/contrib.learn.monitors.md#SummarySaver) + * [`SummaryWriterCache`](../../api_docs/python/contrib.learn.monitors.md#SummaryWriterCache) * [`ValidationMonitor`](../../api_docs/python/contrib.learn.monitors.md#ValidationMonitor) * **[Linear Algebra (contrib)](../../api_docs/python/contrib.linalg.md)**: diff --git a/tensorflow/g3doc/api_docs/python/train.md b/tensorflow/g3doc/api_docs/python/train.md index 8e3fc525fd..eb103416b6 100644 --- a/tensorflow/g3doc/api_docs/python/train.md +++ b/tensorflow/g3doc/api_docs/python/train.md @@ -4114,7 +4114,7 @@ Merges all summaries collected in the default graph. -## Adding Summaries to Event Files +## Reading Summaries from Event Files See [Summaries and TensorBoard](../../how_tos/summaries_and_tensorboard/index.md) for an @@ -4122,249 +4122,6 @@ overview of summaries, event files, and visualization in TensorBoard. - - - -### `class tf.train.SummaryWriter` {#SummaryWriter} - - -- - - - -#### `tf.train.SummaryWriter.__init__(*args, **kwargs)` {#SummaryWriter.__init__} - -Creates a `SummaryWriter` and an event file. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.FileWriter. The interface and behavior is the same; this is just a rename. - - This class is deprecated, and should be replaced with tf.summary.FileWriter. - - On construction the summary writer creates a new event file in `logdir`. - This event file will contain `Event` protocol buffers constructed when you - call one of the following functions: `add_summary()`, `add_session_log()`, - `add_event()`, or `add_graph()`. - - If you pass a `Graph` to the constructor it is added to - the event file. (This is equivalent to calling `add_graph()` later). - - TensorBoard will pick the graph from the file and display it graphically so - you can interactively explore the graph you built. You will usually pass - the graph from the session in which you launched it: - - ```python - ...create a graph... - # Launch the graph in a session. - sess = tf.Session() - # Create a summary writer, add the 'graph' to the event file. - writer = tf.summary.FileWriter(<some-directory>, sess.graph) - ``` - - The other arguments to the constructor control the asynchronous writes to - the event file: - - * `flush_secs`: How often, in seconds, to flush the added summaries - and events to disk. - * `max_queue`: Maximum number of summaries or events pending to be - written to disk before one of the 'add' calls block. - - 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. - - -- - - - -#### `tf.train.SummaryWriter.add_event(event)` {#SummaryWriter.add_event} - -Adds an event to the event file. - -##### Args: - - -* <b>`event`</b>: An `Event` protocol buffer. - - -- - - - -#### `tf.train.SummaryWriter.add_graph(graph, global_step=None, graph_def=None)` {#SummaryWriter.add_graph} - -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. - -##### Args: - - -* <b>`graph`</b>: A `Graph` object, such as `sess.graph`. -* <b>`global_step`</b>: Number. Optional global step counter to record with the - graph. -* <b>`graph_def`</b>: DEPRECATED. Use the `graph` parameter instead. - -##### Raises: - - -* <b>`ValueError`</b>: If both graph and graph_def are passed to the method. - - -- - - - -#### `tf.train.SummaryWriter.add_meta_graph(meta_graph_def, global_step=None)` {#SummaryWriter.add_meta_graph} - -Adds a `MetaGraphDef` to the event file. - -The `MetaGraphDef` allows running the given graph via -`saver.import_meta_graph()`. - -##### Args: - - -* <b>`meta_graph_def`</b>: A `MetaGraphDef` object, often as retured by - `saver.export_meta_graph()`. -* <b>`global_step`</b>: Number. Optional global step counter to record with the - graph. - -##### Raises: - - -* <b>`TypeError`</b>: If both `meta_graph_def` is not an instance of `MetaGraphDef`. - - -- - - - -#### `tf.train.SummaryWriter.add_run_metadata(run_metadata, tag, global_step=None)` {#SummaryWriter.add_run_metadata} - -Adds a metadata information for a single session.run() call. - -##### Args: - - -* <b>`run_metadata`</b>: A `RunMetadata` protobuf object. -* <b>`tag`</b>: The tag name for this metadata. -* <b>`global_step`</b>: Number. Optional global step counter to record with the - StepStats. - -##### Raises: - - -* <b>`ValueError`</b>: If the provided tag was already used for this type of event. - - -- - - - -#### `tf.train.SummaryWriter.add_session_log(session_log, global_step=None)` {#SummaryWriter.add_session_log} - -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. - -##### Args: - - -* <b>`session_log`</b>: A `SessionLog` protocol buffer. -* <b>`global_step`</b>: Number. Optional global step value to record with the - summary. - - -- - - - -#### `tf.train.SummaryWriter.add_summary(summary, global_step=None)` {#SummaryWriter.add_summary} - -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 -[`Session.run()`](client.md#Session.run) or -[`Tensor.eval()`](framework.md#Tensor.eval), to this -function. Alternatively, you can pass a `tf.Summary` protocol -buffer that you populate with your own data. The latter is -commonly done to report evaluation results in event files. - -##### Args: - - -* <b>`summary`</b>: A `Summary` protocol buffer, optionally serialized as a string. -* <b>`global_step`</b>: Number. Optional global step value to record with the - summary. - - -- - - - -#### `tf.train.SummaryWriter.close()` {#SummaryWriter.close} - -Flushes the event file to disk and close the file. - -Call this method when you do not need the summary writer anymore. - - -- - - - -#### `tf.train.SummaryWriter.flush()` {#SummaryWriter.flush} - -Flushes the event file to disk. - -Call this method to make sure that all pending events have been written to -disk. - - -- - - - -#### `tf.train.SummaryWriter.get_logdir()` {#SummaryWriter.get_logdir} - -Returns the directory where event file will be written. - - -- - - - -#### `tf.train.SummaryWriter.reopen()` {#SummaryWriter.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. - - - -- - - - -### `class tf.train.SummaryWriterCache` {#SummaryWriterCache} - -Cache for file writers. - -This class caches file writers, one per directory. -- - - - -#### `tf.train.SummaryWriterCache.clear()` {#SummaryWriterCache.clear} - -Clear cached summary writers. Currently only used for unit tests. - - -- - - - -#### `tf.train.SummaryWriterCache.get(logdir)` {#SummaryWriterCache.get} - -Returns the FileWriter for the specified directory. - -##### Args: - - -* <b>`logdir`</b>: str, name of the directory. - -##### Returns: - - A `FileWriter`. - - - -- - - - ### `tf.train.summary_iterator(path)` {#summary_iterator} An iterator for reading `Event` protocol buffers from an event file. @@ -4409,7 +4166,7 @@ for more information about their attributes. -## Training utilities +## Training Utilities - - - |