Link docstrings to module guides and remove redundant text.

Change: 147402322
This commit is contained in:
Andrew Selle 2017-02-13 15:34:18 -08:00 committed by TensorFlower Gardener
parent 69d028435d
commit d065a5d984
2 changed files with 2 additions and 40 deletions

View File

@ -12,51 +12,15 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# ============================================================================== # ==============================================================================
"""Training and input utilities. """Training and input utilities. See @{$python/contrib.training} guide.
## Splitting sequence inputs into minibatches with state saving
Use [`SequenceQueueingStateSaver`](#SequenceQueueingStateSaver) or
its wrapper [`batch_sequences_with_states`](#batch_sequences_with_states) if
you have input data with a dynamic primary time / frame count axis which
you'd like to convert into fixed size segments during minibatching, and would
like to store state in the forward direction across segments of an example.
@@batch_sequences_with_states @@batch_sequences_with_states
@@NextQueuedSequenceBatch @@NextQueuedSequenceBatch
@@SequenceQueueingStateSaver @@SequenceQueueingStateSaver
## Online data resampling
To resample data with replacement on a per-example basis, use
['rejection_sample'](#rejection_sample) or
['resample_at_rate'](#resample_at_rate). For `rejection_sample`, provide
a boolean Tensor describing whether to accept or reject. Resulting batch sizes
are always the same. For `resample_at_rate`, provide the desired rate for each
example. Resulting batch sizes may vary. If you wish to specify relative
rates, rather than absolute ones, use ['weighted_resample'](#weighted_resample)
(which also returns the actual resampling rate used for each output example).
Use ['stratified_sample'](#stratified_sample) to resample without replacement
from the data to achieve a desired mix of class proportions that the Tensorflow
graph sees. For instance, if you have a binary classification dataset that is
99.9% class 1, a common approach is to resample from the data so that the data
is more balanced.
@@rejection_sample @@rejection_sample
@@resample_at_rate @@resample_at_rate
@@stratified_sample @@stratified_sample
@@weighted_resample @@weighted_resample
## Bucketing
Use ['bucket'](#bucket) or
['bucket_by_sequence_length'](#bucket_by_sequence_length) to stratify
minibatches into groups ("buckets"). Use `bucket_by_sequence_length`
with the argument `dynamic_pad=True` to receive minibatches of similarly
sized sequences for efficient training via `dynamic_rnn`.
@@bucket @@bucket
@@bucket_by_sequence_length @@bucket_by_sequence_length
""" """

View File

@ -13,9 +13,7 @@
# limitations under the License. # limitations under the License.
# ============================================================================== # ==============================================================================
"""Utilities for dealing with Tensors. """Utilities for dealing with Tensors. See @{$python/contrib.util} guide.
## Miscellaneous Utility Functions
@@constant_value @@constant_value
@@make_tensor_proto @@make_tensor_proto