Render deterministic functions

[r3v1]

Addresses #3134 and pull request #3259.

[eb8680]

@r3v1 thanks for doing this! I left some comments requesting changes below. Can you also add the unit tests from #3259?

[eb8680]

Can you revert this change, since it's independent of the main goal of this PR? You're welcome to open a separate issue or PR with suggested changes to rendering settings like this one.

[r3v1]

Yes, but as I define rv_label in the if clause, it should also be defined in the else clause. Otherwise, it will be undefined

[eb8680]

You can just revert to using rv, once you revert this chance there's no need for rv_label.

[eb8680]

@r3v1 looks like this change did not get reverted

[eb8680]

@r3v1 can you also run make format and fix any remaining errors raised by make lint to appease the linter and make CI run unit tests?

[eb8680]

@r3v1 can you add a unit test like test_get_model_relations from #3259 that exercises your new functionality, and can you also add a quick example at the end of the model rendering tutorial to demonstrate how to use it?

For the example, you can just copy the model that's already defined in the "Rendering the parameters" section and add a couple of new deterministic variables, e.g.:

def model_deterministic(data):
    sigma = pyro.param("sigma", torch.tensor([1.]), constraint=constraints.positive)
    mu = pyro.param("mu", torch.tensor([0.]))
    x = pyro.sample("x", dist.Normal(mu, sigma))
    log_y = pyro.sample("y", dist.Normal(x, 1))
    y = pyro.deterministic("y", log_y.exp())
    with pyro.plate("N", len(data)):
        eps_z_loc = pyro.sample("eps_z_loc", dist.Normal(0, 1))
        z_loc = pyro.deterministic("z_loc", eps_z_loc + x, event_dim=0)
        pyro.sample("z", dist.Normal(z_loc, y), obs=data)

data = torch.ones(10)
pyro.render_model(
    model_deterministic,
    model_args=(data,),
    render_params=True,
    render_distributions=True,
    render_deterministic=True
)

[eb8680]

@r3v1 looks like this change did not get reverted

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[r3v1]

As suggested earlier, rv_label = rv.replace("$params", "") is necessary to correctly render the graphs:

Without it:

And with it:

Do I push the change?

[eb8680]

Do I push the change?

Sorry, I think there was a problem with the diff I was looking at on GitHub. I was specifically requesting the removal of the .replace("$params", "") method call, which I now see you actually did already. The most recent commit as of this review produces the second of your two figures, right?

Other than a couple minor comments I left below, I think this is good to go as a first PR assuming tests pass since it retains the current dev behavior of get_dependencies and render_model as the default. We can change that behavior in a followup PR.

[r3v1]

Do I push the change?

Sorry, I think there was a problem with the diff I was looking at on GitHub. I was specifically requesting the removal of the .replace("$params", "") method call, which I now see you actually did already. The most recent commit as of this review produces the second of your two figures, right?

The most recent commit 6fbb58c produces the first picture, so I'm pushing the fix along the other suggestions in the next commit.

[eb8680]

LGTM, outstanding issues can be addressed in followup PRs. Thanks again for taking this on!

[r3v1]

Hi @eb8680, do you plan to make a new release with this change?

[eb8680]

@r3v1 yes, we'll do a minor release sometime soon. In the meantime you can follow the instructions from the README to install the dev branch, where this PR landed: https://github.com/pyro-ppl/pyro#installing-pyro-dev-branch