Merge pull request #45 from google:20240522-fsaad-versions

PiperOrigin-RevId: 636551772

README.md

@@ -40,15 +40,37 @@ doi     = {10.48550/arXiv.2403.07657},
 ([PyPI](https://pypi.org/project/bayesnf/)) using:
 
 ```
-python -m pip install bayesnf
+$ python -m pip install bayesnf
 ```
 
-The typical install time is 1 minute. This software is tested on Python 3.11
+The typical install time is 1 minute. This software is tested on Python 3.10
 with a standard Debian GNU/Linux setup. The large-scale experiments in
 `scripts/` were run using [TPU v3-8 accelerators](https://cloud.google.com/tpu/docs/supported-tpu-configurations#tpu-v3-config).
 To run BayesNF locally on medium to large-scale data, a GPU is
 required at minimum.
 
+Installation into a virtual environment is highly recommended, using the
+following steps:
+
+```
+$ python -m venv pyenv
+$ source pyenv/bin/activate
+$ python -m pip install -U bayesnf
+```
+
+The versions of dependencies will depend on the Python version.
+Github Actions tests the software using Python 3.10.
+If encountering any version issues, please refer to the following file
+for the versions of libraries used in the test suite:
+[requirements.Python3.10.14.txt](https://github.com/google/bayesnf/blob/main/requirements.Python3.10.14.txt).
+These specific versions can be installed into the virtual environment
+using the following command:
+
+```
+$ python -m pip install -r requirements.Python3.10.14.txt
+```
+
+
 ## Documentation and Tutorials
 
 Please visit <https://google.github.io/bayesnf>

requirements.Python3.10.14.txt

@@ -0,0 +1,60 @@
+absl-py==2.1.0
+astroid==3.1.0
+black==24.3.0
+chex==0.1.86
+click==8.1.7
+cloudpickle==3.0.0
+decorator==5.1.1
+dill==0.3.8
+dm-tree==0.1.8
+etils==1.7.0
+exceptiongroup==1.2.1
+execnet==2.1.1
+flax==0.8.3
+fsspec==2024.3.1
+gast==0.5.4
+importlib_resources==6.4.0
+iniconfig==2.0.0
+isort==5.13.2
+jax==0.4.26
+jaxlib==0.4.26
+jaxtyping==0.2.28
+markdown-it-py==3.0.0
+mccabe==0.7.0
+mdurl==0.1.2
+ml-dtypes==0.4.0
+msgpack==1.0.8
+mypy-extensions==1.0.0
+nest-asyncio==1.6.0
+numpy==1.26.4
+opt-einsum==3.3.0
+optax==0.2.2
+orbax-checkpoint==0.5.10
+packaging==24.0
+pandas==2.2.2
+pathspec==0.12.1
+platformdirs==4.2.1
+pluggy==1.5.0
+protobuf==5.26.1
+pyarrow==16.0.0
+Pygments==2.17.2
+pyink==24.3.0
+pylint==3.1.0
+pytest==8.2.0
+pytest-xdist==3.6.1
+python-dateutil==2.9.0.post0
+pytz==2024.1
+PyYAML==6.0.1
+rich==13.7.1
+scipy==1.13.0
+six==1.16.0
+tensorflow-probability==0.24.0
+tensorstore==0.1.58
+tomli==2.0.1
+tomlkit==0.12.4
+toolz==0.12.1
+tqdm==4.66.2
+typeguard==2.13.3
+typing_extensions==4.11.0
+tzdata==2024.1
+zipp==3.18.1