95 lines
3.1 KiB
Python
95 lines
3.1 KiB
Python
# Copyright 2017 The TensorFlow Authors. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
# ==============================================================================
|
|
"""Directives are special no-op functions that serve as compilation markers.
|
|
|
|
They provide static information like type hints, compilation and TensorFlow
|
|
overrides.
|
|
|
|
These serve as annotations in the compiled code, allowing the user some control
|
|
over the compilation process. They have no functional role at runtime.
|
|
"""
|
|
|
|
from tensorflow.python.util.tf_export import tf_export
|
|
|
|
UNSPECIFIED = object()
|
|
|
|
|
|
def set_element_type(entity, dtype, shape=UNSPECIFIED):
|
|
"""Indicates that the entity is expected hold items of specified type/shape.
|
|
|
|
The staged TensorFlow ops will reflect and assert this data type. Ignored
|
|
otherwise.
|
|
|
|
Args:
|
|
entity: The entity to annotate.
|
|
dtype: TensorFlow dtype value to assert for entity.
|
|
shape: Optional shape to assert for entity.
|
|
"""
|
|
del entity
|
|
del dtype
|
|
del shape
|
|
|
|
|
|
@tf_export('autograph.experimental.set_loop_options')
|
|
def set_loop_options(
|
|
parallel_iterations=UNSPECIFIED,
|
|
swap_memory=UNSPECIFIED,
|
|
maximum_iterations=UNSPECIFIED,
|
|
shape_invariants=UNSPECIFIED):
|
|
"""Specifies additional arguments to be passed to the enclosing while_loop.
|
|
|
|
The parameters apply to and only to the immediately enclosing loop. It only
|
|
has effect if the loop is staged as a TF while_loop; otherwise the parameters
|
|
have no effect.
|
|
|
|
Usage:
|
|
|
|
>>> @tf.function(autograph=True)
|
|
... def f():
|
|
... n = 0
|
|
... for i in tf.range(10):
|
|
... tf.autograph.experimental.set_loop_options(maximum_iterations=3)
|
|
... n += 1
|
|
... return n
|
|
|
|
>>> @tf.function(autograph=True)
|
|
... def f():
|
|
... v = tf.constant((0,))
|
|
... for i in tf.range(3):
|
|
... tf.autograph.experimental.set_loop_options(
|
|
... shape_invariants=[(v, tf.TensorShape([None]))]
|
|
... )
|
|
... v = tf.concat((v, [i]), 0)
|
|
... return v
|
|
|
|
Also see tf.while_loop.
|
|
|
|
Args:
|
|
parallel_iterations: The maximum number of iterations allowed to run in
|
|
parallel at any given time. Note that this does not guarantee parallel
|
|
execution.
|
|
swap_memory: Whether to store intermediate values needed for
|
|
gradients on the CPU instead of GPU.
|
|
maximum_iterations: Allows limiting the total number of iterations executed
|
|
by the loop.
|
|
shape_invariants: Allows controlling the argument with the same name passed
|
|
to tf.while_loop. Unlike tf.while_loop, this is a list of
|
|
`(tensor, shape)` pairs.
|
|
"""
|
|
del parallel_iterations
|
|
del swap_memory
|
|
del maximum_iterations
|
|
del shape_invariants
|