/
ordered_logistic.py
364 lines (294 loc) · 13.3 KB
/
ordered_logistic.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# Copyright 2020 The TensorFlow Probability Authors.
#
# 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.
# ============================================================================
"""The ordered logistic distribution class."""
import numpy as np
import tensorflow.compat.v2 as tf
from tensorflow_probability.python.bijectors import ascending
from tensorflow_probability.python.distributions import categorical
from tensorflow_probability.python.distributions import distribution
from tensorflow_probability.python.distributions import kullback_leibler
from tensorflow_probability.python.internal import assert_util
from tensorflow_probability.python.internal import distribution_util
from tensorflow_probability.python.internal import dtype_util
from tensorflow_probability.python.internal import parameter_properties
from tensorflow_probability.python.internal import prefer_static as ps
from tensorflow_probability.python.internal import reparameterization
from tensorflow_probability.python.internal import tensor_util
from tensorflow_probability.python.internal import tensorshape_util
from tensorflow_probability.python.math import generic
# TODO(b/149334734): Consider rewriting this underlying class via using
# QuantizedDistribution.
class OrderedLogistic(
distribution.DiscreteDistributionMixin,
distribution.AutoCompositeTensorDistribution):
"""Ordered logistic distribution.
The OrderedLogistic distribution is parameterized by a location and a set of
cutpoints. It is defined over the integers `{0, 1, ..., K}` for `K`
non-decreasing cutpoints.
One often useful way to interpret this distribution is by imagining a draw
from a latent/unobserved logistic distribution with location `loc` and
scale `1` and then only considering the index of the bin defined by the `K`
cutpoints this draw falls between. An example implementation of this idea is
as follows:
```python
cutpoints = [0.0, 1.0]
loc = 0.5
def probs_from_latent(latent):
augmented_cutpoints = tf.concat([[-np.inf], cutpoints, [np.inf]], axis=0)
below = latent[..., tf.newaxis] < augmented_cutpoints[1:]
above = latent[..., tf.newaxis] > augmented_cutpoints[:-1]
return tf.cast(below & above, tf.float32)
latent_and_ordered_logistic = tfd.JointDistributionSequential([
tfd.Logistic(loc=loc, scale=1.),
lambda l: tfd.Categorical(probs=probs_from_latent(l), dtype=tf.float32)
])
tf.stack(latent_and_ordered_logistic.sample(5), axis=1)
# ==> array([[ 0.6434291, 1. ],
[ 3.0963311, 2. ],
[-1.2692463, 0. ],
[-3.3595495, 0. ],
[ 0.8468886, 1. ]], dtype=float32)
```
which displays that latent draws < `cutpoints[0] = 0.` are category 0, latent
draws between `cutpoints[0] = 0.` and `cutpoints[1] = 1.` are category 1, and
finally latent draws > `cutpoints[1] = 1.` (the final cutpoint in this
example) are the top category of 2.
This distribution can be useful for modelling outcomes which have inherent
ordering but no real numerical values, for example modelling the outcome of a
survey question where the responses are `[bad, mediocre, good]`, which would
be coded as `[0, 1, 2]` and the model would contain two cutpoints (`K = 2`).
#### Mathematical Details
The survival function (s) is:
```none
s(x; c, eta) = P(X > x)
= sigmoid(eta - concat([-inf, c, inf])[x+1])
```
where `loc = eta` is the location of a latent logistic distribution and
`cutpoints = c` define points to split up this latent distribution. The
concatenation of the cutpoints, `concat([-inf, c, inf])`, ensures that `s(K) =
P(X > K) = 0` and `s(-1) = P(X > -1) = 1` which aids in the definition of the
probability mass function (pmf):
```none
pmf(x; c, eta) = P(X > x-1) - P(x > x)
= s(x-1; c, eta) - s(x; c, eta)
```
#### Examples
Create a symmetric 4-class distribution:
```python
import tensorflow_probability as tfp
tfd = tfp.distributions
dist = tfd.OrderedLogistic(cutpoints=[-2., 0., 2.], loc=0.)
dist.categorical_probs()
# ==> array([0.11920293, 0.38079706, 0.3807971 , 0.11920291], dtype=float32)
```
Create a batch of 3 4-class distributions via batching the location of the
underlying latent logistic distribution. Additionally, compared to the above
example, the cutpoints have moved closer together/to zero, thus the
probability of a latent draw falling in the inner two categories has shrunk
for the `loc = 0` case:
```python
dist = tfd.OrderedLogistic(cutpoints=[-1., 0., 1.], loc=[-1., 0., 1.])
dist.categorical_probs()
# ==> array([[0.5 , 0.23105855, 0.1497385 , 0.11920291],
[0.2689414 , 0.23105861, 0.23105855, 0.26894143],
[0.11920293, 0.14973842, 0.23105861, 0.5 ]], dtype=float32)
```
Some further functionallity:
```python
dist = tfd.OrderedLogistic(cutpoints=[-1., 0., 2.], loc=0.)
dist.prob([0, 3])
# ==> array([0.2689414 , 0.11920291], dtype=float32)
dist.log_prob(1)
# ==> -1.4650838
dist.sample(3)
# ==> array([0, 1, 1], dtype=int32)
dist.entropy()
# ==> 1.312902
```
"""
def __init__(
self,
cutpoints,
loc,
dtype=tf.int32,
validate_args=False,
allow_nan_stats=True,
name='OrderedLogistic',
):
"""Initialize Ordered Logistic distributions.
Args:
cutpoints: A floating-point `Tensor` with shape `[B1, ..., Bb, K]` where
`b >= 0` indicates the number of batch dimensions. Each entry is then a
`K`-length vector of cutpoints. The vector of cutpoints should be
non-decreasing, which is only checked if `validate_args=True`.
loc: A floating-point `Tensor` with shape `[B1, ..., Bb]` where `b >=
0` indicates the number of batch dimensions. The entries represent the
mean(s) of the latent logistic distribution(s). Different batch shapes
for `cutpoints` and `loc` are permitted, with the distribution
`batch_shape` being `tf.shape(loc[..., tf.newaxis] -
cutpoints)[:-1]` assuming the subtraction is a valid broadcasting
operation.
dtype: The type of the event samples (default: int32).
validate_args: Python `bool`, default `False`. When `True` distribution
parameters are checked for validity despite possibly degrading runtime
performance. When `False` invalid inputs may silently render incorrect
outputs.
allow_nan_stats: Python `bool`, default `True`. When `True`, statistics
(e.g. mode) use the value "`NaN`" to indicate the result is
undefined. When `False`, an exception is raised if one or more of the
statistic's batch members are undefined.
name: Python `str` name prefixed to Ops created by this class.
"""
parameters = dict(locals())
with tf.name_scope(name) as name:
float_dtype = dtype_util.common_dtype(
[cutpoints, loc],
dtype_hint=tf.float32)
self._cutpoints = tensor_util.convert_nonref_to_tensor(
cutpoints, dtype_hint=float_dtype, name='cutpoints')
self._loc = tensor_util.convert_nonref_to_tensor(
loc, dtype_hint=float_dtype, name='loc')
super(OrderedLogistic, self).__init__(
dtype=dtype,
reparameterization_type=reparameterization.NOT_REPARAMETERIZED,
validate_args=validate_args,
allow_nan_stats=allow_nan_stats,
parameters=parameters,
name=name)
@classmethod
def _parameter_properties(cls, dtype, num_classes=None):
# pylint: disable=g-long-lambda
return dict(
cutpoints=parameter_properties.ParameterProperties(
event_ndims=1,
shape_fn=lambda sample_shape: ps.concat(
[sample_shape, [num_classes]], axis=0),
default_constraining_bijector_fn=lambda: ascending.Ascending()), # pylint:disable=unnecessary-lambda
loc=parameter_properties.ParameterProperties())
# pylint: enable=g-long-lambda
@property
def cutpoints(self):
"""Input argument `cutpoints`."""
return self._cutpoints
@property
def loc(self):
"""Input argument `loc`."""
return self._loc
def categorical_log_probs(self):
"""Log probabilities for the `K+1` ordered categories."""
log_survival = tf.math.log_sigmoid(
self.loc[..., tf.newaxis] - self._augmented_cutpoints())
return generic.log_sub_exp(
log_survival[..., :-1], log_survival[..., 1:])
def categorical_probs(self):
"""Probabilities for the `K+1` ordered categories."""
return tf.math.exp(self.categorical_log_probs())
def _augmented_cutpoints(self):
cutpoints = tf.convert_to_tensor(self.cutpoints)
inf = tf.fill(
ps.shape(cutpoints[..., :1]),
tf.constant(np.inf, dtype=cutpoints.dtype))
return tf.concat([-inf, cutpoints, inf], axis=-1)
def _num_categories(self):
return ps.shape(self.cutpoints, out_type=self.dtype)[-1] + 1
def _sample_n(self, n, seed=None):
return categorical.Categorical(
logits=self.categorical_log_probs(),
dtype=self.dtype).sample(n, seed)
def _event_shape_tensor(self):
return tf.constant([], dtype=tf.int32)
def _event_shape(self):
return tf.TensorShape([])
def _log_prob(self, x):
num_categories = self._num_categories()
num_categories = tf.cast(num_categories, x.dtype)
zero = dtype_util.as_numpy_dtype(x.dtype)(0.)
x_safe = tf.where((x > num_categories - 1) | (x < 0), zero, x)
log_probs = categorical.Categorical(
logits=self.categorical_log_probs()).log_prob(x_safe)
neg_inf = dtype_util.as_numpy_dtype(log_probs.dtype)(-np.inf)
return tf.where((x > num_categories - 1) | (x < 0), neg_inf, log_probs)
def _cdf(self, x):
return categorical.Categorical(logits=self.categorical_log_probs()).cdf(x)
def _entropy(self):
return categorical.Categorical(
logits=self.categorical_log_probs()).entropy()
def _mode(self):
log_probs = self.categorical_log_probs()
mode = tf.cast(tf.argmax(log_probs, axis=-1), self.dtype)
tensorshape_util.set_shape(mode, log_probs.shape[:-1])
return mode
def _default_event_space_bijector(self):
return
def _parameter_control_dependencies(self, is_init):
assertions = []
# In init, we can always build shape and dtype checks because
# we assume shape doesn't change for Variable backed args.
if is_init:
if not dtype_util.is_floating(self.cutpoints.dtype):
raise TypeError('Argument `cutpoints` must having floating type.')
if not dtype_util.is_floating(self.loc.dtype):
raise TypeError('Argument `loc` must having floating type.')
cutpoint_dims = tensorshape_util.rank(self.cutpoints.shape)
msg = 'Argument `cutpoints` must have rank at least 1.'
if cutpoint_dims is not None:
if cutpoint_dims < 1:
raise ValueError(msg)
elif self.validate_args:
cutpoints = tf.convert_to_tensor(self.cutpoints)
assertions.append(
assert_util.assert_rank_at_least(cutpoints, 1, message=msg))
if not self.validate_args:
return []
if is_init != tensor_util.is_ref(self.cutpoints):
cutpoints = tf.convert_to_tensor(self.cutpoints)
assertions.append(distribution_util.assert_nondecreasing(
cutpoints, message='Argument `cutpoints` must be non-decreasing.'))
return assertions
def _sample_control_dependencies(self, x):
assertions = []
if not self.validate_args:
return assertions
assertions.append(distribution_util.assert_casting_closed(
x, target_dtype=tf.int32))
assertions.append(assert_util.assert_non_negative(x))
assertions.append(
assert_util.assert_less_equal(
x, tf.cast(self._num_categories(), x.dtype),
message=('OrderedLogistic samples must be `>= 0` and `<= K` '
'where `K` is the number of cutpoints.')))
return assertions
@kullback_leibler.RegisterKL(OrderedLogistic, OrderedLogistic)
def _kl_ordered_logistic_ordered_logistic(a, b, name=None):
"""Calculate the batched KL divergence KL(a || b), a and b OrderedLogistic.
This function utilises the `OrderedLogistic` `categorical_log_probs` member
function to implement KL divergence for discrete probability distributions as
described in
e.g. [Wikipedia](https://en.wikipedia.org/wiki/Kullback-Leibler_divergence).
Args:
a: instance of a OrderedLogistic distribution object.
b: instance of a OrderedLogistic distribution object.
name: Python `str` name to use for created operations.
Default value: `None` (i.e., `'kl_ordered_logistic_ordered_logistic'`).
Returns:
Batchwise KL(a || b)
"""
with tf.name_scope(name or 'kl_ordered_logistic_ordered_logistic'):
a_log_probs = a.categorical_log_probs()
b_log_probs = b.categorical_log_probs()
return tf.reduce_sum(
tf.math.multiply_no_nan(
a_log_probs - b_log_probs, tf.math.exp(a_log_probs)),
axis=-1)