ProbabilisticDiffusion
This is a PyTorch implementation of the training algorithm found in Denoising Diffusion Probabilistic Models.
Specifically, we implement the following training procedure:
Where $\epsilon_\theta$ represents the user defined model with learnable parameters $\theta$.
Installation
pip install:
pip install ProbabilisticDiffusion
For any additional needs, sdist and bdist can be found in the GitHub repo.
Usage
The data we use for the below examples is a set of randomly generated points points lying on a circle of radius 2 and added i.i.d gaussian noise with SD of 0.3 to x and y axes:
The Jupyter Notebook with this example can be found on GitHub here.
Defining Model
Defining $\epsilon_\theta$
Below we define our model with the parameters we would like to learn. In this case we use a simple architecture with a combination of PyTorch Linear layers with Softplus activations, as well as an embedding to take into account the timestep, $t$, which we also include in the input (the y value).
import torch.nn as nn
import torch.nn.functional as F
class ConditionalLinear(nn.Module):
def __init__(self, num_in, num_out, n_steps):
super(ConditionalLinear, self).__init__()
self.num_out = num_out
self.lin = nn.Linear(num_in, num_out)
self.embed = nn.Embedding(n_steps, num_out)
self.embed.weight.data.uniform_()
def forward(self, x, y):
out = self.lin(x)
gamma = self.embed(y)
out = gamma.view(-1, self.num_out) * out
return out
class ConditionalModel(nn.Module):
def __init__(self, n_steps):
super(ConditionalModel, self).__init__()
self.lin1 = ConditionalLinear(2, 128, n_steps)
self.lin2 = ConditionalLinear(128, 128, n_steps)
self.lin3 = nn.Linear(128, 2)
def forward(self, x, y):
x = F.softplus(self.lin1(x, y))
x = F.softplus(self.lin2(x, y))
return self.lin3(x)
In version 2.1.0 we can also specify models which are conditioned on additional variables that are not present in the
final output generation, i.e. generating $x_t$ from $p(x_t|c)$ instead of just $p(x_t)$. This change manifests itself in
the model by taking an extra input value in the forward method of the ConditionalModel:
class ConditionalModel(nn.Module):
def __init__(self, n_steps):
super(ConditionalModel, self).__init__()
self.lin1 = ConditionalLinear(2 + shape_of_c, 128, n_steps) # Make sure to add dimension of c to input dim
...
def forward(self, x, c, y):
x = torch.cat([x, c], 1) # Here, we just concatenate the conditional variable
x = F.softplus(self.lin1(x, y))
...
Defining Diffusion Based Learning Model
We define our diffusion based model with 200 timesteps, MSE loss (although the original algorithm specifies just SSE but we found that MSE works as well), beta start and end values of 1e-5, 1e-2 respectively with a linear schedule, and use the ADAM optimizer with a learning rate of 1e-3.
from ProbabilisticDiffusion import Diffusion
import torch
n_steps = 200
model = ConditionalModel(n_steps)
loss = torch.nn.MSELoss(
reduction='mean') # We use MSE for the loss which adheres to the gradient step procedure defined
optimizer = torch.optim.Adam(model.parameters(), lr=1e-3) # ADAM Optimizer Parameters for learning
diffusion = Diffusion(data, n_steps, 1e-5, 1e-2, 'linear', model, loss,
optimizer) # Note the (1e-5, 1e-2) are Beta start and end values
In version 2.1.0 we can now also include conditional data in the construction of Diffusion:
diffusion = Diffusion(data, n_steps, 1e-5, 1e-2, 'linear', model, loss,
optimizer, conditional_data) # Note the additional conditional_data argument after optimizer
Forward Sampling
This allows us to see the forward diffusion process and ensure that our n_steps parameter is large enough. We want to see the data morph into standard gaussian distributed points by the last time step.
import scipy.stats as stats
noised = diffusion.forward(199, s=5)
stats.probplot(noised[:, 0], dist="norm", plot=plt)
plt.show()
Training
We train with batch size of 1,000 for 10,000 epochs.
diffusion.train(1000, 10000)
Sampling New Data
We can sample new data based on the learned model via the following method:
new_x = diffusion.sample(1000, 50, keep="last", s=3)
If using the conditional model capabilities added in version 2.1.0, make sure to pass in the conditional data you
would like to sample upon. This data needs to have a length of the number of samples you wish to generate, n, and have
the same dimensionality as the conditional data you passed in when constructing the initial Diffusion model:
# the input to conditional_data in this example should have a length of 1000 since we set the new sample size to 1000
new_x = diffusion.sample(1000, 50, keep="last", conditional_data=c, s=3)
This method generated 1000 new samples and plotted at an interval of 50. In addition, we can specify which points to keep from these new samples, 'last' will only keep the last timestep of samples, 'all', will keep all timesteps, and for more granularity, one can specify a tuple of integer values corresponding to the desired timesteps to keep.
Metadata
Release files for ProbabilisticDiffusion 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| probabilisticdiffusion-2.1.0.tar.gz | 7.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| probabilisticdiffusion-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.0 kB
Release files / probabilisticdiffusion-2.1.0.tar.gz
| Download URL | probabilisticdiffusion-2.1.0.tar.gz |
|---|---|
| Size | 7.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
437a8dfc582288a085d45a126e50d45144dda2a9b94c13b3d178eaaaca24a5ac
|
|
BLAKE2b-256 checksum How to use checksums |
8ed679965a08e7b460cd150d1b344baf51d7cc5c17b7c9bb070b9c4a49ab3d01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / probabilisticdiffusion-2.1.0-py3-none-any.whl
| Download URL | probabilisticdiffusion-2.1.0-py3-none-any.whl |
|---|---|
| Size | 7.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0a4fc0087e9a1ab39a4a09926957ccc7070ae1e4afac0f50664e776b27ff2d21
|
|
BLAKE2b-256 checksum How to use checksums |
79ef8bb08c5ddafd97860146c3f3b76f99e206ca0fddf2958438bb9de0648c67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for ProbabilisticDiffusion 2.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.