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 continuous nature of deep learning optimization, the usage of truly discrete random variables is infeasible. Thus we use different relaxation methods. 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/relaxit

Install via Git clone

git clone https://github.com/intsystems/relaxit
cd relaxit
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.

[^*]: We also implement REINFORCE algorithm as a score function estimator alternative for our relaxation methods that are inherently pathwise derivative estimators. This one is implemented only for demo experiments and is not included into the source code of package.

📚 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.1.2.tar.gz (14.5 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.1.2-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: relaxit-1.1.2.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for relaxit-1.1.2.tar.gz
Algorithm Hash digest
SHA256 c625a03054decbdcf1824128a1621980cca32b70aa73d57d42131d1c69434f89
MD5 2b3ac60f25c158e90add53b2322d4a02
BLAKE2b-256 3a99fbfbee1c13895c4df2fe001d4c8e00e0aeacf97479154d3f6695def9fb6e

See more details on using hashes here.

Provenance

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

Publisher: pypi.yml on intsystems/relaxit

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.1.2-py3-none-any.whl.

File metadata

  • Download URL: relaxit-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for relaxit-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 05cf8f3a3c6a6bae54581e3ed0254ba3d9b91ccbdb0e700e9875a0579b1c626a
MD5 8744d8c84dac325ca2aec86b3c66bc6c
BLAKE2b-256 ab20700d50ff9adc1b20c16f0d21b60c32d132995f289c9cddcf57b8d1397cae

See more details on using hashes here.

Provenance

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

Publisher: pypi.yml on intsystems/relaxit

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