Release 2.10.0
Breaking Changes
- Causal attention in
keras.layers.Attention
andkeras.layers.AdditiveAttention
is now specified in thecall()
method via theuse_causal_mask
argument (rather than in the constructor), for consistency with other layers. - Some files in
tensorflow/python/training
have been moved totensorflow/python/tracking
andtensorflow/python/checkpoint
. Please update your imports accordingly, the old files will be removed in Release 2.11. tf.keras.optimizers.experimental.Optimizer
will graduate in Release 2.11, which meanstf.keras.optimizers.Optimizer
will be an alias oftf.keras.optimizers.experimental.Optimizer
. The currenttf.keras.optimizers.Optimizer
will continue to be supported astf.keras.optimizers.legacy.Optimizer
, e.g.,tf.keras.optimizers.legacy.Adam
. Most users won’t be affected by this change, but please check the API doc if any API used in your workflow is changed or deprecated, and make adaptions. If you decide to keep using the old optimizer, please explicitly change your optimizer totf.keras.optimizers.legacy.Optimizer
.- RNG behavior change for
tf.keras.initializers
. Keras initializers will now use stateless random ops to generate random numbers.- Both seeded and unseeded initializers will always generate the same values every time they are called (for a given variable shape). For unseeded initializers (
seed=None
), a random seed will be created and assigned at initializer creation (different initializer instances get different seeds). - An unseeded initializer will raise a warning if it is reused (called) multiple times. This is because it would produce the same values each time, which may not be intended.
- Both seeded and unseeded initializers will always generate the same values every time they are called (for a given variable shape). For unseeded initializers (
Deprecations
- The C++
tensorflow::Code
andtensorflow::Status
will become aliases of respectivelyabsl::StatusCode
andabsl::Status
in some future release.- Use
tensorflow::OkStatus()
instead oftensorflow::Status::OK()
. - Stop constructing
Status
objects fromtensorflow::error::Code
. - One MUST NOT access
tensorflow::errors::Code
fields. Accessingtensorflow::error::Code
fields is fine.- Use the constructors such as
tensorflow::errors:InvalidArgument
to create status using an error code without accessing it. - Use the free functions such as
tensorflow::errors::IsInvalidArgument
if needed. - In the last resort, use e.g.
static_cast<tensorflow::errors::Code>(error::Code::INVALID_ARGUMENT)
orstatic_cast<int>(code)
for comparisons.
- Use the constructors such as
- Use
tensorflow::StatusOr
will also become in the future alias toabsl::StatusOr
, so useStatusOr::value
instead ofStatusOr::ConsumeValueOrDie
.
Major Features and Improvements
tf.lite
:- New operations supported:
- tflite SelectV2 now supports 5D.
- tf.einsum is supported with multiple unknown shapes.
- tf.unsortedsegmentprod op is supported.
- tf.unsortedsegmentmax op is supported.
- tf.unsortedsegmentsum op is supported.
- Updates to existing operations:
- tfl.scatter_nd now supports I1 for update arg.
- Upgrade Flatbuffers v2.0.5 from v1.12.0
- New operations supported:
tf.keras
:EinsumDense
layer is moved from experimental to core. Its import path is moved fromtf.keras.layers.experimental.EinsumDense
totf.keras.layers.EinsumDense
.- Added
tf.keras.utils.audio_dataset_from_directory
utility to easily generate audio classification datasets from directories of.wav
files. - Added
subset="both"
support intf.keras.utils.image_dataset_from_directory
,tf.keras.utils.text_dataset_from_directory
, andaudio_dataset_from_directory
, to be used with thevalidation_split
argument, for returning both dataset splits at once, as a tuple. - Added
tf.keras.utils.split_dataset
utility to split aDataset
object or a list/tuple of arrays into twoDataset
objects (e.g. train/test). - Added step granularity to
BackupAndRestore
callback for handling distributed training failures & restarts. The training state can now be restored at the exact epoch and step at which it was previously saved before failing. - Added
tf.keras.dtensor.experimental.optimizers.AdamW
. This optimizer is similar as the existingkeras.optimizers.experimental.AdamW
, and works in the DTensor training use case. - Improved masking support for
tf.keras.layers.MultiHeadAttention
.- Implicit masks for
query
,key
andvalue
inputs will automatically be used to compute a correct attention mask for the layer. These padding masks will be combined with anyattention_mask
passed in directly when calling the layer. This can be used withtf.keras.layers.Embedding
withmask_zero=True
to automatically infer a correct padding mask. - Added a
use_causal_mask
call time arugment to the layer. Passinguse_causal_mask=True
will compute a causal attention mask, and optionally combine it with anyattention_mask
passed in directly when calling the layer.
- Implicit masks for
- Added
ignore_class
argument in the lossSparseCategoricalCrossentropy
and metricsIoU
andMeanIoU
, to specify a class index to be ignored during loss/metric computation (e.g. a background/void class). - Added
tf.keras.models.experimental.SharpnessAwareMinimization
. This class implements the sharpness-aware minimization technique, which boosts model performance on various tasks, e.g., ResNet on image classification.
tf.data
:- Added support for cross-trainer data caching in tf.data service. This saves computation resources when concurrent training jobs train from the same dataset. See (https://www.tensorflow.org/api_docs/python/tf/data/experimental/service#sharing_tfdata_service_with_concurrent_trainers) for more details.
- Added
dataset_id
totf.data.experimental.service.register_dataset
. If provided,tf.data
service will use the provided ID for the dataset. If the dataset ID already exists, no new dataset will be registered. This is useful if multiple training jobs need to use the same dataset for training. In this case, users should callregister_dataset
with the samedataset_id
. - Added a new field,
inject_prefetch
, totf.data.experimental.OptimizationOptions
. If it is set toTrue
,tf.data
will now automatically add aprefetch
transformation to datasets that end in synchronous transformations. This enables data generation to be overlapped with data consumption. This may cause a small increase in memory usage due to buffering. To enable this behavior, setinject_prefetch=True
intf.data.experimental.OptimizationOptions
. - Added a new value to
tf.data.Options.autotune.autotune_algorithm
: STAGE_BASED. If the autotune algorithm is set to STAGE_BASED, then it runs a new algorithm that can get the same performance with lower CPU/memory usage. - Added
tf.data.experimental.from_list
, a new API for creatingDataset
s from lists of elements.
tf.distribute
:- Added
tf.distribute.experimental.PreemptionCheckpointHandler
to handle worker preemption/maintenance and cluster-wise consistent error reporting fortf.distribute.MultiWorkerMirroredStrategy
. Specifically, for the type of interruption with advance notice, it automatically saves a checkpoint, exits the program without raising an unrecoverable error, and restores the progress when training restarts.
- Added
tf.math
:- Added
tf.math.approx_max_k
andtf.math.approx_min_k
which are the optimized alternatives totf.math.top_k
on TPU. The performance difference range from 8 to 100 times depending on the size of k. When running on CPU and GPU, a non-optimized XLA kernel is used.
- Added
tf.train
:- Added
tf.train.TrackableView
which allows users to inspect the TensorFlow Trackable object (e.g.tf.Module
, Keras Layers and models).
- Added
tf.vectorized_map
:- Added an optional parameter:
warn
. This parameter controls whether or not warnings will be printed when operations in the providedfn
fall back to a while loop.
- Added an optional parameter:
- XLA:
- MWMS is now compilable with XLA.
- Compute Library for the Arm® Architecture (ACL) is supported for aarch64 CPU XLA runtime
- CPU performance optimizations:
- x86 CPUs: oneDNN bfloat16 auto-mixed precision grappler graph optimization pass has been renamed from
auto_mixed_precision_mkl
toauto_mixed_precision_onednn_bfloat16
. See example usage here. - aarch64 CPUs: Experimental performance optimizations from Compute Library for the Arm® Architecture (ACL) are available through oneDNN in the default Linux aarch64 package (
pip install tensorflow
).- The optimizations are disabled by default.
- Set the environment variable
TF_ENABLE_ONEDNN_OPTS=1
to enable the optimizations. Setting the variable to 0 or unsetting it will disable the optimizations. - These optimizations can yield slightly different numerical results from when they are off due to floating-point round-off errors from different computation approaches and orders.
- To verify that the optimizations are on, look for a message with “oneDNN custom operations are on” in the log. If the exact phrase is not there, it means they are off.
- x86 CPUs: oneDNN bfloat16 auto-mixed precision grappler graph optimization pass has been renamed from
Bug Fixes and Other Changes
- New argument
experimental_device_ordinal
inLogicalDeviceConfiguration
to control the order of logical devices. (GPU only) tf.keras
:- Changed the TensorBoard tag names produced by the
tf.keras.callbacks.TensorBoard
callback, so that summaries logged automatically for model weights now include either a/histogram
or/image
suffix in their tag names, in order to prevent tag name collisions across summary types.
- Changed the TensorBoard tag names produced by the
- When running on GPU (with cuDNN version 7.6.3 or later),
tf.nn.depthwise_conv2d
backprop tofilter
(and therefore alsotf.keras.layers.DepthwiseConv2D
) now operate deterministically (andtf.errors.UnimplementedError
is no longer thrown) when op-determinism has been enabled viatf.config.experimental.enable_op_determinism
. This closes issue 47174. tf.random
- Added
tf.random.experimental.stateless_shuffle
, a stateless version oftf.random.shuffle
.
- Added
Security
- Fixes a
CHECK
failure in tf.reshape caused by overflows (CVE-2022-35934) - Fixes a
CHECK
failure inSobolSample
caused by missing validation (CVE-2022-35935) - Fixes an OOB read in
Gather_nd
op in TF Lite (CVE-2022-35937) - Fixes a
CHECK
failure inTensorListReserve
caused by missing validation (CVE-2022-35960) - Fixes an OOB write in
Scatter_nd
op in TF Lite (CVE-2022-35939) - Fixes an integer overflow in
RaggedRangeOp
(CVE-2022-35940) - Fixes a
CHECK
failure inAvgPoolOp
(CVE-2022-35941) - Fixes a
CHECK
failures inUnbatchGradOp
(CVE-2022-35952) - Fixes a segfault TFLite converter on per-channel quantized transposed convolutions (CVE-2022-36027)
- Fixes a
CHECK
failures inAvgPool3DGrad
(CVE-2022-35959) - Fixes a
CHECK
failures inFractionalAvgPoolGrad
(CVE-2022-35963) - Fixes a segfault in
BlockLSTMGradV2
(CVE-2022-35964) - Fixes a segfault in
LowerBound
andUpperBound
(CVE-2022-35965) - Fixes a segfault in
QuantizedAvgPool
(CVE-2022-35966) - Fixes a segfault in
QuantizedAdd
(CVE-2022-35967) - Fixes a
CHECK
fail inAvgPoolGrad
(CVE-2022-35968) - Fixes a
CHECK
fail inConv2DBackpropInput
(CVE-2022-35969) - Fixes a segfault in
QuantizedInstanceNorm
(CVE-2022-35970) - Fixes a
CHECK
fail inFakeQuantWithMinMaxVars
(CVE-2022-35971) - Fixes a segfault in
Requantize
(CVE-2022-36017) - Fixes a segfault in
QuantizedBiasAdd
(CVE-2022-35972) - Fixes a
CHECK
fail inFakeQuantWithMinMaxVarsPerChannel
(CVE-2022-36019) - Fixes a segfault in
QuantizedMatMul
(CVE-2022-35973) - Fixes a segfault in
QuantizeDownAndShrinkRange
(CVE-2022-35974) - Fixes segfaults in
QuantizedRelu
andQuantizedRelu6
(CVE-2022-35979) - Fixes a
CHECK
fail inFractionalMaxPoolGrad
(CVE-2022-35981) - Fixes a
CHECK
fail inRaggedTensorToVariant
(CVE-2022-36018) - Fixes a
CHECK
fail inQuantizeAndDequantizeV3
(CVE-2022-36026) - Fixes a segfault in
SparseBincount
(CVE-2022-35982) - Fixes a
CHECK
fail inSave
andSaveSlices
(CVE-2022-35983) - Fixes a
CHECK
fail inParameterizedTruncatedNormal
(CVE-2022-35984) - Fixes a
CHECK
fail inLRNGrad
(CVE-2022-35985) - Fixes a segfault in
RaggedBincount
(CVE-2022-35986) - Fixes a
CHECK
fail inDenseBincount
(CVE-2022-35987) - Fixes a
CHECK
fail intf.linalg.matrix_rank
(CVE-2022-35988) - Fixes a
CHECK
fail inMaxPool
(CVE-2022-35989) - Fixes a
CHECK
fail inConv2DBackpropInput
(CVE-2022-35999) - Fixes a
CHECK
fail inEmptyTensorList
(CVE-2022-35998) - Fixes a
CHECK
fail intf.sparse.cross
(CVE-2022-35997) - Fixes a floating point exception in
Conv2D
(CVE-2022-35996) - Fixes a
CHECK
fail inAudioSummaryV2
(CVE-2022-35995) - Fixes a
CHECK
fail inCollectiveGather
(CVE-2022-35994) - Fixes a
CHECK
fail inSetSize
(CVE-2022-35993) - Fixes a
CHECK
fail inTensorListFromTensor
(CVE-2022-35992) - Fixes a
CHECK
fail inTensorListScatter
andTensorListScatterV2
(CVE-2022-35991) - Fixes a
CHECK
fail inFakeQuantWithMinMaxVarsPerChannelGradient
(CVE-2022-35990) - Fixes a
CHECK
fail inFakeQuantWithMinMaxVarsGradient
(CVE-2022-36005) - Fixes a
CHECK
fail intf.random.gamma
(CVE-2022-36004) - Fixes a
CHECK
fail inRandomPoissonV2
(CVE-2022-36003) - Fixes a
CHECK
fail inUnbatch
(CVE-2022-36002) - Fixes a
CHECK
fail inDrawBoundingBoxes
(CVE-2022-36001) - Fixes a
CHECK
fail inEig
(CVE-2022-36000) - Fixes a null dereference on MLIR on empty function attributes (CVE-2022-36011)
- Fixes an assertion failure on MLIR empty edge names (CVE-2022-36012)
- Fixes a null-dereference in
mlir::tfg::GraphDefImporter::ConvertNodeDef
(CVE-2022-36013) - Fixes a null-dereference in
mlir::tfg::TFOp::nameAttr
(CVE-2022-36014) - Fixes an integer overflow in math ops (CVE-2022-36015)
- Fixes a
CHECK
-fail intensorflow::full_type::SubstituteFromAttrs
(CVE-2022-36016) - Fixes an OOB read in
Gather_nd
op in TF Lite Micro (CVE-2022-35938)
Thanks to our Contributors
This release contains contributions from many people at Google, as well as:
Abolfazl Shahbazi, Adam Lanicek, Amin Benarieb, andreii, Andrew Fitzgibbon, Andrew Goodbody, angerson, Ashiq Imran, Aurélien Geron, Banikumar Maiti (Intel Aipg), Ben Barsdell, Ben Mares, bhack, Bhavani Subramanian, Bill Schnurr, Byungsoo Oh, Chandra Sr Potula, Chengji Yao, Chris Carpita, Christopher Bate, chunduriv, Cliff Woolley, Cliffs Dover, Cloud Han, Code-Review-Doctor, DEKHTIARJonathan, Deven Desai, Djacon, Duncan Riach, fedotoff, fo40225, Frederic Bastien, gadagashwini, Gauri1 Deshpande, guozhong.zhuang, Hui Peng, James Gerity, Jason Furmanek, Jonathan Dekhtiar, Jueon Park, Kaixi Hou, Kanvi Khanna, Keith Smiley, Koan-Sin Tan, Kulin Seth, kushanam, Learning-To-Play, Li-Wen Chang, lipracer, liuyuanqiang, Louis Sugy, Lucas David, Lukas Geiger, Mahmoud Abuzaina, Marius Brehler, Maxiwell S. Garcia, mdfaijul, Meenakshi Venkataraman, Michal Szutenberg, Michele Di Giorgio, Mickaël Salamin, Nathan John Sircombe, Nathan Luehr, Neil Girdhar, Nils Reichardt, Nishidha Panpaliya, Nobuo Tsukamoto, Om Thakkar, Patrice Vignola, Philipp Hack, Pooya Jannaty, Prianka Liz Kariat, pshiko, Rajeshwar Reddy T, rdl4199, Rohit Santhanam, Rsanthanam-Amd, Sachin Muradi, Saoirse Stewart, Serge Panev, Shu Wang, Srinivasan Narayanamoorthy, Stella Stamenova, Stephan Hartmann, Sunita Nadampalli, synandi, Tamas Bela Feher, Tao Xu, Thibaut Goetghebuer-Planchon, Trevor Morris, Xiaoming (Jason) Cui, Yimei Sun, Yong Tang, Yuanqiang Liu, Yulv-Git, Zhoulong Jiang, ZihengJiang