This aims to shift the design of the package closer to the recommendations here. In doing so, we introduce some breaking changes.
Here is a list of breaking changes:
Distribution and Bijection have been renamed to AbstractDistribution and AbstractBijection respectively. Typehints for distributions and bijections should update to use these.
Custom untransformed distributions should now subtype AbstractStandardDistribution, and explicitly list the shape and cond_shape attributes.
Custom transformed distributions should subtype AbstractTransformed. The shape and cond_shape attributes of AbstractTransformed are now defined as properties on the class (inferred from the base_dist and bijection), so they no longer need to be defined.
Custom bijection implementations must subtype AbstractBijection and explicitly list the shape and cond_shape attributes.
Batch bijection has been removed for now in favour of Vmap.
TanhLinearTails has been renamed to LeakyTanh.
RationalQuadraticSpline no longer has a shape argument, and instead has the default shape of (), and batch dimensions should be constructed using Vmap.
Flows no longer contain the string attribute permute_strategy.
This aims to shift the design of the package closer to the recommendations here. In doing so, we introduce some breaking changes.
Here is a list of breaking changes:
DistributionandBijectionhave been renamed toAbstractDistributionandAbstractBijectionrespectively. Typehints for distributions and bijections should update to use these.AbstractStandardDistribution, and explicitly list theshapeandcond_shapeattributes.AbstractTransformed. Theshapeandcond_shapeattributes ofAbstractTransformedare now defined as properties on the class (inferred from thebase_distandbijection), so they no longer need to be defined.AbstractBijectionand explicitly list theshapeandcond_shapeattributes.Batchbijection has been removed for now in favour ofVmap.TanhLinearTailshas been renamed toLeakyTanh.RationalQuadraticSplineno longer has ashapeargument, and instead has the default shape of(), and batch dimensions should be constructed usingVmap.permute_strategy.