Skip to content

Commit 147206c

Browse files
authored
V080 (#369)
* Preparing release v080. * Modify rtd-documents for new methods. * Update CHANGELOG.rst
1 parent 399b94e commit 147206c

14 files changed

+653
-36
lines changed

CHANGELOG.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Changelog
22
=========
33

4+
0.8.0 (2021-03-29)
5+
------------------
46
- Merge adaptive distance ABC-SMC and ABC-SMC functionalities
57
- Split `DensityRatioEstimation` from utils.py into separate file
68
- Refactor parameter_inferency.py into methodtype-wise individual files

Makefile

+11-5
Original file line numberDiff line numberDiff line change
@@ -72,23 +72,29 @@ docs: ## generate Sphinx HTML documentation, including API docs
7272
$(MAKE) -C docs html
7373
# $(BROWSER) docs/_build/html/index.html
7474

75-
CONTENT_URL := http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/
75+
CONTENT_URL := https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/
7676

7777
notebook-docs: ## Conver notebooks to rst docs. Assumes you have them in `notebooks` directory.
7878
jupyter nbconvert --to rst ../notebooks/quickstart.ipynb --output-dir docs
7979
sed -i '' 's|\(quickstart_files/quickstart.*\.\)|'${CONTENT_URL}'\1|g' docs/quickstart.rst
8080

8181
jupyter nbconvert --to rst ../notebooks/tutorial.ipynb --output-dir docs/usage
82-
sed -i '' 's|\(tutorial_files/tutorial.*\.\)|'${CONTENT_URL}usage/'\1|g' docs/usage/tutorial.rst
82+
sed -i '' 's|\(tutorial_files/tutorial.*\.\)|'${CONTENT_URL}'\1|g' docs/usage/tutorial.rst
83+
84+
jupyter nbconvert --to rst ../notebooks/adaptive_distance.ipynb --output-dir docs/usage
85+
sed -i '' 's|\(adaptive_distance_files/adaptive_distance.*\.\)|'${CONTENT_URL}'\1|g' docs/usage/adaptive_distance.rst
86+
87+
jupyter nbconvert --to rst ../notebooks/adaptive_threshold_selection.ipynb --output-dir docs/usage
88+
sed -i '' 's|\(adaptive_threshold_selection_files/adaptive_threshold_selection.*\.\)|'${CONTENT_URL}'\1|g' docs/usage/adaptive_threshold_selection.rst
8389

8490
jupyter nbconvert --to rst ../notebooks/BOLFI.ipynb --output-dir docs/usage
85-
sed -i '' 's|\(BOLFI_files/BOLFI.*\.\)|'${CONTENT_URL}usage/'\1|g' docs/usage/BOLFI.rst
91+
sed -i '' 's|\(BOLFI_files/BOLFI.*\.\)|'${CONTENT_URL}'\1|g' docs/usage/BOLFI.rst
8692

8793
jupyter nbconvert --to rst ../notebooks/parallelization.ipynb --output-dir docs/usage
88-
sed -i '' 's|\(parallelization_files/parallelization.*\.\)|'${CONTENT_URL}usage/'\1|g' docs/usage/parallelization.rst
94+
sed -i '' 's|\(parallelization_files/parallelization.*\.\)|'${CONTENT_URL}'\1|g' docs/usage/parallelization.rst
8995

9096
jupyter nbconvert --to rst ../notebooks/non_python_operations.ipynb --output-dir docs/usage --output=external
91-
sed -i '' 's|\(external_files/external.*\.\)|'${CONTENT_URL}usage/'\1|g' docs/usage/external.rst
97+
sed -i '' 's|\(external_files/external.*\.\)|'${CONTENT_URL}'\1|g' docs/usage/external.rst
9298

9399
# release: clean ## package and upload a release
94100
# python setup.py sdist upload

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**Version 0.7.7 released!** See the [CHANGELOG](CHANGELOG.rst) and [notebooks](https://github.com/elfi-dev/notebooks).
1+
**Version 0.8.0 released!** See the [CHANGELOG](CHANGELOG.rst) and [notebooks](https://github.com/elfi-dev/notebooks).
22

33
ELFI - Engine for Likelihood-Free Inference
44
===========================================

docs/api.rst

+8
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Below is a list of inference methods included in ELFI.
5050
elfi.Rejection
5151
elfi.SMC
5252
elfi.AdaptiveDistanceSMC
53+
elfi.AdaptiveThresholdSMC
5354
elfi.BayesianOptimization
5455
elfi.BOLFI
5556
elfi.ROMC
@@ -205,6 +206,10 @@ Inference API classes
205206
:members:
206207
:inherited-members:
207208

209+
.. autoclass:: elfi.AdaptiveThresholdSMC
210+
:members:
211+
:inherited-members:
212+
208213
.. autoclass:: elfi.BayesianOptimization
209214
:members:
210215
:inherited-members:
@@ -238,6 +243,9 @@ Inference API classes
238243
:members:
239244
:inherited-members:
240245

246+
.. autoclass:: RomcSample
247+
:members:
248+
:inherited-members:
241249

242250
**Post-processing**
243251

docs/conf.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ def __getattr__(cls, name):
3232
'distributed', 'distributed.client', 'graphviz', 'matplotlib', 'sobol_seq', 'GPy',
3333
'dask.delayed', 'scipy.linalg', 'scipy.optimize', 'scipy.stats', 'scipy.spatial',
3434
'scipy.sparse', 'scipy.special', 'matplotlib.pyplot', 'numpy.random', 'networkx',
35-
'ipyparallel', 'numpy.lib', 'numpy.lib.format', 'sklearn.linear_model'
35+
'ipyparallel', 'numpy.lib', 'numpy.lib.format', 'sklearn.linear_model',
36+
'sklearn.pipeline', 'sklearn.preprocessing'
3637
]
3738
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
3839

docs/index.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,13 @@ Currently implemented LFI methods:
2323

2424
- ABC rejection sampler
2525
- Sequential Monte Carlo ABC sampler
26-
- SMC-ABC sampler with `adaptive distance`_
26+
- ABC-SMC sampler with `adaptive distance`_
27+
- ABC-SMC sampler with `adaptive threshold selection`_
2728
- Bayesian Optimization for Likelihood-Free Inference (BOLFI_) framework
2829
- Robust Optimization Monte Carlo (ROMC_) framework
2930

3031
.. _adaptive distance: https://projecteuclid.org/euclid.ba/1460641065
32+
.. _adaptive threshold selection: https://projecteuclid.org/journals/bayesian-analysis/advance-publication/Adaptive-Approximate-Bayesian-Computation-Tolerance-Selection/10.1214/20-BA1211.full
3133
.. _BOLFI: http://jmlr.org/papers/v17/15-017.html
3234
.. _ROMC: http://proceedings.mlr.press/v108/ikonomov20a.html
3335

@@ -56,6 +58,8 @@ Additionally, ELFI integrates tools for visualization, model comparison, diagnos
5658
:caption: Usage
5759

5860
usage/tutorial
61+
usage/adaptive_distance
62+
usage/adaptive_threshold_selection
5963
usage/parallelization
6064
usage/BOLFI
6165
usage/external

docs/quickstart.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ visualize the model:
9696
9797
9898
99-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/quickstart_files/quickstart_11_0.svg
99+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/quickstart_files/quickstart_11_0.svg
100100

101101

102102

@@ -134,5 +134,5 @@ Let’s plot also the marginal distributions for the parameters:
134134
135135
136136
137-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/quickstart_files/quickstart_16_0.png
137+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/quickstart_files/quickstart_16_0.png
138138

docs/usage/BOLFI.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ the basic tutorial, and load it from ready-made examples:
5151
5252
5353
54-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/usage/BOLFI_files/BOLFI_5_0.svg
54+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/BOLFI_files/BOLFI_5_0.svg
5555

5656

5757

@@ -166,7 +166,7 @@ investigated further:
166166
167167
168168
169-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/usage/BOLFI_files/BOLFI_15_1.png
169+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/BOLFI_files/BOLFI_15_1.png
170170

171171

172172
It may be useful to see the acquired parameter values and the resulting
@@ -178,7 +178,7 @@ discrepancies:
178178
179179
180180
181-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/usage/BOLFI_files/BOLFI_17_0.png
181+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/BOLFI_files/BOLFI_17_0.png
182182

183183

184184
There could be an unnecessarily high number of points at parameter
@@ -212,7 +212,7 @@ triangle):
212212
213213
214214
215-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/usage/BOLFI_files/BOLFI_23_0.png
215+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/BOLFI_files/BOLFI_23_0.png
216216

217217

218218
Sampling
@@ -300,7 +300,7 @@ convenience methods:
300300
301301
302302
303-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/usage/BOLFI_files/BOLFI_29_0.png
303+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/BOLFI_files/BOLFI_29_0.png
304304

305305

306306
The black vertical lines indicate the end of warmup, which by default is
@@ -312,5 +312,5 @@ half of the number of iterations.
312312
313313
314314
315-
.. image:: http://research.cs.aalto.fi/pml/software/elfi/docs/0.6.2/usage/BOLFI_files/BOLFI_31_0.png
315+
.. image:: https://raw.githubusercontent.com/elfi-dev/notebooks/dev/figures/BOLFI_files/BOLFI_31_0.png
316316

0 commit comments

Comments
 (0)