flowMC 0.4.2__tar.gz → 0.4.4__tar.gz

{flowmc-0.4.2 → flowmc-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowMC
-Version: 0.4.2
+Version: 0.4.4
 Summary: Normalizing flow exhanced sampler in jax
 Project-URL: Documentation, https://github.com/kazewong/flowMC
 Author: Marylou Gabrié, Dan Foreman-Mackey
@@ -28,19 +28,30 @@ License: MIT License
         SOFTWARE.
 License-File: LICENSE
 Keywords: autodiff,inference,jax,machine learning,normalizing,sampling
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.11
 Requires-Dist: chex>=0.1.87
-Requires-Dist: coveralls>=4.0.1
 Requires-Dist: equinox>=0.11.9
-Requires-Dist: jax[cuda12]==0.5.0
+Requires-Dist: jax[cpu]>=0.5.0
 Requires-Dist: jaxtyping>=0.2.36
 Requires-Dist: optax>=0.2.4
-Requires-Dist: pre-commit==4.0.1
-Requires-Dist: pyright==1.1.389
-Requires-Dist: pytest==8.3.3
-Requires-Dist: ruff==0.8.0
 Requires-Dist: scikit-learn>=1.6.0
 Requires-Dist: tqdm>=4.67.1
+Provides-Extra: codeqa
+Requires-Dist: coveralls>=4.0.1; extra == 'codeqa'
+Requires-Dist: pre-commit>=4.0.1; extra == 'codeqa'
+Requires-Dist: pyright>=1.1.389; extra == 'codeqa'
+Requires-Dist: pytest>=8.3.3; extra == 'codeqa'
+Requires-Dist: ruff>=0.8.0; extra == 'codeqa'
+Provides-Extra: cuda
+Requires-Dist: jax[cuda12]>=0.5.0; extra == 'cuda'
 Provides-Extra: docs
 Requires-Dist: mkdocs-gen-files==0.5.0; extra == 'docs'
 Requires-Dist: mkdocs-jupyter==0.25.1; extra == 'docs'
@@ -52,6 +63,7 @@ Requires-Dist: pymdown-extensions==10.12; extra == 'docs'
 Provides-Extra: visualize
 Requires-Dist: arviz>=0.21.0; extra == 'visualize'
 Requires-Dist: corner>=2.2.3; extra == 'visualize'
+Requires-Dist: matplotlib>=3.9.3; extra == 'visualize'
 Description-Content-Type: text/markdown
 
 # flowMC
@@ -90,12 +102,10 @@ pip install flowMC
 This will install the latest stable release and its dependencies.
 flowMC is based on [Jax](https://github.com/google/jax) and [Equinox](https://github.com/patrick-kidger/equinox).
 By default, installing flowMC will automatically install Jax and Equinox available on [PyPI](https://pypi.org).
-Jax does not install GPU support by default.
-If you want to use GPU with Jax, you need to install Jax with GPU support according to their document.
-At the time of writing this documentation page, this is the command to install Jax with GPU support:
+By default this install the CPU version of Jax. If you have a GPU and want to use it, you can install the GPU version of Jax by running:
 
 ```
-pip install --upgrade "jax[cuda12_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
+pip install flowMC[cuda]
 ```
 
 If you want to install the latest version of flowMC, you can clone this repo and install it locally:
@@ -106,23 +116,12 @@ cd flowMC
 pip install -e .
 ```
 
-## Requirements
-
-Here is a list of packages we use in the main library
-
-    * Python 3.9+
-    * Jax
-    * Jaxlib
-    * equinox
-
-To visualize the inference results in the examples, we requrie the following packages in addtion to the above:
-
-    * matplotlib
-    * corner
-    * arviz
-
-The test suite is based on pytest. To run the tests, one needs to install `pytest` and run `pytest` at the root directory of this repo.
+There are a couple more extras that you can install with flowMC, including:
+- `flowMC[docs]`: Install the documentation dependencies.
+- `flowMC[codeqa]`: Install the code quality dependencies.
+- `flowMC[visualize]`: Install the visualization dependencies.
 
+On top of `pip` installation, we highly encourage you to use [uv](https://docs.astral.sh/uv/) to manage your python environment. Once you clone the repo, you can run `uv sync` to create a virtual environment with all the dependencies installed.
 # Attribution
 
 If you used `flowMC` in your research, we would really appericiate it if you could at least cite the following papers:

{flowmc-0.4.2 → flowmc-0.4.4}/README.md

@@ -34,12 +34,10 @@ pip install flowMC
 This will install the latest stable release and its dependencies.
 flowMC is based on [Jax](https://github.com/google/jax) and [Equinox](https://github.com/patrick-kidger/equinox).
 By default, installing flowMC will automatically install Jax and Equinox available on [PyPI](https://pypi.org).
-Jax does not install GPU support by default.
-If you want to use GPU with Jax, you need to install Jax with GPU support according to their document.
-At the time of writing this documentation page, this is the command to install Jax with GPU support:
+By default this install the CPU version of Jax. If you have a GPU and want to use it, you can install the GPU version of Jax by running:
 
 ```
-pip install --upgrade "jax[cuda12_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
+pip install flowMC[cuda]
 ```
 
 If you want to install the latest version of flowMC, you can clone this repo and install it locally:
@@ -50,23 +48,12 @@ cd flowMC
 pip install -e .
 ```
 
-## Requirements
-
-Here is a list of packages we use in the main library
-
-    * Python 3.9+
-    * Jax
-    * Jaxlib
-    * equinox
-
-To visualize the inference results in the examples, we requrie the following packages in addtion to the above:
-
-    * matplotlib
-    * corner
-    * arviz
-
-The test suite is based on pytest. To run the tests, one needs to install `pytest` and run `pytest` at the root directory of this repo.
+There are a couple more extras that you can install with flowMC, including:
+- `flowMC[docs]`: Install the documentation dependencies.
+- `flowMC[codeqa]`: Install the code quality dependencies.
+- `flowMC[visualize]`: Install the visualization dependencies.
 
+On top of `pip` installation, we highly encourage you to use [uv](https://docs.astral.sh/uv/) to manage your python environment. Once you clone the repo, you can run `uv sync` to create a virtual environment with all the dependencies installed.
 # Attribution
 
 If you used `flowMC` in your research, we would really appericiate it if you could at least cite the following papers:

{flowmc-0.4.2 → flowmc-0.4.4}/docs/quickstart.md

@@ -47,7 +47,7 @@ To sample an N dimensional Gaussian, you would do something like:
 import jax
 import jax.numpy as jnp
 from flowMC.Sampler import Sampler
-from flowMC.resource_strategy_bundles import RQSpline_MALA_Bundle
+from flowMC.resource_strategy_bundle.RQSpline_MALA import RQSpline_MALA_Bundle
 
 # Defining the log posterior