Skip to content

Commit ed8bfc0

Browse files
committed
Rename data kwarg to observed in Model register_rv
1 parent 1555562 commit ed8bfc0

File tree

3 files changed

+13
-14
lines changed

3 files changed

+13
-14
lines changed

pymc/model.py

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,7 +1257,7 @@ def set_data(
12571257
shared_object.set_value(values)
12581258

12591259
def register_rv(
1260-
self, rv_var, name, data=None, total_size=None, dims=None, transform=UNSET, initval=None
1260+
self, rv_var, name, observed=None, total_size=None, dims=None, transform=UNSET, initval=None
12611261
):
12621262
"""Register an (un)observed random variable with the model.
12631263
@@ -1266,9 +1266,8 @@ def register_rv(
12661266
rv_var: TensorVariable
12671267
name: str
12681268
Intended name for the model variable.
1269-
data: array_like (optional)
1270-
If data is provided, the variable is observed. If None,
1271-
the variable is unobserved.
1269+
observed: array_like (optional)
1270+
Data values for observed variables.
12721271
total_size: scalar
12731272
upscales logp of variable with ``coef = total_size/var.shape[0]``
12741273
dims: tuple
@@ -1295,31 +1294,31 @@ def register_rv(
12951294
if dname not in self.dim_lengths:
12961295
self.add_coord(dname, values=None, length=rv_var.shape[d])
12971296

1298-
if data is None:
1297+
if observed is None:
12991298
self.free_RVs.append(rv_var)
13001299
self.create_value_var(rv_var, transform)
13011300
self.add_random_variable(rv_var, dims)
13021301
self.set_initval(rv_var, initval)
13031302
else:
13041303
if (
1305-
isinstance(data, Variable)
1306-
and not isinstance(data, (GenTensorVariable, Minibatch))
1307-
and data.owner is not None
1304+
isinstance(observed, Variable)
1305+
and not isinstance(observed, (GenTensorVariable, Minibatch))
1306+
and observed.owner is not None
13081307
# The only Aesara operation we allow on observed data is type casting
13091308
# Although we could allow for any graph that does not depend on other RVs
13101309
and not (
1311-
isinstance(data.owner.op, Elemwise)
1312-
and isinstance(data.owner.op.scalar_op, Cast)
1310+
isinstance(observed.owner.op, Elemwise)
1311+
and isinstance(observed.owner.op.scalar_op, Cast)
13131312
)
13141313
):
13151314
raise TypeError(
13161315
"Variables that depend on other nodes cannot be used for observed data."
1317-
f"The data variable was: {data}"
1316+
f"The data variable was: {observed}"
13181317
)
13191318

13201319
# `rv_var` is potentially changed by `make_obs_var`,
13211320
# for example into a new graph for imputation of missing data.
1322-
rv_var = self.make_obs_var(rv_var, data, dims, transform)
1321+
rv_var = self.make_obs_var(rv_var, observed, dims, transform)
13231322

13241323
return rv_var
13251324

pymc/tests/test_model.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1445,7 +1445,7 @@ def test_tag_future_warning_model():
14451445
assert y is not x
14461446
assert y.tag is not x.tag
14471447
assert isinstance(y.tag, _FutureWarningValidatingScratchpad)
1448-
y = model.register_rv(y, name="y", data=5)
1448+
y = model.register_rv(y, name="y", observed=5)
14491449
assert isinstance(y.tag, _FutureWarningValidatingScratchpad)
14501450

14511451
# Test expected warnings

pymc/tests/test_model_graph.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ def model_non_random_variable_rvs():
247247

248248
z_raw = pm.Normal.dist(y, shape=(5,))
249249
z = pm.math.clip(z_raw, -1, 1)
250-
model.register_rv(z, name="z", data=[0] * 5)
250+
model.register_rv(z, name="z", observed=[0] * 5)
251251

252252
compute_graph = {
253253
"mu": set(),

0 commit comments

Comments
 (0)