Skip to main content

JAX/Flax implementation of softclip

Project description

softclip

Simple JAX implementation of softclip, inspired by tensorflow probability

softclip is a differentiable bijector from the real number space to some interval. This is useful when you want to optimize a parameter that is assumed to be inside the interval [low, high].

Installation

softclip can be installed with pip directly from GitHub, with the following command:

pip install git+https://github.com/yonesuke/softclip.git

QuickStart

The forward method is the function from the real number space to the interval [low, high]. The inverse method is the function from the interval [low, high] to the real number space, and is the inverse function of forward.

from softclip import SoftClip

bij = SoftClip(low=1.0, high=3.0, hinge_softness=0.5)
y = bij.forward(2.0) # y = 2.9640274
bij.inverse(y) # 1.9999975 ≒ 2.0

Simply set low=0.0 or high=0.0 to create a bijector to a positive/negative number domain.

bij_positive = SoftClip(low=0.0)
bij_negative = SoftClip(high=0.0)

By transforming softclip to distrax with to_distrax, you can create distrax bijectors:

bij_distrax = bij.to_distrax()

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

softclip-0.1.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

softclip-0.1.0-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file softclip-0.1.0.tar.gz.

File metadata

  • Download URL: softclip-0.1.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for softclip-0.1.0.tar.gz
Algorithm Hash digest
SHA256 145f05163abc33cd6a8959100831278e1640378bfe21f2cef5901c2a255cd896
MD5 cabc7334bbe8c47b808339d798848465
BLAKE2b-256 1d78a00f0517f0e3424aa91f921d377ac8d923fbf84de122466e5e1ea668fe85

See more details on using hashes here.

File details

Details for the file softclip-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: softclip-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for softclip-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e5a5f0bee9556d44b9eafdbc89d92dd9aa1445616cbee3ddd6b163dad005b011
MD5 d1f75d4c002a5d6203240310072a9e6a
BLAKE2b-256 47c77c5a501499708821b18c03657b6ce432ccf25a669c7c3077172985fe1d97

See more details on using hashes here.

Supported by

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