Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CategoricalMADE #1269

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

jnsbck
Copy link
Contributor

@jnsbck jnsbck commented Sep 5, 2024

What does this implement/fix? Explain your changes

This implements a CategoricalMADE to generelize MNLE to multiple discrete dimensions addressing #1112.
Essentially adapts nflows's MixtureofGaussiansMADE to autoregressively model categorical distributions.

Does this close any currently open issues?

Fixes #1112

Comments

I have already discussed this with @michaeldeistler.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

  • I have read and understood the contribution
    guidelines
  • I agree with re-licensing my contribution from AGPLv3 to Apache-2.0.
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works
  • I have reported how long the new tests run and potentially marked them
    with pytest.mark.slow.
  • New and existing unit tests pass locally with my changes
  • I performed linting and formatting as described in the contribution
    guidelines
  • I rebased on main (or there are no conflicts with main)
  • For reviewer: The continuous deployment (CD) workflow are passing.

Copy link

codecov bot commented Sep 5, 2024

Codecov Report

Attention: Patch coverage is 37.89474% with 59 lines in your changes missing coverage. Please review.

Project coverage is 78.02%. Comparing base (8afd985) to head (0188cea).
Report is 32 commits behind head on main.

Files with missing lines Patch % Lines
sbi/neural_nets/estimators/categorical_net.py 22.22% 42 Missing ⚠️
sbi/neural_nets/net_builders/categorial.py 33.33% 14 Missing ⚠️
sbi/neural_nets/net_builders/mnle.py 76.92% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1269      +/-   ##
==========================================
- Coverage   86.05%   78.02%   -8.04%     
==========================================
  Files         118      118              
  Lines        8672     8791     +119     
==========================================
- Hits         7463     6859     -604     
- Misses       1209     1932     +723     
Flag Coverage Δ
unittests 78.02% <37.89%> (-8.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
sbi/neural_nets/estimators/__init__.py 100.00% <100.00%> (ø)
.../neural_nets/estimators/mixed_density_estimator.py 98.24% <100.00%> (+0.13%) ⬆️
sbi/neural_nets/net_builders/mnle.py 91.17% <76.92%> (-8.83%) ⬇️
sbi/neural_nets/net_builders/categorial.py 58.33% <33.33%> (-36.41%) ⬇️
sbi/neural_nets/estimators/categorical_net.py 56.56% <22.22%> (-41.27%) ⬇️

... and 36 files with indirect coverage changes

@jnsbck
Copy link
Contributor Author

jnsbck commented Sep 16, 2024

Hey @janfb,
would very much appreciate your input at this stage:

Currently the PR adds the CategoricalMADE and builder build_autoregressive_categoricalestimator + some minor modifications to build_mnle and MixedDensityEstimator. This enables multiple discrete variables with different numbers of classes via trainer = MNLE(density_estimator=lambda x,y: build_mnle(y,x,categorical_model="made")) Note that for some reason x and y have to be flipped for mnle.

As far as I can tell all functionalities of CategoricalMADE work for both 1D and ND inputs and running the Example_01_DecisionMakingModel.ipynb with the CatMADE matches the ground truth
image

The question now is: How should I verify this works? / Which tests should I add/modify? Do you have an idea for a good toy example with several discrete variables that I could use?

I have cooked up a toy simulator, for which I am getting good posteriors using SNPE, but for some reason MNLE raises a RuntimeError: probability tensor contains either 'inf', 'nan' or element < 0 Even for the unmodified MNLE. Any ideas why this could be?

This is the simulator

def toy_simulator(theta: torch.Tensor, centers: list[torch.Tensor]) -> torch.Tensor:
    batch_size, n_dimensions = theta.shape
    assert len(centers) == n_dimensions, "Number of center sets must match theta dimensions"
    
    # Calculate discrete classes by assiging to the closest center
    x_disc = torch.stack([
        torch.argmin(torch.abs(centers[i].unsqueeze(1) - theta[:, i].unsqueeze(0)), dim=0)
        for i in range(n_dimensions)
    ], dim=1)

    closest_centers = torch.stack([centers[i][x_disc[:, i]] for i in range(n_dimensions)], dim=1)
    # Add Gaussian noise to assigned class centers
    std = 0.4
    x_cont = closest_centers + std * torch.randn_like(closest_centers)
       
    return torch.cat([x_cont, x_disc], dim=1)

The setup:

torch.random.manual_seed(0)
centers = [
    torch.tensor([-0.5, 0.5]),
    # torch.tensor([-1.0, 0.0, 1.0]),
]

prior = BoxUniform(low=torch.tensor([-2.0]*len(centers)), high=torch.tensor([2.0]*len(centers)))
theta = prior.sample((20000,))
x = toy_simulator(theta, centers)

theta_o = prior.sample((1,))
x_o = toy_simulator(theta_o, centers)

NPE:

trainer = SNPE()
estimator = trainer.append_simulations(theta=theta, x=x).train(training_batch_size=1000)

snpe_posterior = trainer.build_posterior(prior=prior)
posterior_samples = snpe_posterior.sample((2000,), x=x_o)
pairplot(posterior_samples, limits=[[-2, 2], [-2, 2]], figsize=(5, 5), points=theta_o)

and the equivalent MNLE:

trainer = MNLE()
estimator = trainer.append_simulations(theta=theta, x=x).train(training_batch_size=1000)

mnle_posterior = trainer.build_posterior(prior=prior)
mnle_samples = mnle_posterior.sample((10000,), x=x_o)
pairplot(mnle_samples, limits=[[-2, 2], [-2, 2]], figsize=(5, 5), points=theta_o)

Hoping this makes sense. Lemme know if you need clarifications anywhere. Thanks for your feedback.

@jnsbck
Copy link
Contributor Author

jnsbck commented Oct 22, 2024

Hey @janfb,
you might have missed this, but I would be happy about feedback :)

Copy link
Contributor

@janfb janfb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks a lot for tackling this @jnsbck! 👏

Please find below some comments and questions.
There might be some misunderstanding about variables and categories on my side. We can have a call if that's more efficient than commenting here.

sbi/neural_nets/estimators/categorical_net.py Show resolved Hide resolved
sbi/neural_nets/estimators/categorical_net.py Outdated Show resolved Hide resolved
sbi/neural_nets/estimators/categorical_net.py Outdated Show resolved Hide resolved
sbi/neural_nets/estimators/categorical_net.py Show resolved Hide resolved
sbi/neural_nets/estimators/categorical_net.py Outdated Show resolved Hide resolved
sbi/neural_nets/estimators/categorical_net.py Outdated Show resolved Hide resolved
sbi/neural_nets/net_builders/mnle.py Outdated Show resolved Hide resolved
sbi/neural_nets/net_builders/mnle.py Show resolved Hide resolved
Comment on lines +164 to +174
elif categorical_model == "mlp":
assert num_disc == 1, "MLP only supports 1D input."
discrete_net = build_categoricalmassestimator(
disc_x,
batch_y,
z_score_x="none", # discrete data should not be z-scored.
z_score_y="none", # y-embedding net already z-scores.
num_hidden=hidden_features,
num_layers=hidden_layers,
embedding_net=embedding_net,
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

more generally, isn't the MLP a special case of the MADE? can't we absorb them into one class?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment: Check if testcase is identical, if yes -> rm MLP

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should eventually be integrated with the MNLE tutorial in 12_iid_data_and_permutation_invariant_embeddings.ipynb

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change "mlp" to "made" and comment that several variables with different num_categories are supported.

@jnsbck
Copy link
Contributor Author

jnsbck commented Nov 4, 2024

Cool, thanks for all the feedback! A quick call would be great, also to discuss suitable tests for this. Will reach out via email and tackle the straight forward things in the meantime.


# outputs (batch_size, num_variables, num_categories)
def log_prob(self, inputs, context=None):
outputs = self.forward(inputs, context=context)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these shapes correct?

@jnsbck
Copy link
Contributor Author

jnsbck commented Nov 14, 2024

After discussion with @janfb I will:

  1. adapt the simulator of Example_01_DecisionMakingModel.ipynb to multiple discrete variables.
  2. Get this to run for 1D and ND
  3. fix remaining comments/issues
  4. possibly refactor (fold 1D into ND code).

@janfb could you still check tho what is up with the simulator above? Do you have a hunch why the SNPE and MNLE posteriors different?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change MixedDensityEstimator to AutoregressiveMixedDensityEstimator
2 participants