Skip to content

Commit be78b65

Browse files
Range estimator: Histogram aggregator docstrings (#3679)
### Changes RAW reducer/ HISTOGRAM aggregator and HISTOGRAM range estimator parameters set docstrings are introduced ### Reason for changes To fill missed parameters in docstrings
1 parent 1c31806 commit be78b65

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/nncf/quantization/range_estimator.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ class StatisticsType(Enum):
2929
:param QUANTILE: A specific quantile value in a tensor.
3030
:param ABS_QUANTILE: A specific quantile value in the absolute tensor.
3131
:param MEAN: The mean value of a tensor.
32+
:param RAW: Tensor values as they are.
3233
"""
3334

3435
MAX = "max"
@@ -52,6 +53,8 @@ class AggregatorType(Enum):
5253
:param MEDIAN: The median value of a set of tensors.
5354
:param MEAN_NO_OUTLIERS: The mean value of a set of tensors with outliers removed.
5455
:param MEDIAN_NO_OUTLIERS: The median value of a set of tensors with outliers removed.
56+
:param HISTOGRAM: The minimum and maximum values determined by minimization
57+
of a quantization error on a histogram of the input tensor distribution.
5558
"""
5659

5760
MEAN = "mean"
@@ -123,6 +126,8 @@ class RangeEstimatorParametersSet:
123126
:param MEAN_QUANTILE : The range estimator parameters where the low bound of the range
124127
is calculated as average (across every sample) of (quantile outlier probability)-quantiles,
125128
the upper bound of the range as average of (1 - quantile outlier probability)-quantiles of the same values.
129+
:param HISTOGRAM: The range estimator parameters, where the lower and upper bounds of the range
130+
are calculated as optimal quantization parameters based on the histogram of the given set of tensors.
126131
"""
127132

128133
MINMAX = RangeEstimatorParameters(

0 commit comments

Comments
 (0)