tensorflow / tensorflow/model-optimization
Support for Recurrent layers for Quantization Aware Training.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.6k
- Forks
- 349
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
System information
- TensorFlow version (you are using): 2.15
- Are you willing to contribute it (Yes/No): Yes
Motivation
I am trying to train RNN model with quantization aware training for embedded devices.
Describe the feature
I am looking for a way to train with default 8bit weights & activations quantization using quantize_apply API without passing in custom config.
Describe how the feature helps achieve the use case
Describe how existing APIs don't satisfy your use case (optional if obvious)
I tried to use quantize_apply API but I received this error.
RuntimeError: Layer gru:<class 'keras.src.layers.rnn.gru.GRU'> is not supported. You can quantize this layer by passing a `tfmot.quantization.keras.QuantizeConfig` instance to the `quantize_annotate_layer` API.
After using quantize_annotate_layer, I was able to train the model but Model fails to save with following error:
keras.models.save_model(model, filepath=model_filename, save_format="h5")
Traceback (most recent call last):
File "/workspaces/project-embedded/syntiant-ndp-model-converter/examples/train_audio_model.py", line 169, in <module>
keras.models.save_model(model, filepath=model_filename, save_format="h5")
File "/home/vscode/tf_venv/lib/python3.10/site-packages/keras/src/saving/saving_api.py", line 167, in save_model
return legacy_sm_saving_lib.save_model(
File "/home/vscode/tf_venv/lib/python3.10/site-packages/keras/src/utils/traceback_utils.py", line 70, in error_handler
raise e.with_traceback(filtered_tb) from None
File "/home/vscode/tf_venv/lib/python3.10/site-packages/h5py/_hl/group.py", line 183, in create_dataset
dsid = dataset.make_new_dset(group, shape, dtype, data, name, **kwds)
File "/home/vscode/tf_venv/lib/python3.10/site-packages/h5py/_hl/dataset.py", line 163, in make_new_dset
dset_id = h5d.create(parent.id, name, tid, sid, dcpl=dcpl, dapl=dapl)
File "h5py/_objects.pyx", line 54, in h5py._objects.with_phil.wrapper
File "h5py/_objects.pyx", line 55, in h5py._objects.with_phil.wrapper
File "h5py/h5d.pyx", line 137, in h5py.h5d.create
ValueError: Unable to synchronously create dataset (name already exists)
I used following QuantizeConfig
class GruQuantizeConfig(tfmot.quantization.keras.QuantizeConfig):
# Configure how to quantize weights.
def get_weights_and_quantizers(self, layer):
return [
(
layer.cell.kernel,
LastValueQuantizer(
num_bits=8, symmetric=True, narrow_range=False, per_axis=False
),
),
(
layer.cell.recurrent_kernel,
LastValueQuantizer(
num_bits=8, symmetric=True, narrow_range=False, per_axis=False
),
),
]
# Configure how to quantize activations.
def get_activations_and_quantizers(self, layer):
return [
(
layer.cell.activation,
MovingAverageQuantizer(
num_bits=8, symmetric=False, narrow_range=False, per_axis=False
),
),
(
layer.cell.recurrent_activation,
MovingAverageQuantizer(
num_bits=8, symmetric=False, narrow_range=False, per_axis=False
),
),
]
def set_quantize_weights(self, layer, quantize_weights):
# Add this line for each item returned in `get_weights_and_quantizers`
# , in the same order
layer.cell.kernel = quantize_weights[0]
layer.cell.recurrent_kernel = quantize_weights[1]
def set_quantize_activations(self, layer, quantize_activations):
# Add this line for each item returned in `get_activations_and_quantizers`
# , in the same order.
layer.cell.activation = quantize_activations[0]
layer.cell.recurrent_activation = quantize_activations[1]
# Configure how to quantize outputs (may be equivalent to activations).
def get_output_quantizers(self, layer):
return []
def get_config(self):
return {}
I looked at the source code. It seems that the support for RNN is disabled here for some reason.
I was wondering if this can be enabled back?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading default_8bit_quantize_registry.py around line 159, where RNN support is disabled, and reproduce the quantize_apply failure with the reported TensorFlow 2.15 GRU case. Investigate the custom QuantizeConfig and the subsequent H5 save error. Done means recurrent layers support default 8-bit quantization through quantize_apply and the quantized model can be saved successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- keras, python, tensorflow
- Domain
- machine-learning
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100