diff options
author | Nathan Bailey <nathan.bailey@arm.com> | 2024-05-17 09:05:03 +0100 |
---|---|---|
committer | Nathan Bailey <nathan.bailey@arm.com> | 2024-05-21 16:51:15 +0100 |
commit | 3002baa6b1fd226d38bcfabfe3dc15556833be6a (patch) | |
tree | a7158e696f1b61cf98cef1de24f056bf9a71c6cd /src/mlia/nn/rewrite/library/clustering.py | |
parent | 856111bcaef76c60303bdf2ae7cbf718d93d1df4 (diff) | |
download | mlia-3002baa6b1fd226d38bcfabfe3dc15556833be6a.tar.gz |
fix: Extend docstrings in the rewrite module
Rework doctrings in rewrite functions based on recent changes
Resolves MLIA-944
Signed-off-by: Nathan Bailey <nathan.bailey@arm.com>
Change-Id: I31a37e17a296f8a16d0db408d48c6de65c05300e
Diffstat (limited to 'src/mlia/nn/rewrite/library/clustering.py')
-rw-r--r-- | src/mlia/nn/rewrite/library/clustering.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/mlia/nn/rewrite/library/clustering.py b/src/mlia/nn/rewrite/library/clustering.py index 6f06c48..81bfd90 100644 --- a/src/mlia/nn/rewrite/library/clustering.py +++ b/src/mlia/nn/rewrite/library/clustering.py @@ -1,6 +1,6 @@ # SPDX-FileCopyrightText: Copyright 2024, Arm Limited and/or its affiliates. # SPDX-License-Identifier: Apache-2.0 -"""Example rewrite with one fully connected clustered layer.""" +"""Rewrite functions used to return layers ready for clustering.""" from typing import Any import tensorflow_model_optimization as tfmot @@ -10,7 +10,7 @@ from mlia.nn.rewrite.library.helper_functions import compute_conv2d_parameters def fc_clustering_rewrite(input_shape: Any, output_shape: Any) -> keras.Model: - """Generate TensorFlow Lite model for clustering rewrite.""" + """Fully connected TensorFlow Lite model ready for clustering.""" rewrite_params = { "number_of_clusters": 4, "cluster_centroids_init": tfmot.clustering.keras.CentroidInitialization.LINEAR, @@ -29,7 +29,7 @@ def fc_clustering_rewrite(input_shape: Any, output_shape: Any) -> keras.Model: def conv2d_clustering_rewrite(input_shape: Any, output_shape: Any) -> keras.Model: - """Generate TensorFlow Lite model for clustering rewrite.""" + """Conv2d TensorFlow Lite model ready for clustering.""" rewrite_params = { "number_of_clusters": 4, "cluster_centroids_init": tfmot.clustering.keras.CentroidInitialization.LINEAR, |