Home | History | Annotate | Download | only in experimental 
      1 # Copyright 2017 The TensorFlow Authors. All Rights Reserved.
      2 #
      3 # Licensed under the Apache License, Version 2.0 (the "License");
      4 # you may not use this file except in compliance with the License.
      5 # You may obtain a copy of the License at
      6 #
      7 #     http://www.apache.org/licenses/LICENSE-2.0
      8 #
      9 # Unless required by applicable law or agreed to in writing, software
     10 # distributed under the License is distributed on an "AS IS" BASIS,
     11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     12 # See the License for the specific language governing permissions and
     13 # limitations under the License.
     14 # ==============================================================================
     15 """Experimental API for building input pipelines.
     16 
     17 This module contains experimental `Dataset` sources and transformations that can
     18 be used in conjunction with the `tf.data.Dataset` API. Note that the
     19 `tf.data.experimental` API is not subject to the same backwards compatibility
     20 guarantees as `tf.data`, but we will provide deprecation advice in advance of
     21 removing existing functionality.
     22 
     23 See [Importing Data](https://tensorflow.org/guide/datasets) for an overview.
     24 
     25 @@Counter
     26 @@CheckpointInputPipelineHook
     27 @@CsvDataset
     28 @@DatasetStructure
     29 @@NestedStructure
     30 @@OptimizationOptions
     31 @@Optional
     32 @@OptionalStructure
     33 @@RandomDataset
     34 @@Reducer
     35 @@SparseTensorStructure
     36 @@SqlDataset
     37 @@StatsAggregator
     38 @@StatsOptions
     39 @@Structure
     40 @@TFRecordWriter
     41 @@TensorStructure
     42 @@ThreadingOptions
     43 
     44 @@bucket_by_sequence_length
     45 @@bytes_produced_stats
     46 @@cardinality
     47 @@choose_from_datasets
     48 @@copy_to_device
     49 @@dense_to_sparse_batch
     50 @@enumerate_dataset
     51 @@get_next_as_optional
     52 @@get_single_element
     53 @@group_by_reducer
     54 @@group_by_window
     55 @@ignore_errors
     56 @@latency_stats
     57 @@make_batched_features_dataset
     58 @@make_csv_dataset
     59 @@make_saveable_from_iterator
     60 @@map_and_batch
     61 @@map_and_batch_with_legacy_function
     62 @@parallel_interleave
     63 @@parse_example_dataset
     64 @@prefetch_to_device
     65 @@rejection_resample
     66 @@sample_from_datasets
     67 @@scan
     68 @@shuffle_and_repeat
     69 @@take_while
     70 @@unbatch
     71 @@unique
     72 
     73 @@AUTOTUNE
     74 @@INFINITE_CARDINALITY
     75 @@UNKNOWN_CARDINALITY
     76 """
     77 
     78 from __future__ import absolute_import
     79 from __future__ import division
     80 from __future__ import print_function
     81 
     82 # pylint: disable=unused-import
     83 
     84 from tensorflow.python.data.experimental.ops.batching import dense_to_sparse_batch
     85 from tensorflow.python.data.experimental.ops.batching import map_and_batch
     86 from tensorflow.python.data.experimental.ops.batching import map_and_batch_with_legacy_function
     87 from tensorflow.python.data.experimental.ops.batching import unbatch
     88 from tensorflow.python.data.experimental.ops.cardinality import cardinality
     89 from tensorflow.python.data.experimental.ops.cardinality import INFINITE as INFINITE_CARDINALITY
     90 from tensorflow.python.data.experimental.ops.cardinality import UNKNOWN as UNKNOWN_CARDINALITY
     91 from tensorflow.python.data.experimental.ops.counter import Counter
     92 from tensorflow.python.data.experimental.ops.enumerate_ops import enumerate_dataset
     93 from tensorflow.python.data.experimental.ops.error_ops import ignore_errors
     94 from tensorflow.python.data.experimental.ops.get_single_element import get_single_element
     95 from tensorflow.python.data.experimental.ops.grouping import bucket_by_sequence_length
     96 from tensorflow.python.data.experimental.ops.grouping import group_by_reducer
     97 from tensorflow.python.data.experimental.ops.grouping import group_by_window
     98 from tensorflow.python.data.experimental.ops.grouping import Reducer
     99 from tensorflow.python.data.experimental.ops.interleave_ops import choose_from_datasets
    100 from tensorflow.python.data.experimental.ops.interleave_ops import parallel_interleave
    101 from tensorflow.python.data.experimental.ops.interleave_ops import sample_from_datasets
    102 from tensorflow.python.data.experimental.ops.iterator_ops import CheckpointInputPipelineHook
    103 from tensorflow.python.data.experimental.ops.iterator_ops import make_saveable_from_iterator
    104 from tensorflow.python.data.experimental.ops.optimization import AUTOTUNE
    105 from tensorflow.python.data.experimental.ops.optimization_options import OptimizationOptions
    106 from tensorflow.python.data.experimental.ops.parsing_ops import parse_example_dataset
    107 from tensorflow.python.data.experimental.ops.prefetching_ops import copy_to_device
    108 from tensorflow.python.data.experimental.ops.prefetching_ops import prefetch_to_device
    109 from tensorflow.python.data.experimental.ops.random_ops import RandomDataset
    110 from tensorflow.python.data.experimental.ops.readers import CsvDataset
    111 from tensorflow.python.data.experimental.ops.readers import make_batched_features_dataset
    112 from tensorflow.python.data.experimental.ops.readers import make_csv_dataset
    113 from tensorflow.python.data.experimental.ops.readers import SqlDataset
    114 from tensorflow.python.data.experimental.ops.resampling import rejection_resample
    115 from tensorflow.python.data.experimental.ops.scan_ops import scan
    116 from tensorflow.python.data.experimental.ops.shuffle_ops import shuffle_and_repeat
    117 from tensorflow.python.data.experimental.ops.stats_aggregator import StatsAggregator
    118 from tensorflow.python.data.experimental.ops.stats_ops import bytes_produced_stats
    119 from tensorflow.python.data.experimental.ops.stats_ops import latency_stats
    120 from tensorflow.python.data.experimental.ops.stats_options import StatsOptions
    121 from tensorflow.python.data.experimental.ops.take_while_ops import take_while
    122 from tensorflow.python.data.experimental.ops.threading_options import ThreadingOptions
    123 from tensorflow.python.data.experimental.ops.unique import unique
    124 from tensorflow.python.data.experimental.ops.writers import TFRecordWriter
    125 from tensorflow.python.data.ops.dataset_ops import DatasetStructure
    126 from tensorflow.python.data.ops.iterator_ops import get_next_as_optional
    127 from tensorflow.python.data.ops.optional_ops import Optional
    128 from tensorflow.python.data.ops.optional_ops import OptionalStructure
    129 from tensorflow.python.data.util.structure import NestedStructure
    130 from tensorflow.python.data.util.structure import SparseTensorStructure
    131 from tensorflow.python.data.util.structure import Structure
    132 from tensorflow.python.data.util.structure import TensorStructure
    133 # pylint: enable=unused-import
    134 
    135 from tensorflow.python.util.all_util import remove_undocumented
    136 remove_undocumented(__name__)
    137