Skip to main content

A Python library for discrete variables relaxation

Project description

Just Relax It

Discrete Variables Relaxation

Compatible with PyTorch Inspired by Pyro

Coverage_2 Coverage Docs

License GitHub Contributors Issues GitHub Pull Requests

"Just Relax It" is a cutting-edge Python library designed to streamline the optimization of discrete probability distributions in neural networks, offering a suite of advanced relaxation techniques compatible with PyTorch.

📬 Assets

  1. Technical Meeting 1 - Presentation
  2. Technical Meeting 2 - Jupyter Notebook
  3. Technical Meeting 3 - Jupyter Notebook
  4. Blog Post
  5. Documentation
  6. Tests

💡 Motivation

For lots of mathematical problems we need an ability to sample discrete random variables. The problem is that due to continuos nature of deep learning optimization, the usage of truely discrete random variables is infeasible. Thus we use different relaxation method. One of them, Concrete distribution or Gumbel-Softmax (this is one distribution proposed in parallel by two research groups) is implemented in different DL packages. In this project we implement different alternatives to it.

🗃 Algorithms

🛠️ Install

Install using pip

pip install relaxit

Install from source

pip install git+https://github.com/intsystems/discrete-variables-relaxation

Install via Git clone

git clone https://github.com/intsystems/discrete-variables-relaxation
cd discrete-variables-relaxation
pip install -e .

🚀 Quickstart

Open In Colab

import torch
from relaxit.distributions import InvertibleGaussian

# initialize distribution parameters
loc = torch.zeros(3, 4, 5, requires_grad=True)
scale = torch.ones(3, 4, 5, requires_grad=True)
temperature = torch.tensor([1e-0])

# initialize distribution
distribution = InvertibleGaussian(loc, scale, temperature)

# sample with reparameterization
sample = distribution.rsample()
print('sample.shape:', sample.shape)
print('sample.requires_grad:', sample.requires_grad)

🎮 Demo

Laplace Bridge REINFORCE in Acrobot environment VAE with discrete latents
Laplace Bridge REINFORCE VAE
Open In Colab Open In Colab Open In Colab

For demonstration purposes, we divide our algorithms in three different groups. Each group relates to the particular demo code:

We describe our demo experiments here.

📚 Stack

Some of the alternatives for GS were implemented in pyro, so we base our library on their codebase.

🧩 Some details

To make to library consistent, we integrate imports of distributions from pyro and torch into the library, so that all the categorical distributions can be imported from one entrypoint.

👥 Contributors

  • Daniil Dorin (Basic code writing, Final demo, Algorithms)
  • Igor Ignashin (Project wrapping, Documentation writing, Algorithms)
  • Nikita Kiselev (Project planning, Blog post, Algorithms)
  • Andrey Veprikov (Tests writing, Documentation writing, Algorithms)
  • You are welcome to contribute to our project!

🔗 Useful links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

relaxit-1.0.1.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

relaxit-1.0.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file relaxit-1.0.1.tar.gz.

File metadata

  • Download URL: relaxit-1.0.1.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for relaxit-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f4af8ec69f2df195e555373f5655d17b495853ddde60c87c0ef6e43c8ee36ee1
MD5 3b83e0ae15edf5ddd5606dc5cb329f72
BLAKE2b-256 2ae04b29e9341e54d09ca3edc892e5cd1cf5f6ebeac2d9ac908f17baba231aba

See more details on using hashes here.

Provenance

The following attestation bundles were made for relaxit-1.0.1.tar.gz:

Publisher: pypi.yml on intsystems/discrete-variables-relaxation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file relaxit-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: relaxit-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for relaxit-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4ad6e7ce6bbbb36af848547356720ff28ec1ad6cb9820fb144b17153d9e4cc94
MD5 35366edccb89f4f851ff41b54aaffc62
BLAKE2b-256 f961e58295bbc5c8ff16a1420c7a35531e7ca52b39a418e898931966de4e1ea7

See more details on using hashes here.

Provenance

The following attestation bundles were made for relaxit-1.0.1-py3-none-any.whl:

Publisher: pypi.yml on intsystems/discrete-variables-relaxation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page