Merge pull request #56 from danielward27/docs

Docs
danielward27 · Dec 20, 2022 · fa7dee2 · fa7dee2
2 parents 25788ef + 37304c1
commit fa7dee2
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,10 @@
 ## FlowJax: Normalising Flows in Jax
 -------
 
+## Documentation
+Available [here](https://danielward27.github.io/flowjax/distributions.html).
+
+## Short example
 Training a flow can be done in a few lines of code:
 
 ```
@@ -32,7 +36,6 @@ The package currently supports the following:
 - `BlockNeuralAutoregressiveFlow`, as introduced by [De Cao et al., 2019](https://arxiv.org/abs/1904.04676)
 - `TriangularSplineFlow`, introduced here.
 
-For examples of basic usage, see [examples](https://github.com/danielward27/flowjax/blob/main/examples/).
 
 ## Installation
 ```

diff --git a/docs/conf.py b/docs/conf.py
@@ -12,7 +12,7 @@
 project = 'FlowJax'
 copyright = '2022, Daniel Ward'
 author = 'Daniel Ward'
-release = 'v6.0.0'
+release = 'v6.1.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/flowjax/__init__.py b/flowjax/__init__.py
@@ -1,5 +1,5 @@
 """flowjax - Basic flowjax implementation in jax."""
 
-__version__ = "6.0.0"
+__version__ = "6.1.0"
 __author__ = "Daniel Ward <danielward27@outlook.com>"
 __all__ = []
diff --git a/flowjax/bijections/abc.py b/flowjax/bijections/abc.py
@@ -16,12 +16,15 @@
 
 from flowjax.transformers import Transformer as _Transformer
 
-def Transformer(*args, **kwargs):
-    warnings.warn(
-    "Please use flowjax.transformers.Transformer.",
-    DeprecationWarning, stacklevel=2)
-    return _Transformer(*args, **kwargs)
-
+
+class Transformer(_Transformer):
+    def __init__(self, *args, **kwargs) -> None:
+        "Deprecated location of transfomer, use flowjax.transformers.Transformer instead."
+        warnings.warn(
+            "Please use flowjax.transformers.Transformer.",
+            DeprecationWarning, stacklevel=2)
+        super().__init__(*args, **kwargs)
+
 
 class Bijection(ABC, Module):
     """Basic bijection class. All bijections should support conditioning variables

diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@ def read(filename):
 
 setup(
     name="flowjax",
-    version="6.0.0",
+    version="6.1.0",
     url="https://github.com/danielward27/flowjax.git",
     license="MIT",
     author="Daniel Ward",