diff options
| author |  A. Unique TensorFlower <gardener@tensorflow.org> | 2017-01-08 21:05:02 -0800 |
|---|---|---|
| committer | TensorFlower Gardener <gardener@tensorflow.org> | 2017-01-08 21:26:59 -0800 |
| commit | c5798b38bbfa1bbe6345e9019904f46a1c29f397 (patch) | |
| tree | 7506e04ea40f7c84fbc73197a2ef6af5d141443b | |
| parent | efd40e5b73a08525909cbee036df44205e839c0d (diff) | |
Update generated Python Op docs.
Change: 143924077
20 files changed, 1026 insertions, 1387 deletions
diff --git a/tensorflow/g3doc/api_docs/python/array_ops.md b/tensorflow/g3doc/api_docs/python/array_ops.md index 95acf84ca6..6aa23eed06 100644 --- a/tensorflow/g3doc/api_docs/python/array_ops.md +++ b/tensorflow/g3doc/api_docs/python/array_ops.md @@ -2209,7 +2209,7 @@ The attr `block_size` indicates the input block size and how the data is moved. * Chunks of data of size `block_size * block_size` from depth are rearranged into non-overlapping blocks of size `block_size x block_size` - * The width the output tensor is `input_width * block_size`, whereas the + * The width the output tensor is `input_depth * block_size`, whereas the height is `input_height * block_size`. * The depth of the input tensor must be divisible by `block_size * block_size`. diff --git a/tensorflow/g3doc/api_docs/python/contrib.rnn.md b/tensorflow/g3doc/api_docs/python/contrib.rnn.md index 557049da59..1ad18ddb10 100644 --- a/tensorflow/g3doc/api_docs/python/contrib.rnn.md +++ b/tensorflow/g3doc/api_docs/python/contrib.rnn.md @@ -31,7 +31,7 @@ LSTM (Long Short Term Memory) or GRU (Gated Recurrent Unit), and a number of operators that allow add dropouts, projections, or embeddings for inputs. Constructing multi-layer cells is supported by the class `MultiRNNCell`, or by calling the `rnn` ops several times. Every `RNNCell` must have the -properties below and and implement `__call__` with the following signature. +properties below and implement `__call__` with the following signature. - - - #### `tf.contrib.rnn.RNNCell.__call__(inputs, state, scope=None)` {#RNNCell.__call__} diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.depth_to_space.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.depth_to_space.md index ef74b4d54a..03dc6bb3b0 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.depth_to_space.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.depth_to_space.md @@ -10,7 +10,7 @@ The attr `block_size` indicates the input block size and how the data is moved. * Chunks of data of size `block_size * block_size` from depth are rearranged into non-overlapping blocks of size `block_size x block_size` - * The width the output tensor is `input_width * block_size`, whereas the + * The width the output tensor is `input_depth * block_size`, whereas the height is `input_height * block_size`. * The depth of the input tensor must be divisible by `block_size * block_size`. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.TaggedRunMetadata.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.TaggedRunMetadata.md index 8dc62c4c18..788d2066ad 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.TaggedRunMetadata.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.TaggedRunMetadata.md @@ -1,252 +1,8 @@ - - - -#### `tf.summary.TaggedRunMetadata.ByteSize()` {#TaggedRunMetadata.ByteSize} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.Clear()` {#TaggedRunMetadata.Clear} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.ClearExtension(extension_handle)` {#TaggedRunMetadata.ClearExtension} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.ClearField(field_name)` {#TaggedRunMetadata.ClearField} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.CopyFrom(other_msg)` {#TaggedRunMetadata.CopyFrom} - -Copies the content of the specified message into the current message. - -The method clears the current message and then merges the specified -message using MergeFrom. - -##### Args: - - -* <b>`other_msg`</b>: Message to copy into the current one. - - -- - - - -#### `tf.summary.TaggedRunMetadata.DiscardUnknownFields()` {#TaggedRunMetadata.DiscardUnknownFields} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.FindInitializationErrors()` {#TaggedRunMetadata.FindInitializationErrors} - -Finds required fields which are not initialized. - -##### Returns: - - A list of strings. Each string is a path to an uninitialized field from - the top-level message, e.g. "foo.bar[5].baz". - - -- - - - -#### `tf.summary.TaggedRunMetadata.FromString(s)` {#TaggedRunMetadata.FromString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.HasExtension(extension_handle)` {#TaggedRunMetadata.HasExtension} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.HasField(field_name)` {#TaggedRunMetadata.HasField} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.IsInitialized(errors=None)` {#TaggedRunMetadata.IsInitialized} - -Checks if all required fields of a message are set. - -##### Args: - - -* <b>`errors`</b>: A list which, if provided, will be populated with the field - paths of all missing required fields. - -##### Returns: - - True iff the specified message has all required fields set. - - -- - - - -#### `tf.summary.TaggedRunMetadata.ListFields()` {#TaggedRunMetadata.ListFields} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.MergeFrom(msg)` {#TaggedRunMetadata.MergeFrom} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.MergeFromString(serialized)` {#TaggedRunMetadata.MergeFromString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.ParseFromString(serialized)` {#TaggedRunMetadata.ParseFromString} - -Parse serialized protocol buffer data into this message. - -Like MergeFromString(), except we clear the object first and -do not return the value that MergeFromString returns. - - -- - - - -#### `tf.summary.TaggedRunMetadata.RegisterExtension(extension_handle)` {#TaggedRunMetadata.RegisterExtension} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.SerializePartialToString()` {#TaggedRunMetadata.SerializePartialToString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.SerializeToString()` {#TaggedRunMetadata.SerializeToString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.SetInParent()` {#TaggedRunMetadata.SetInParent} - -Sets the _cached_byte_size_dirty bit to true, -and propagates this to our listener iff this was a state change. - - -- - - - -#### `tf.summary.TaggedRunMetadata.WhichOneof(oneof_name)` {#TaggedRunMetadata.WhichOneof} - -Returns the name of the currently set field inside a oneof, or None. - - -- - - - -#### `tf.summary.TaggedRunMetadata.__deepcopy__(memo=None)` {#TaggedRunMetadata.__deepcopy__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__eq__(other)` {#TaggedRunMetadata.__eq__} - - - - -- - - - #### `tf.summary.TaggedRunMetadata.__getstate__()` {#TaggedRunMetadata.__getstate__} Support the pickle protocol. -- - - - -#### `tf.summary.TaggedRunMetadata.__hash__()` {#TaggedRunMetadata.__hash__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__init__(**kwargs)` {#TaggedRunMetadata.__init__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__ne__(other_msg)` {#TaggedRunMetadata.__ne__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__repr__()` {#TaggedRunMetadata.__repr__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__setstate__(state)` {#TaggedRunMetadata.__setstate__} - -Support the pickle protocol. - - -- - - - -#### `tf.summary.TaggedRunMetadata.__str__()` {#TaggedRunMetadata.__str__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__unicode__()` {#TaggedRunMetadata.__unicode__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.run_metadata` {#TaggedRunMetadata.run_metadata} - -Magic attribute generated for "run_metadata" proto field. - - -- - - - -#### `tf.summary.TaggedRunMetadata.tag` {#TaggedRunMetadata.tag} - -Magic attribute generated for "tag" proto field. - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md deleted file mode 100644 index bf17320a5a..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md +++ /dev/null @@ -1,17 +0,0 @@ -### `tf.merge_all_summaries(*args, **kwargs)` {#merge_all_summaries} - -Merges all summaries collected in the default graph. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.merge_all. - - Args: - key: `GraphKey` used to collect the summaries. Defaults to - `GraphKeys.SUMMARIES`. - - Returns: - If no summaries were collected, returns None. Otherwise returns a scalar - `Tensor` of type `string` containing the serialized `Summary` protocol - buffer resulting from the merging. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md deleted file mode 100644 index 6220d3641b..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md +++ /dev/null @@ -1,49 +0,0 @@ -### `tf.image_summary(*args, **kwargs)` {#image_summary} - -Outputs a `Summary` protocol buffer with images. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.image. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. Also, the max_images argument was renamed to max_outputs. - - The summary has up to `max_images` summary values containing images. The - images are built from `tensor` which must be 4-D with shape `[batch_size, - height, width, channels]` and where `channels` can be: - - * 1: `tensor` is interpreted as Grayscale. - * 3: `tensor` is interpreted as RGB. - * 4: `tensor` is interpreted as RGBA. - - The images have the same number of channels as the input tensor. For float - input, the values are normalized one image at a time to fit in the range - `[0, 255]`. `uint8` values are unchanged. The op uses two different - normalization algorithms: - - * If the input values are all positive, they are rescaled so the largest one - is 255. - - * If any input value is negative, the values are shifted so input value 0.0 - is at 127. They are then rescaled so that either the smallest value is 0, - or the largest one is 255. - - The `tag` argument is a scalar `Tensor` of type `string`. It is used to - build the `tag` of the summary values: - - * If `max_images` is 1, the summary value tag is '*tag*/image'. - * If `max_images` is greater than 1, the summary value tags are - generated sequentially as '*tag*/image/0', '*tag*/image/1', etc. - - Args: - tag: A scalar `Tensor` of type `string`. Used to build the `tag` - of the summary values. - tensor: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height, - width, channels]` where `channels` is 1, 3, or 4. - max_images: Max number of batch elements to generate images for. - collections: Optional list of ops.GraphKeys. The collections to add the - summary to. Defaults to [ops.GraphKeys.SUMMARIES] - name: A name for the operation (optional). - - Returns: - A scalar `Tensor` of type `string`. The serialized `Summary` protocol - buffer. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.SummaryDescription.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.SummaryDescription.md index bce704ef4f..19532f7cc3 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.SummaryDescription.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.SummaryDescription.md @@ -1,245 +1,8 @@ - - - -#### `tf.summary.SummaryDescription.ByteSize()` {#SummaryDescription.ByteSize} - - - - -- - - - -#### `tf.summary.SummaryDescription.Clear()` {#SummaryDescription.Clear} - - - - -- - - - -#### `tf.summary.SummaryDescription.ClearExtension(extension_handle)` {#SummaryDescription.ClearExtension} - - - - -- - - - -#### `tf.summary.SummaryDescription.ClearField(field_name)` {#SummaryDescription.ClearField} - - - - -- - - - -#### `tf.summary.SummaryDescription.CopyFrom(other_msg)` {#SummaryDescription.CopyFrom} - -Copies the content of the specified message into the current message. - -The method clears the current message and then merges the specified -message using MergeFrom. - -##### Args: - - -* <b>`other_msg`</b>: Message to copy into the current one. - - -- - - - -#### `tf.summary.SummaryDescription.DiscardUnknownFields()` {#SummaryDescription.DiscardUnknownFields} - - - - -- - - - -#### `tf.summary.SummaryDescription.FindInitializationErrors()` {#SummaryDescription.FindInitializationErrors} - -Finds required fields which are not initialized. - -##### Returns: - - A list of strings. Each string is a path to an uninitialized field from - the top-level message, e.g. "foo.bar[5].baz". - - -- - - - -#### `tf.summary.SummaryDescription.FromString(s)` {#SummaryDescription.FromString} - - - - -- - - - -#### `tf.summary.SummaryDescription.HasExtension(extension_handle)` {#SummaryDescription.HasExtension} - - - - -- - - - -#### `tf.summary.SummaryDescription.HasField(field_name)` {#SummaryDescription.HasField} - - - - -- - - - -#### `tf.summary.SummaryDescription.IsInitialized(errors=None)` {#SummaryDescription.IsInitialized} - -Checks if all required fields of a message are set. - -##### Args: - - -* <b>`errors`</b>: A list which, if provided, will be populated with the field - paths of all missing required fields. - -##### Returns: - - True iff the specified message has all required fields set. - - -- - - - -#### `tf.summary.SummaryDescription.ListFields()` {#SummaryDescription.ListFields} - - - - -- - - - -#### `tf.summary.SummaryDescription.MergeFrom(msg)` {#SummaryDescription.MergeFrom} - - - - -- - - - -#### `tf.summary.SummaryDescription.MergeFromString(serialized)` {#SummaryDescription.MergeFromString} - - - - -- - - - -#### `tf.summary.SummaryDescription.ParseFromString(serialized)` {#SummaryDescription.ParseFromString} - -Parse serialized protocol buffer data into this message. - -Like MergeFromString(), except we clear the object first and -do not return the value that MergeFromString returns. - - -- - - - -#### `tf.summary.SummaryDescription.RegisterExtension(extension_handle)` {#SummaryDescription.RegisterExtension} - - - - -- - - - -#### `tf.summary.SummaryDescription.SerializePartialToString()` {#SummaryDescription.SerializePartialToString} - - - - -- - - - -#### `tf.summary.SummaryDescription.SerializeToString()` {#SummaryDescription.SerializeToString} - - - - -- - - - -#### `tf.summary.SummaryDescription.SetInParent()` {#SummaryDescription.SetInParent} - -Sets the _cached_byte_size_dirty bit to true, -and propagates this to our listener iff this was a state change. - - -- - - - -#### `tf.summary.SummaryDescription.WhichOneof(oneof_name)` {#SummaryDescription.WhichOneof} - -Returns the name of the currently set field inside a oneof, or None. - - -- - - - -#### `tf.summary.SummaryDescription.__deepcopy__(memo=None)` {#SummaryDescription.__deepcopy__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__eq__(other)` {#SummaryDescription.__eq__} - - - - -- - - - #### `tf.summary.SummaryDescription.__getstate__()` {#SummaryDescription.__getstate__} Support the pickle protocol. -- - - - -#### `tf.summary.SummaryDescription.__hash__()` {#SummaryDescription.__hash__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__init__(**kwargs)` {#SummaryDescription.__init__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__ne__(other_msg)` {#SummaryDescription.__ne__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__repr__()` {#SummaryDescription.__repr__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__setstate__(state)` {#SummaryDescription.__setstate__} - -Support the pickle protocol. - - -- - - - -#### `tf.summary.SummaryDescription.__str__()` {#SummaryDescription.__str__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__unicode__()` {#SummaryDescription.__unicode__} - - - - -- - - - -#### `tf.summary.SummaryDescription.type_hint` {#SummaryDescription.type_hint} - -Magic attribute generated for "type_hint" proto field. - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.test.TestCase.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.test.TestCase.md index ec995fd99c..6dba0e4f1e 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.test.TestCase.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.test.TestCase.md @@ -175,6 +175,125 @@ Checks that for all elements of farray1 and farray2 - - - +#### `tf.test.TestCase.assertBetween(value, minv, maxv, msg=None)` {#TestCase.assertBetween} + +Asserts that value is between minv and maxv (inclusive). + + +- - - + +#### `tf.test.TestCase.assertCommandFails(command, regexes, env=None, close_fds=True, msg=None)` {#TestCase.assertCommandFails} + +Asserts a shell command fails and the error matches a regex in a list. + +##### Args: + + +* <b>`command`</b>: List or string representing the command to run. +* <b>`regexes`</b>: the list of regular expression strings. +* <b>`env`</b>: Dictionary of environment variable settings. +* <b>`close_fds`</b>: Whether or not to close all open fd's in the child after + forking. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertCommandSucceeds(command, regexes=('',), env=None, close_fds=True, msg=None)` {#TestCase.assertCommandSucceeds} + +Asserts that a shell command succeeds (i.e. exits with code 0). + +##### Args: + + +* <b>`command`</b>: List or string representing the command to run. +* <b>`regexes`</b>: List of regular expression byte strings that match success. +* <b>`env`</b>: Dictionary of environment variable settings. +* <b>`close_fds`</b>: Whether or not to close all open fd's in the child after + forking. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsExactSubsequence(container, subsequence, msg=None)` {#TestCase.assertContainsExactSubsequence} + +Assert that "container" contains "subsequence" as an exact subsequence. + +Asserts that "container" contains all the elements of "subsequence", in +order, and without other elements interspersed. For example, [1, 2, 3] is an +exact subsequence of [0, 0, 1, 2, 3, 0] but not of [0, 0, 1, 2, 0, 3, 0]. + +##### Args: + + +* <b>`container`</b>: the list we're testing for subsequence inclusion. +* <b>`subsequence`</b>: the list we hope will be an exact subsequence of container. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsInOrder(strings, target, msg=None)` {#TestCase.assertContainsInOrder} + +Asserts that the strings provided are found in the target in order. + +This may be useful for checking HTML output. + +##### Args: + + +* <b>`strings`</b>: A list of strings, such as [ 'fox', 'dog' ] +* <b>`target`</b>: A target string in which to look for the strings, such as + 'The quick brown fox jumped over the lazy dog'. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsSubsequence(container, subsequence, msg=None)` {#TestCase.assertContainsSubsequence} + +Assert that "container" contains "subsequence" as a subsequence. + +Asserts that "container" contains all the elements of "subsequence", in +order, but possibly with other elements interspersed. For example, [1, 2, 3] +is a subsequence of [0, 0, 1, 2, 0, 3, 0] but not of [0, 0, 1, 3, 0, 2, 0]. + +##### Args: + + +* <b>`container`</b>: the list we're testing for subsequence inclusion. +* <b>`subsequence`</b>: the list we hope will be a subsequence of container. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsSubset(expected_subset, actual_set, msg=None)` {#TestCase.assertContainsSubset} + +Checks whether actual iterable is a superset of expected iterable. + + +- - - + +#### `tf.test.TestCase.assertCountEqual(*args, **kwargs)` {#TestCase.assertCountEqual} + +An unordered sequence specific comparison. + +Equivalent to assertItemsEqual(). This method is a compatibility layer +for Python 3k, since 2to3 does not convert assertItemsEqual() calls into +assertCountEqual() calls. + +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`msg`</b>: The message to be printed if the test fails. + + +- - - + #### `tf.test.TestCase.assertDeviceEqual(device1, device2)` {#TestCase.assertDeviceEqual} Asserts that the two given devices are the same. @@ -195,10 +314,49 @@ Checks whether actual is a superset of expected. - - - -#### `tf.test.TestCase.assertDictEqual(d1, d2, msg=None)` {#TestCase.assertDictEqual} +#### `tf.test.TestCase.assertDictEqual(a, b, msg=None)` {#TestCase.assertDictEqual} +Raises AssertionError if a and b are not equal dictionaries. + +##### Args: + + +* <b>`a`</b>: A dict, the expected value. +* <b>`b`</b>: A dict, the actual value. +* <b>`msg`</b>: An optional str, the associated message. + +##### Raises: + + +* <b>`AssertionError`</b>: if the dictionaries are not equal. + + +- - - + +#### `tf.test.TestCase.assertEmpty(container, msg=None)` {#TestCase.assertEmpty} + +Assert that an object has zero length. + +##### Args: + + +* <b>`container`</b>: Anything that implements the collections.Sized interface. +* <b>`msg`</b>: Optional message to report on failure. +- - - + +#### `tf.test.TestCase.assertEndsWith(actual, expected_end, msg=None)` {#TestCase.assertEndsWith} + +Assert that actual.endswith(expected_end) is True. + +##### Args: + + +* <b>`actual`</b>: str +* <b>`expected_end`</b>: str +* <b>`msg`</b>: Optional message to report on failure. + - - - @@ -282,10 +440,11 @@ Included for symmetry with assertIsNone. - - - -#### `tf.test.TestCase.assertItemsEqual(expected_seq, actual_seq, msg=None)` {#TestCase.assertItemsEqual} +#### `tf.test.TestCase.assertItemsEqual(*args, **kwargs)` {#TestCase.assertItemsEqual} + +An unordered sequence specific comparison. -An unordered sequence specific comparison. It asserts that -actual_seq and expected_seq have the same element counts. +It asserts that actual_seq and expected_seq have the same element counts. Equivalent to:: self.assertEqual(Counter(iter(actual_seq)), @@ -298,6 +457,30 @@ Asserts that each element has the same count in both sequences. - [0, 1, 1] and [1, 0, 1] compare equal. - [0, 0, 1] and [0, 1] compare unequal. +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`msg`</b>: The message to be printed if the test fails. + + +- - - + +#### `tf.test.TestCase.assertJsonEqual(first, second, msg=None)` {#TestCase.assertJsonEqual} + +Asserts that the JSON objects defined in two strings are equal. + +A summary of the differences will be included in the failure message +using assertSameStructure. + +##### Args: + + +* <b>`first`</b>: A string contining JSON to decode and compare to second. +* <b>`second`</b>: A string contining JSON to decode and compare to first. +* <b>`msg`</b>: Additional text to include in the failure message. + - - - @@ -369,6 +552,13 @@ if not. - - - +#### `tf.test.TestCase.assertNoCommonElements(expected_seq, actual_seq, msg=None)` {#TestCase.assertNoCommonElements} + +Checks whether actual iterable and expected iterable are disjoint. + + +- - - + #### `tf.test.TestCase.assertNotAlmostEqual(first, second, places=None, msg=None, delta=None)` {#TestCase.assertNotAlmostEqual} Fail if the two objects are equal as determined by their @@ -399,6 +589,33 @@ Objects that are equal automatically fail. - - - +#### `tf.test.TestCase.assertNotEmpty(container, msg=None)` {#TestCase.assertNotEmpty} + +Assert that an object has non-zero length. + +##### Args: + + +* <b>`container`</b>: Anything that implements the collections.Sized interface. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertNotEndsWith(actual, unexpected_end, msg=None)` {#TestCase.assertNotEndsWith} + +Assert that actual.endswith(unexpected_end) is False. + +##### Args: + + +* <b>`actual`</b>: str +* <b>`unexpected_end`</b>: str +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + #### `tf.test.TestCase.assertNotEqual(first, second, msg=None)` {#TestCase.assertNotEqual} Fail if the two objects are equal as determined by the '!=' @@ -436,6 +653,20 @@ Fail the test if the text matches the regular expression. - - - +#### `tf.test.TestCase.assertNotStartsWith(actual, unexpected_start, msg=None)` {#TestCase.assertNotStartsWith} + +Assert that actual.startswith(unexpected_start) is False. + +##### Args: + + +* <b>`actual`</b>: str +* <b>`unexpected_start`</b>: str +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + #### `tf.test.TestCase.assertProtoEquals(expected_message_maybe_ascii, message)` {#TestCase.assertProtoEquals} Asserts that message is same as parsed expected_message_ascii. @@ -510,6 +741,38 @@ Asserts that the message in a raised exception matches a regexp. - - - +#### `tf.test.TestCase.assertRaisesWithLiteralMatch(expected_exception, expected_exception_message, callable_obj=None, *args, **kwargs)` {#TestCase.assertRaisesWithLiteralMatch} + +Asserts that the message in a raised exception equals the given string. + +Unlike assertRaisesRegexp, this method takes a literal string, not +a regular expression. + +with self.assertRaisesWithLiteralMatch(ExType, 'message'): + DoSomething() + +##### Args: + + +* <b>`expected_exception`</b>: Exception class expected to be raised. +* <b>`expected_exception_message`</b>: String message expected in the raised + exception. For a raise exception e, expected_exception_message must + equal str(e). +* <b>`callable_obj`</b>: Function to be called, or None to return a context. +* <b>`args`</b>: Extra args. +* <b>`kwargs`</b>: Extra kwargs. + +##### Returns: + + A context manager if callable_obj is None. Otherwise, None. + +##### Raises: + + self.failureException if callable_obj does not raise a macthing exception. + + +- - - + #### `tf.test.TestCase.assertRaisesWithPredicateMatch(exception_type, expected_err_re_or_predicate)` {#TestCase.assertRaisesWithPredicateMatch} Returns a context manager to enclose code expected to raise an exception. @@ -534,6 +797,71 @@ predicate search. - - - +#### `tf.test.TestCase.assertRaisesWithRegexpMatch(expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)` {#TestCase.assertRaisesWithRegexpMatch} + +Asserts that the message in a raised exception matches the given regexp. + +This is just a wrapper around assertRaisesRegexp. Please use +assertRaisesRegexp instead of assertRaisesWithRegexpMatch. + +##### Args: + + +* <b>`expected_exception`</b>: Exception class expected to be raised. +* <b>`expected_regexp`</b>: Regexp (re pattern object or string) expected to be + found in error message. +* <b>`callable_obj`</b>: Function to be called, or None to return a context. +* <b>`args`</b>: Extra args. +* <b>`kwargs`</b>: Extra keyword args. + +##### Returns: + + A context manager if callable_obj is None. Otherwise, None. + +##### Raises: + + self.failureException if callable_obj does not raise a macthing exception. + + +- - - + +#### `tf.test.TestCase.assertRegexMatch(actual_str, regexes, message=None)` {#TestCase.assertRegexMatch} + +Asserts that at least one regex in regexes matches str. + + If possible you should use assertRegexpMatches, which is a simpler + version of this method. assertRegexpMatches takes a single regular + expression (a string or re compiled object) instead of a list. + + Notes: + 1. This function uses substring matching, i.e. the matching + succeeds if *any* substring of the error message matches *any* + regex in the list. This is more convenient for the user than + full-string matching. + + 2. If regexes is the empty list, the matching will always fail. + + 3. Use regexes=[''] for a regex that will always pass. + + 4. '.' matches any single character *except* the newline. To + match any character, use '(.| +)'. + + 5. '^' matches the beginning of each line, not just the beginning + of the string. Similarly, '$' matches the end of each line. + + 6. An exception will be thrown if regexes contains an invalid + regex. + + Args: + actual_str: The string we try to match with the items in regexes. + regexes: The regular expressions we want to match against str. + See "Notes" above for detailed notes on how this is interpreted. + message: The message to be printed if the test fails. + + +- - - + #### `tf.test.TestCase.assertRegexpMatches(text, expected_regexp, msg=None)` {#TestCase.assertRegexpMatches} Fail the test unless the text matches the regular expression. @@ -541,6 +869,79 @@ Fail the test unless the text matches the regular expression. - - - +#### `tf.test.TestCase.assertSameElements(expected_seq, actual_seq, msg=None)` {#TestCase.assertSameElements} + +Assert that two sequences have the same elements (in any order). + +This method, unlike assertItemsEqual, doesn't care about any +duplicates in the expected and actual sequences. + + >> assertSameElements([1, 1, 1, 0, 0, 0], [0, 1]) + # Doesn't raise an AssertionError + +If possible, you should use assertItemsEqual instead of +assertSameElements. + +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`msg`</b>: The message to be printed if the test fails. + + +- - - + +#### `tf.test.TestCase.assertSameStructure(a, b, aname='a', bname='b', msg=None)` {#TestCase.assertSameStructure} + +Asserts that two values contain the same structural content. + +The two arguments should be data trees consisting of trees of dicts and +lists. They will be deeply compared by walking into the contents of dicts +and lists; other items will be compared using the == operator. +If the two structures differ in content, the failure message will indicate +the location within the structures where the first difference is found. +This may be helpful when comparing large structures. + +##### Args: + + +* <b>`a`</b>: The first structure to compare. +* <b>`b`</b>: The second structure to compare. +* <b>`aname`</b>: Variable name to use for the first structure in assertion messages. +* <b>`bname`</b>: Variable name to use for the second structure. +* <b>`msg`</b>: Additional text to include in the failure message. + + +- - - + +#### `tf.test.TestCase.assertSequenceAlmostEqual(expected_seq, actual_seq, places=None, msg=None, delta=None)` {#TestCase.assertSequenceAlmostEqual} + +An approximate equality assertion for ordered sequences. + +Fail if the two sequences are unequal as determined by their value +differences rounded to the given number of decimal places (default 7) and +comparing to zero, or by comparing that the difference between each value +in the two sequences is more than the given delta. + +Note that decimal places (from zero) are usually not the same as significant +digits (measured from the most signficant digit). + +If the two sequences compare equal then they will automatically compare +almost equal. + +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`places`</b>: The number of decimal places to compare. +* <b>`msg`</b>: The message to be printed if the test fails. +* <b>`delta`</b>: The OK difference between compared values. + + +- - - + #### `tf.test.TestCase.assertSequenceEqual(seq1, seq2, msg=None, seq_type=None)` {#TestCase.assertSequenceEqual} An equality assertion for ordered sequences (like lists and tuples). @@ -561,6 +962,26 @@ which can be indexed, has a length, and has an equality operator. - - - +#### `tf.test.TestCase.assertSequenceStartsWith(prefix, whole, msg=None)` {#TestCase.assertSequenceStartsWith} + +An equality assertion for the beginning of ordered sequences. + +If prefix is an empty sequence, it will raise an error unless whole is also +an empty sequence. + +If prefix is not a sequence, it will raise an error if the first element of +whole does not match. + +##### Args: + + +* <b>`prefix`</b>: A sequence expected at the beginning of the whole parameter. +* <b>`whole`</b>: The sequence in which to look for prefix. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + #### `tf.test.TestCase.assertSetEqual(set1, set2, msg=None)` {#TestCase.assertSetEqual} A set-specific equality assertion. @@ -612,6 +1033,51 @@ Assert that actual.startswith(expected_start) is True. - - - +#### `tf.test.TestCase.assertTotallyOrdered(*groups, **kwargs)` {#TestCase.assertTotallyOrdered} + +Asserts that total ordering has been implemented correctly. + +For example, say you have a class A that compares only on its attribute x. +Comparators other than __lt__ are omitted for brevity. + +class A(object): + def __init__(self, x, y): + self.x = x + self.y = y + + def __hash__(self): + return hash(self.x) + + def __lt__(self, other): + try: + return self.x < other.x + except AttributeError: + return NotImplemented + +assertTotallyOrdered will check that instances can be ordered correctly. +For example, + +self.assertTotallyOrdered( + [None], # None should come before everything else. + [1], # Integers sort earlier. + [A(1, 'a')], + [A(2, 'b')], # 2 is after 1. + [A(3, 'c'), A(3, 'd')], # The second argument is irrelevant. + [A(4, 'z')], + ['foo']) # Strings sort last. + +##### Args: + + +* <b>`*groups`</b>: A list of groups of elements. Each group of elements is a list + of objects that are equal. The elements in each group must be less than + the elements in the group after it. For example, these groups are + totally ordered: [None], [1], [2, 2], [3]. +* <b>`**kwargs`</b>: optional msg keyword argument can be passed. + + +- - - + #### `tf.test.TestCase.assertTrue(expr, msg=None)` {#TestCase.assertTrue} Check that the expression is true. @@ -634,6 +1100,13 @@ A tuple-specific equality assertion. - - - +#### `tf.test.TestCase.assertUrlEqual(a, b, msg=None)` {#TestCase.assertUrlEqual} + +Asserts that urls are equal, ignoring ordering of query params. + + +- - - + #### `tf.test.TestCase.assert_(expr, msg=None)` {#TestCase.assert_} Check that the expression is true. @@ -693,9 +1166,9 @@ tearDown. - - - -#### `tf.test.TestCase.fail(msg=None)` {#TestCase.fail} +#### `tf.test.TestCase.fail(msg=None, prefix=None)` {#TestCase.fail} -Fail immediately, with the given message. +Fail immediately with the given message, optionally prefixed. - - - @@ -749,6 +1222,13 @@ Fail immediately, with the given message. - - - +#### `tf.test.TestCase.getRecordedProperties()` {#TestCase.getRecordedProperties} + +Return any properties that the user has recorded. + + +- - - + #### `tf.test.TestCase.get_temp_dir()` {#TestCase.get_temp_dir} Returns a unique temporary directory for the test to use. @@ -771,6 +1251,20 @@ pollute each others environment. - - - +#### `tf.test.TestCase.recordProperty(property_name, property_value)` {#TestCase.recordProperty} + +Record an arbitrary property for later use. + +##### Args: + + +* <b>`property_name`</b>: str, name of property to record; must be a valid XML + attribute name +* <b>`property_value`</b>: value of property; must be valid XML attribute value + + +- - - + #### `tf.test.TestCase.run(result=None)` {#TestCase.run} @@ -794,11 +1288,18 @@ Hook method for setting up class fixture before running tests in the class. #### `tf.test.TestCase.shortDescription()` {#TestCase.shortDescription} -Returns a one-line description of the test, or None if no -description has been provided. +Format both the test method name and the first line of its docstring. + +If no docstring is given, only returns the method name. + +This method overrides unittest.TestCase.shortDescription(), which +only returns the first line of the docstring, obscuring the name +of the test upon failure. + +##### Returns: + -The default implementation of this method returns the first line of -the specified test method's docstring. +* <b>`desc`</b>: A short description of a test method. - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md deleted file mode 100644 index 3ffd9260c7..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md +++ /dev/null @@ -1,22 +0,0 @@ -### `tf.scalar_summary(*args, **kwargs)` {#scalar_summary} - -Outputs a `Summary` protocol buffer with scalar values. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.scalar. Note that tf.summary.scalar uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. Also, passing a tensor or list of tags to a scalar summary op is no longer supported. - - The input `tags` and `values` must have the same shape. The generated - summary has a summary value for each tag-value pair in `tags` and `values`. - - Args: - tags: A `string` `Tensor`. Tags for the summaries. - values: A real numeric Tensor. Values for the summaries. - collections: Optional list of graph collections keys. The new summary op is - added to these collections. Defaults to `[GraphKeys.SUMMARIES]`. - name: A name for the operation (optional). - - Returns: - A scalar `Tensor` of type `string`. The serialized `Summary` protocol - buffer. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.summary.SummaryDescription.RegisterExtension.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.summary.SummaryDescription.RegisterExtension.md deleted file mode 100644 index 3cfd7103d7..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.summary.SummaryDescription.RegisterExtension.md +++ /dev/null @@ -1,4 +0,0 @@ -#### `tf.summary.SummaryDescription.RegisterExtension(extension_handle)` {#SummaryDescription.RegisterExtension} - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.contrib.rnn.RNNCell.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.contrib.rnn.RNNCell.md index 55a1610681..fa2d4f17d0 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.contrib.rnn.RNNCell.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.contrib.rnn.RNNCell.md @@ -18,7 +18,7 @@ LSTM (Long Short Term Memory) or GRU (Gated Recurrent Unit), and a number of operators that allow add dropouts, projections, or embeddings for inputs. Constructing multi-layer cells is supported by the class `MultiRNNCell`, or by calling the `rnn` ops several times. Every `RNNCell` must have the -properties below and and implement `__call__` with the following signature. +properties below and implement `__call__` with the following signature. - - - #### `tf.contrib.rnn.RNNCell.__call__(inputs, state, scope=None)` {#RNNCell.__call__} diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md deleted file mode 100644 index 570d7b712c..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md +++ /dev/null @@ -1,26 +0,0 @@ -### `tf.histogram_summary(*args, **kwargs)` {#histogram_summary} - -Outputs a `Summary` protocol buffer with a histogram. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.histogram. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on their scope. - - The generated - [`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto) - has one summary value containing a histogram for `values`. - - This op reports an `InvalidArgument` error if any value is not finite. - - Args: - tag: A `string` `Tensor`. 0-D. Tag to use for the summary value. - values: A real numeric `Tensor`. Any shape. Values to use to - build the histogram. - collections: Optional list of graph collections keys. The new summary op is - added to these collections. Defaults to `[GraphKeys.SUMMARIES]`. - name: A name for the operation (optional). - - Returns: - A scalar `Tensor` of type `string`. The serialized `Summary` protocol - buffer. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md deleted file mode 100644 index ccb984f5ab..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md +++ /dev/null @@ -1,27 +0,0 @@ -### `tf.merge_summary(*args, **kwargs)` {#merge_summary} - -Merges summaries. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.merge. - - This op creates a - [`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto) - protocol buffer that contains the union of all the values in the input - summaries. - - When the Op is run, it reports an `InvalidArgument` error if multiple values - in the summaries to merge use the same tag. - - Args: - inputs: A list of `string` `Tensor` objects containing serialized `Summary` - protocol buffers. - collections: Optional list of graph collections keys. The new summary op is - added to these collections. Defaults to `[GraphKeys.SUMMARIES]`. - name: A name for the operation (optional). - - Returns: - A scalar `Tensor` of type `string`. The serialized `Summary` protocol - buffer resulting from the merging. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.summary.SummaryDescription.FromString.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.summary.SummaryDescription.FromString.md deleted file mode 100644 index 24a3b3f10c..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.summary.SummaryDescription.FromString.md +++ /dev/null @@ -1,4 +0,0 @@ -#### `tf.summary.SummaryDescription.FromString(s)` {#SummaryDescription.FromString} - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.TaggedRunMetadata.RegisterExtension.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.TaggedRunMetadata.RegisterExtension.md deleted file mode 100644 index f2d0c042d7..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.TaggedRunMetadata.RegisterExtension.md +++ /dev/null @@ -1,4 +0,0 @@ -#### `tf.summary.TaggedRunMetadata.RegisterExtension(extension_handle)` {#TaggedRunMetadata.RegisterExtension} - - - 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 e9bdda200f..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.train.SummaryWriter(<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/functions_and_classes/shard9/tf.audio_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md deleted file mode 100644 index c5830ab550..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md +++ /dev/null @@ -1,37 +0,0 @@ -### `tf.audio_summary(*args, **kwargs)` {#audio_summary} - -Outputs a `Summary` protocol buffer with audio. (deprecated) - -THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30. -Instructions for updating: -Please switch to tf.summary.audio. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. - - The summary has up to `max_outputs` summary values containing audio. The - audio is built from `tensor` which must be 3-D with shape `[batch_size, - frames, channels]` or 2-D with shape `[batch_size, frames]`. The values are - assumed to be in the range of `[-1.0, 1.0]` with a sample rate of - `sample_rate`. - - The `tag` argument is a scalar `Tensor` of type `string`. It is used to - build the `tag` of the summary values: - - * If `max_outputs` is 1, the summary value tag is '*tag*/audio'. - * If `max_outputs` is greater than 1, the summary value tags are - generated sequentially as '*tag*/audio/0', '*tag*/audio/1', etc. - - Args: - tag: A scalar `Tensor` of type `string`. Used to build the `tag` - of the summary values. - tensor: A 3-D `float32` `Tensor` of shape `[batch_size, frames, channels]` - or a 2-D `float32` `Tensor` of shape `[batch_size, frames]`. - sample_rate: A Scalar `float32` `Tensor` indicating the sample rate of the - signal in hertz. - max_outputs: Max number of batch elements to generate audio for. - collections: Optional list of ops.GraphKeys. The collections to add the - summary to. Defaults to [ops.GraphKeys.SUMMARIES] - name: A name for the operation (optional). - - Returns: - A scalar `Tensor` of type `string`. The serialized `Summary` protocol - buffer. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.summary.TaggedRunMetadata.FromString.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.summary.TaggedRunMetadata.FromString.md deleted file mode 100644 index 613f4ebd73..0000000000 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.summary.TaggedRunMetadata.FromString.md +++ /dev/null @@ -1,4 +0,0 @@ -#### `tf.summary.TaggedRunMetadata.FromString(s)` {#TaggedRunMetadata.FromString} - - - diff --git a/tensorflow/g3doc/api_docs/python/summary.md b/tensorflow/g3doc/api_docs/python/summary.md index be029f4290..8d344036db 100644 --- a/tensorflow/g3doc/api_docs/python/summary.md +++ b/tensorflow/g3doc/api_docs/python/summary.md @@ -487,248 +487,11 @@ metadata is stored in its NodeDef. This method retrieves the description. - - - -#### `tf.summary.SummaryDescription.ByteSize()` {#SummaryDescription.ByteSize} - - - - -- - - - -#### `tf.summary.SummaryDescription.Clear()` {#SummaryDescription.Clear} - - - - -- - - - -#### `tf.summary.SummaryDescription.ClearExtension(extension_handle)` {#SummaryDescription.ClearExtension} - - - - -- - - - -#### `tf.summary.SummaryDescription.ClearField(field_name)` {#SummaryDescription.ClearField} - - - - -- - - - -#### `tf.summary.SummaryDescription.CopyFrom(other_msg)` {#SummaryDescription.CopyFrom} - -Copies the content of the specified message into the current message. - -The method clears the current message and then merges the specified -message using MergeFrom. - -##### Args: - - -* <b>`other_msg`</b>: Message to copy into the current one. - - -- - - - -#### `tf.summary.SummaryDescription.DiscardUnknownFields()` {#SummaryDescription.DiscardUnknownFields} - - - - -- - - - -#### `tf.summary.SummaryDescription.FindInitializationErrors()` {#SummaryDescription.FindInitializationErrors} - -Finds required fields which are not initialized. - -##### Returns: - - A list of strings. Each string is a path to an uninitialized field from - the top-level message, e.g. "foo.bar[5].baz". - - -- - - - -#### `tf.summary.SummaryDescription.FromString(s)` {#SummaryDescription.FromString} - - - - -- - - - -#### `tf.summary.SummaryDescription.HasExtension(extension_handle)` {#SummaryDescription.HasExtension} - - - - -- - - - -#### `tf.summary.SummaryDescription.HasField(field_name)` {#SummaryDescription.HasField} - - - - -- - - - -#### `tf.summary.SummaryDescription.IsInitialized(errors=None)` {#SummaryDescription.IsInitialized} - -Checks if all required fields of a message are set. - -##### Args: - - -* <b>`errors`</b>: A list which, if provided, will be populated with the field - paths of all missing required fields. - -##### Returns: - - True iff the specified message has all required fields set. - - -- - - - -#### `tf.summary.SummaryDescription.ListFields()` {#SummaryDescription.ListFields} - - - - -- - - - -#### `tf.summary.SummaryDescription.MergeFrom(msg)` {#SummaryDescription.MergeFrom} - - - - -- - - - -#### `tf.summary.SummaryDescription.MergeFromString(serialized)` {#SummaryDescription.MergeFromString} - - - - -- - - - -#### `tf.summary.SummaryDescription.ParseFromString(serialized)` {#SummaryDescription.ParseFromString} - -Parse serialized protocol buffer data into this message. - -Like MergeFromString(), except we clear the object first and -do not return the value that MergeFromString returns. - - -- - - - -#### `tf.summary.SummaryDescription.RegisterExtension(extension_handle)` {#SummaryDescription.RegisterExtension} - - - - -- - - - -#### `tf.summary.SummaryDescription.SerializePartialToString()` {#SummaryDescription.SerializePartialToString} - - - - -- - - - -#### `tf.summary.SummaryDescription.SerializeToString()` {#SummaryDescription.SerializeToString} - - - - -- - - - -#### `tf.summary.SummaryDescription.SetInParent()` {#SummaryDescription.SetInParent} - -Sets the _cached_byte_size_dirty bit to true, -and propagates this to our listener iff this was a state change. - - -- - - - -#### `tf.summary.SummaryDescription.WhichOneof(oneof_name)` {#SummaryDescription.WhichOneof} - -Returns the name of the currently set field inside a oneof, or None. - - -- - - - -#### `tf.summary.SummaryDescription.__deepcopy__(memo=None)` {#SummaryDescription.__deepcopy__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__eq__(other)` {#SummaryDescription.__eq__} - - - - -- - - - #### `tf.summary.SummaryDescription.__getstate__()` {#SummaryDescription.__getstate__} Support the pickle protocol. -- - - - -#### `tf.summary.SummaryDescription.__hash__()` {#SummaryDescription.__hash__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__init__(**kwargs)` {#SummaryDescription.__init__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__ne__(other_msg)` {#SummaryDescription.__ne__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__repr__()` {#SummaryDescription.__repr__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__setstate__(state)` {#SummaryDescription.__setstate__} - -Support the pickle protocol. - - -- - - - -#### `tf.summary.SummaryDescription.__str__()` {#SummaryDescription.__str__} - - - - -- - - - -#### `tf.summary.SummaryDescription.__unicode__()` {#SummaryDescription.__unicode__} - - - - -- - - - -#### `tf.summary.SummaryDescription.type_hint` {#SummaryDescription.type_hint} - -Magic attribute generated for "type_hint" proto field. - - - - - @@ -737,253 +500,9 @@ Magic attribute generated for "type_hint" proto field. - - - -#### `tf.summary.TaggedRunMetadata.ByteSize()` {#TaggedRunMetadata.ByteSize} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.Clear()` {#TaggedRunMetadata.Clear} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.ClearExtension(extension_handle)` {#TaggedRunMetadata.ClearExtension} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.ClearField(field_name)` {#TaggedRunMetadata.ClearField} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.CopyFrom(other_msg)` {#TaggedRunMetadata.CopyFrom} - -Copies the content of the specified message into the current message. - -The method clears the current message and then merges the specified -message using MergeFrom. - -##### Args: - - -* <b>`other_msg`</b>: Message to copy into the current one. - - -- - - - -#### `tf.summary.TaggedRunMetadata.DiscardUnknownFields()` {#TaggedRunMetadata.DiscardUnknownFields} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.FindInitializationErrors()` {#TaggedRunMetadata.FindInitializationErrors} - -Finds required fields which are not initialized. - -##### Returns: - - A list of strings. Each string is a path to an uninitialized field from - the top-level message, e.g. "foo.bar[5].baz". - - -- - - - -#### `tf.summary.TaggedRunMetadata.FromString(s)` {#TaggedRunMetadata.FromString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.HasExtension(extension_handle)` {#TaggedRunMetadata.HasExtension} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.HasField(field_name)` {#TaggedRunMetadata.HasField} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.IsInitialized(errors=None)` {#TaggedRunMetadata.IsInitialized} - -Checks if all required fields of a message are set. - -##### Args: - - -* <b>`errors`</b>: A list which, if provided, will be populated with the field - paths of all missing required fields. - -##### Returns: - - True iff the specified message has all required fields set. - - -- - - - -#### `tf.summary.TaggedRunMetadata.ListFields()` {#TaggedRunMetadata.ListFields} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.MergeFrom(msg)` {#TaggedRunMetadata.MergeFrom} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.MergeFromString(serialized)` {#TaggedRunMetadata.MergeFromString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.ParseFromString(serialized)` {#TaggedRunMetadata.ParseFromString} - -Parse serialized protocol buffer data into this message. - -Like MergeFromString(), except we clear the object first and -do not return the value that MergeFromString returns. - - -- - - - -#### `tf.summary.TaggedRunMetadata.RegisterExtension(extension_handle)` {#TaggedRunMetadata.RegisterExtension} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.SerializePartialToString()` {#TaggedRunMetadata.SerializePartialToString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.SerializeToString()` {#TaggedRunMetadata.SerializeToString} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.SetInParent()` {#TaggedRunMetadata.SetInParent} - -Sets the _cached_byte_size_dirty bit to true, -and propagates this to our listener iff this was a state change. - - -- - - - -#### `tf.summary.TaggedRunMetadata.WhichOneof(oneof_name)` {#TaggedRunMetadata.WhichOneof} - -Returns the name of the currently set field inside a oneof, or None. - - -- - - - -#### `tf.summary.TaggedRunMetadata.__deepcopy__(memo=None)` {#TaggedRunMetadata.__deepcopy__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__eq__(other)` {#TaggedRunMetadata.__eq__} - - - - -- - - - #### `tf.summary.TaggedRunMetadata.__getstate__()` {#TaggedRunMetadata.__getstate__} Support the pickle protocol. -- - - - -#### `tf.summary.TaggedRunMetadata.__hash__()` {#TaggedRunMetadata.__hash__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__init__(**kwargs)` {#TaggedRunMetadata.__init__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__ne__(other_msg)` {#TaggedRunMetadata.__ne__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__repr__()` {#TaggedRunMetadata.__repr__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__setstate__(state)` {#TaggedRunMetadata.__setstate__} - -Support the pickle protocol. - - -- - - - -#### `tf.summary.TaggedRunMetadata.__str__()` {#TaggedRunMetadata.__str__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.__unicode__()` {#TaggedRunMetadata.__unicode__} - - - - -- - - - -#### `tf.summary.TaggedRunMetadata.run_metadata` {#TaggedRunMetadata.run_metadata} - -Magic attribute generated for "run_metadata" proto field. - - -- - - - -#### `tf.summary.TaggedRunMetadata.tag` {#TaggedRunMetadata.tag} - -Magic attribute generated for "tag" proto field. - - diff --git a/tensorflow/g3doc/api_docs/python/test.md b/tensorflow/g3doc/api_docs/python/test.md index 625be05fd9..3a898063d7 100644 --- a/tensorflow/g3doc/api_docs/python/test.md +++ b/tensorflow/g3doc/api_docs/python/test.md @@ -215,6 +215,125 @@ Checks that for all elements of farray1 and farray2 - - - +#### `tf.test.TestCase.assertBetween(value, minv, maxv, msg=None)` {#TestCase.assertBetween} + +Asserts that value is between minv and maxv (inclusive). + + +- - - + +#### `tf.test.TestCase.assertCommandFails(command, regexes, env=None, close_fds=True, msg=None)` {#TestCase.assertCommandFails} + +Asserts a shell command fails and the error matches a regex in a list. + +##### Args: + + +* <b>`command`</b>: List or string representing the command to run. +* <b>`regexes`</b>: the list of regular expression strings. +* <b>`env`</b>: Dictionary of environment variable settings. +* <b>`close_fds`</b>: Whether or not to close all open fd's in the child after + forking. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertCommandSucceeds(command, regexes=('',), env=None, close_fds=True, msg=None)` {#TestCase.assertCommandSucceeds} + +Asserts that a shell command succeeds (i.e. exits with code 0). + +##### Args: + + +* <b>`command`</b>: List or string representing the command to run. +* <b>`regexes`</b>: List of regular expression byte strings that match success. +* <b>`env`</b>: Dictionary of environment variable settings. +* <b>`close_fds`</b>: Whether or not to close all open fd's in the child after + forking. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsExactSubsequence(container, subsequence, msg=None)` {#TestCase.assertContainsExactSubsequence} + +Assert that "container" contains "subsequence" as an exact subsequence. + +Asserts that "container" contains all the elements of "subsequence", in +order, and without other elements interspersed. For example, [1, 2, 3] is an +exact subsequence of [0, 0, 1, 2, 3, 0] but not of [0, 0, 1, 2, 0, 3, 0]. + +##### Args: + + +* <b>`container`</b>: the list we're testing for subsequence inclusion. +* <b>`subsequence`</b>: the list we hope will be an exact subsequence of container. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsInOrder(strings, target, msg=None)` {#TestCase.assertContainsInOrder} + +Asserts that the strings provided are found in the target in order. + +This may be useful for checking HTML output. + +##### Args: + + +* <b>`strings`</b>: A list of strings, such as [ 'fox', 'dog' ] +* <b>`target`</b>: A target string in which to look for the strings, such as + 'The quick brown fox jumped over the lazy dog'. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsSubsequence(container, subsequence, msg=None)` {#TestCase.assertContainsSubsequence} + +Assert that "container" contains "subsequence" as a subsequence. + +Asserts that "container" contains all the elements of "subsequence", in +order, but possibly with other elements interspersed. For example, [1, 2, 3] +is a subsequence of [0, 0, 1, 2, 0, 3, 0] but not of [0, 0, 1, 3, 0, 2, 0]. + +##### Args: + + +* <b>`container`</b>: the list we're testing for subsequence inclusion. +* <b>`subsequence`</b>: the list we hope will be a subsequence of container. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertContainsSubset(expected_subset, actual_set, msg=None)` {#TestCase.assertContainsSubset} + +Checks whether actual iterable is a superset of expected iterable. + + +- - - + +#### `tf.test.TestCase.assertCountEqual(*args, **kwargs)` {#TestCase.assertCountEqual} + +An unordered sequence specific comparison. + +Equivalent to assertItemsEqual(). This method is a compatibility layer +for Python 3k, since 2to3 does not convert assertItemsEqual() calls into +assertCountEqual() calls. + +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`msg`</b>: The message to be printed if the test fails. + + +- - - + #### `tf.test.TestCase.assertDeviceEqual(device1, device2)` {#TestCase.assertDeviceEqual} Asserts that the two given devices are the same. @@ -235,10 +354,49 @@ Checks whether actual is a superset of expected. - - - -#### `tf.test.TestCase.assertDictEqual(d1, d2, msg=None)` {#TestCase.assertDictEqual} +#### `tf.test.TestCase.assertDictEqual(a, b, msg=None)` {#TestCase.assertDictEqual} +Raises AssertionError if a and b are not equal dictionaries. + +##### Args: + + +* <b>`a`</b>: A dict, the expected value. +* <b>`b`</b>: A dict, the actual value. +* <b>`msg`</b>: An optional str, the associated message. + +##### Raises: + + +* <b>`AssertionError`</b>: if the dictionaries are not equal. + + +- - - + +#### `tf.test.TestCase.assertEmpty(container, msg=None)` {#TestCase.assertEmpty} + +Assert that an object has zero length. + +##### Args: + + +* <b>`container`</b>: Anything that implements the collections.Sized interface. +* <b>`msg`</b>: Optional message to report on failure. +- - - + +#### `tf.test.TestCase.assertEndsWith(actual, expected_end, msg=None)` {#TestCase.assertEndsWith} + +Assert that actual.endswith(expected_end) is True. + +##### Args: + + +* <b>`actual`</b>: str +* <b>`expected_end`</b>: str +* <b>`msg`</b>: Optional message to report on failure. + - - - @@ -322,10 +480,11 @@ Included for symmetry with assertIsNone. - - - -#### `tf.test.TestCase.assertItemsEqual(expected_seq, actual_seq, msg=None)` {#TestCase.assertItemsEqual} +#### `tf.test.TestCase.assertItemsEqual(*args, **kwargs)` {#TestCase.assertItemsEqual} + +An unordered sequence specific comparison. -An unordered sequence specific comparison. It asserts that -actual_seq and expected_seq have the same element counts. +It asserts that actual_seq and expected_seq have the same element counts. Equivalent to:: self.assertEqual(Counter(iter(actual_seq)), @@ -338,6 +497,30 @@ Asserts that each element has the same count in both sequences. - [0, 1, 1] and [1, 0, 1] compare equal. - [0, 0, 1] and [0, 1] compare unequal. +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`msg`</b>: The message to be printed if the test fails. + + +- - - + +#### `tf.test.TestCase.assertJsonEqual(first, second, msg=None)` {#TestCase.assertJsonEqual} + +Asserts that the JSON objects defined in two strings are equal. + +A summary of the differences will be included in the failure message +using assertSameStructure. + +##### Args: + + +* <b>`first`</b>: A string contining JSON to decode and compare to second. +* <b>`second`</b>: A string contining JSON to decode and compare to first. +* <b>`msg`</b>: Additional text to include in the failure message. + - - - @@ -409,6 +592,13 @@ if not. - - - +#### `tf.test.TestCase.assertNoCommonElements(expected_seq, actual_seq, msg=None)` {#TestCase.assertNoCommonElements} + +Checks whether actual iterable and expected iterable are disjoint. + + +- - - + #### `tf.test.TestCase.assertNotAlmostEqual(first, second, places=None, msg=None, delta=None)` {#TestCase.assertNotAlmostEqual} Fail if the two objects are equal as determined by their @@ -439,6 +629,33 @@ Objects that are equal automatically fail. - - - +#### `tf.test.TestCase.assertNotEmpty(container, msg=None)` {#TestCase.assertNotEmpty} + +Assert that an object has non-zero length. + +##### Args: + + +* <b>`container`</b>: Anything that implements the collections.Sized interface. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + +#### `tf.test.TestCase.assertNotEndsWith(actual, unexpected_end, msg=None)` {#TestCase.assertNotEndsWith} + +Assert that actual.endswith(unexpected_end) is False. + +##### Args: + + +* <b>`actual`</b>: str +* <b>`unexpected_end`</b>: str +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + #### `tf.test.TestCase.assertNotEqual(first, second, msg=None)` {#TestCase.assertNotEqual} Fail if the two objects are equal as determined by the '!=' @@ -476,6 +693,20 @@ Fail the test if the text matches the regular expression. - - - +#### `tf.test.TestCase.assertNotStartsWith(actual, unexpected_start, msg=None)` {#TestCase.assertNotStartsWith} + +Assert that actual.startswith(unexpected_start) is False. + +##### Args: + + +* <b>`actual`</b>: str +* <b>`unexpected_start`</b>: str +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + #### `tf.test.TestCase.assertProtoEquals(expected_message_maybe_ascii, message)` {#TestCase.assertProtoEquals} Asserts that message is same as parsed expected_message_ascii. @@ -550,6 +781,38 @@ Asserts that the message in a raised exception matches a regexp. - - - +#### `tf.test.TestCase.assertRaisesWithLiteralMatch(expected_exception, expected_exception_message, callable_obj=None, *args, **kwargs)` {#TestCase.assertRaisesWithLiteralMatch} + +Asserts that the message in a raised exception equals the given string. + +Unlike assertRaisesRegexp, this method takes a literal string, not +a regular expression. + +with self.assertRaisesWithLiteralMatch(ExType, 'message'): + DoSomething() + +##### Args: + + +* <b>`expected_exception`</b>: Exception class expected to be raised. +* <b>`expected_exception_message`</b>: String message expected in the raised + exception. For a raise exception e, expected_exception_message must + equal str(e). +* <b>`callable_obj`</b>: Function to be called, or None to return a context. +* <b>`args`</b>: Extra args. +* <b>`kwargs`</b>: Extra kwargs. + +##### Returns: + + A context manager if callable_obj is None. Otherwise, None. + +##### Raises: + + self.failureException if callable_obj does not raise a macthing exception. + + +- - - + #### `tf.test.TestCase.assertRaisesWithPredicateMatch(exception_type, expected_err_re_or_predicate)` {#TestCase.assertRaisesWithPredicateMatch} Returns a context manager to enclose code expected to raise an exception. @@ -574,6 +837,71 @@ predicate search. - - - +#### `tf.test.TestCase.assertRaisesWithRegexpMatch(expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)` {#TestCase.assertRaisesWithRegexpMatch} + +Asserts that the message in a raised exception matches the given regexp. + +This is just a wrapper around assertRaisesRegexp. Please use +assertRaisesRegexp instead of assertRaisesWithRegexpMatch. + +##### Args: + + +* <b>`expected_exception`</b>: Exception class expected to be raised. +* <b>`expected_regexp`</b>: Regexp (re pattern object or string) expected to be + found in error message. +* <b>`callable_obj`</b>: Function to be called, or None to return a context. +* <b>`args`</b>: Extra args. +* <b>`kwargs`</b>: Extra keyword args. + +##### Returns: + + A context manager if callable_obj is None. Otherwise, None. + +##### Raises: + + self.failureException if callable_obj does not raise a macthing exception. + + +- - - + +#### `tf.test.TestCase.assertRegexMatch(actual_str, regexes, message=None)` {#TestCase.assertRegexMatch} + +Asserts that at least one regex in regexes matches str. + + If possible you should use assertRegexpMatches, which is a simpler + version of this method. assertRegexpMatches takes a single regular + expression (a string or re compiled object) instead of a list. + + Notes: + 1. This function uses substring matching, i.e. the matching + succeeds if *any* substring of the error message matches *any* + regex in the list. This is more convenient for the user than + full-string matching. + + 2. If regexes is the empty list, the matching will always fail. + + 3. Use regexes=[''] for a regex that will always pass. + + 4. '.' matches any single character *except* the newline. To + match any character, use '(.| +)'. + + 5. '^' matches the beginning of each line, not just the beginning + of the string. Similarly, '$' matches the end of each line. + + 6. An exception will be thrown if regexes contains an invalid + regex. + + Args: + actual_str: The string we try to match with the items in regexes. + regexes: The regular expressions we want to match against str. + See "Notes" above for detailed notes on how this is interpreted. + message: The message to be printed if the test fails. + + +- - - + #### `tf.test.TestCase.assertRegexpMatches(text, expected_regexp, msg=None)` {#TestCase.assertRegexpMatches} Fail the test unless the text matches the regular expression. @@ -581,6 +909,79 @@ Fail the test unless the text matches the regular expression. - - - +#### `tf.test.TestCase.assertSameElements(expected_seq, actual_seq, msg=None)` {#TestCase.assertSameElements} + +Assert that two sequences have the same elements (in any order). + +This method, unlike assertItemsEqual, doesn't care about any +duplicates in the expected and actual sequences. + + >> assertSameElements([1, 1, 1, 0, 0, 0], [0, 1]) + # Doesn't raise an AssertionError + +If possible, you should use assertItemsEqual instead of +assertSameElements. + +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`msg`</b>: The message to be printed if the test fails. + + +- - - + +#### `tf.test.TestCase.assertSameStructure(a, b, aname='a', bname='b', msg=None)` {#TestCase.assertSameStructure} + +Asserts that two values contain the same structural content. + +The two arguments should be data trees consisting of trees of dicts and +lists. They will be deeply compared by walking into the contents of dicts +and lists; other items will be compared using the == operator. +If the two structures differ in content, the failure message will indicate +the location within the structures where the first difference is found. +This may be helpful when comparing large structures. + +##### Args: + + +* <b>`a`</b>: The first structure to compare. +* <b>`b`</b>: The second structure to compare. +* <b>`aname`</b>: Variable name to use for the first structure in assertion messages. +* <b>`bname`</b>: Variable name to use for the second structure. +* <b>`msg`</b>: Additional text to include in the failure message. + + +- - - + +#### `tf.test.TestCase.assertSequenceAlmostEqual(expected_seq, actual_seq, places=None, msg=None, delta=None)` {#TestCase.assertSequenceAlmostEqual} + +An approximate equality assertion for ordered sequences. + +Fail if the two sequences are unequal as determined by their value +differences rounded to the given number of decimal places (default 7) and +comparing to zero, or by comparing that the difference between each value +in the two sequences is more than the given delta. + +Note that decimal places (from zero) are usually not the same as significant +digits (measured from the most signficant digit). + +If the two sequences compare equal then they will automatically compare +almost equal. + +##### Args: + + +* <b>`expected_seq`</b>: A sequence containing elements we are expecting. +* <b>`actual_seq`</b>: The sequence that we are testing. +* <b>`places`</b>: The number of decimal places to compare. +* <b>`msg`</b>: The message to be printed if the test fails. +* <b>`delta`</b>: The OK difference between compared values. + + +- - - + #### `tf.test.TestCase.assertSequenceEqual(seq1, seq2, msg=None, seq_type=None)` {#TestCase.assertSequenceEqual} An equality assertion for ordered sequences (like lists and tuples). @@ -601,6 +1002,26 @@ which can be indexed, has a length, and has an equality operator. - - - +#### `tf.test.TestCase.assertSequenceStartsWith(prefix, whole, msg=None)` {#TestCase.assertSequenceStartsWith} + +An equality assertion for the beginning of ordered sequences. + +If prefix is an empty sequence, it will raise an error unless whole is also +an empty sequence. + +If prefix is not a sequence, it will raise an error if the first element of +whole does not match. + +##### Args: + + +* <b>`prefix`</b>: A sequence expected at the beginning of the whole parameter. +* <b>`whole`</b>: The sequence in which to look for prefix. +* <b>`msg`</b>: Optional message to report on failure. + + +- - - + #### `tf.test.TestCase.assertSetEqual(set1, set2, msg=None)` {#TestCase.assertSetEqual} A set-specific equality assertion. @@ -652,6 +1073,51 @@ Assert that actual.startswith(expected_start) is True. - - - +#### `tf.test.TestCase.assertTotallyOrdered(*groups, **kwargs)` {#TestCase.assertTotallyOrdered} + +Asserts that total ordering has been implemented correctly. + +For example, say you have a class A that compares only on its attribute x. +Comparators other than __lt__ are omitted for brevity. + +class A(object): + def __init__(self, x, y): + self.x = x + self.y = y + + def __hash__(self): + return hash(self.x) + + def __lt__(self, other): + try: + return self.x < other.x + except AttributeError: + return NotImplemented + +assertTotallyOrdered will check that instances can be ordered correctly. +For example, + +self.assertTotallyOrdered( + [None], # None should come before everything else. + [1], # Integers sort earlier. + [A(1, 'a')], + [A(2, 'b')], # 2 is after 1. + [A(3, 'c'), A(3, 'd')], # The second argument is irrelevant. + [A(4, 'z')], + ['foo']) # Strings sort last. + +##### Args: + + +* <b>`*groups`</b>: A list of groups of elements. Each group of elements is a list + of objects that are equal. The elements in each group must be less than + the elements in the group after it. For example, these groups are + totally ordered: [None], [1], [2, 2], [3]. +* <b>`**kwargs`</b>: optional msg keyword argument can be passed. + + +- - - + #### `tf.test.TestCase.assertTrue(expr, msg=None)` {#TestCase.assertTrue} Check that the expression is true. @@ -674,6 +1140,13 @@ A tuple-specific equality assertion. - - - +#### `tf.test.TestCase.assertUrlEqual(a, b, msg=None)` {#TestCase.assertUrlEqual} + +Asserts that urls are equal, ignoring ordering of query params. + + +- - - + #### `tf.test.TestCase.assert_(expr, msg=None)` {#TestCase.assert_} Check that the expression is true. @@ -733,9 +1206,9 @@ tearDown. - - - -#### `tf.test.TestCase.fail(msg=None)` {#TestCase.fail} +#### `tf.test.TestCase.fail(msg=None, prefix=None)` {#TestCase.fail} -Fail immediately, with the given message. +Fail immediately with the given message, optionally prefixed. - - - @@ -789,6 +1262,13 @@ Fail immediately, with the given message. - - - +#### `tf.test.TestCase.getRecordedProperties()` {#TestCase.getRecordedProperties} + +Return any properties that the user has recorded. + + +- - - + #### `tf.test.TestCase.get_temp_dir()` {#TestCase.get_temp_dir} Returns a unique temporary directory for the test to use. @@ -811,6 +1291,20 @@ pollute each others environment. - - - +#### `tf.test.TestCase.recordProperty(property_name, property_value)` {#TestCase.recordProperty} + +Record an arbitrary property for later use. + +##### Args: + + +* <b>`property_name`</b>: str, name of property to record; must be a valid XML + attribute name +* <b>`property_value`</b>: value of property; must be valid XML attribute value + + +- - - + #### `tf.test.TestCase.run(result=None)` {#TestCase.run} @@ -834,11 +1328,18 @@ Hook method for setting up class fixture before running tests in the class. #### `tf.test.TestCase.shortDescription()` {#TestCase.shortDescription} -Returns a one-line description of the test, or None if no -description has been provided. +Format both the test method name and the first line of its docstring. + +If no docstring is given, only returns the method name. + +This method overrides unittest.TestCase.shortDescription(), which +only returns the first line of the docstring, obscuring the name +of the test upon failure. + +##### Returns: + -The default implementation of this method returns the first line of -the specified test method's docstring. +* <b>`desc`</b>: A short description of a test method. - - - |