Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: updates for numpy2 closes #509 #510

Merged
merged 5 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
python-version: ["3.9", "3.10", "3.11", "3.12"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would only add 3.11 and 3.12 and not remove 3.7 (maybe because EOL) and 3.8.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The leading_edge job either way only runs on py 3.12 and numpy 2 wont be available for py 3.8 and lower.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll go with what @dfm decides.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to test 3.9-3.12 as implemented in this PR. Thanks!!

os: ["ubuntu-latest"]
include:
- python-version: "3.9"
Expand Down Expand Up @@ -49,6 +49,30 @@ jobs:
COVERALLS_PARALLEL: true
COVERALLS_FLAG_NAME: ${{ matrix.python-version }}-${{ matrix.os }}

leading_edge:
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: ["3.12"]
os: ["ubuntu-latest"]

steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install -U pip
python -m pip install pip install pytest "numpy>=2.0.0rc1"
python -m pip install -e.
- name: Run tests
run: pytest

coverage:
needs: tests
runs-on: ubuntu-latest
Expand Down
30 changes: 26 additions & 4 deletions src/emcee/ensemble.py
Original file line number Diff line number Diff line change
Expand Up @@ -489,10 +489,19 @@ def compute_log_prob(self, coords):
results = list(map_func(self.log_prob_fn, p))

try:
log_prob = np.array([float(l[0]) for l in results])
blob = [l[1:] for l in results]
# perhaps log_prob_fn returns blobs?

# deal with the blobs first
# if l does not have a len attribute (i.e. not a sequence, no blob)
# then a TypeError is raised. However, no error will be raised if
# l is a length-1 array, np.array([1.234]). In that case blob
# will become an empty list.
blob = [l[1:] for l in results if len(l) > 1]
if not len(blob):
raise IndexError
log_prob = np.array([_scalar(l[0]) for l in results])
except (IndexError, TypeError):
log_prob = np.array([float(l) for l in results])
log_prob = np.array([_scalar(l) for l in results])
blob = None
else:
# Get the blobs dtype
Expand All @@ -502,7 +511,7 @@ def compute_log_prob(self, coords):
try:
with warnings.catch_warnings(record=True):
warnings.simplefilter(
"error", np.VisibleDeprecationWarning
"error", np.exceptions.VisibleDeprecationWarning
)
try:
dt = np.atleast_1d(blob[0]).dtype
Expand Down Expand Up @@ -682,3 +691,16 @@ def ndarray_to_list_of_dicts(
list of dictionaries of parameters
"""
return [{key: xi[val] for key, val in key_map.items()} for xi in x]


def _scalar(fx):
# Make sure a value is a true scalar
# 1.0, np.float64(1.0), np.array([1.0]), np.array(1.0)
if not np.isscalar(fx):
try:
fx = np.asarray(fx).item()
except (TypeError, ValueError) as e:
raise ValueError("log_prob_fn should return scalar") from e
return float(fx)
else:
return float(fx)
34 changes: 34 additions & 0 deletions src/emcee/tests/unit/test_ensemble.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,37 @@ def test_run_mcmc(self):
assert results.coords.shape == (n_walkers, len(self.names))
chain = sampler.chain
assert chain.shape == (n_walkers, n_steps, len(self.names))


class TestLnProbFn(TestCase):
# checks that the log_prob_fn can deal with a variety of 'scalar-likes'
def lnpdf(self, x):
v = np.log(np.sqrt(np.pi) * np.exp(-((x / 2.0) ** 2)))
v = float(v[0])
assert np.isscalar(v)
return v

def lnpdf_arr1(self, x):
v = self.lnpdf(x)
return np.array([v])

def lnpdf_float64(self, x):
v = self.lnpdf(x)
return np.float64(v)

def lnpdf_arr0D(self, x):
v = self.lnpdf(x)
return np.array(v)

def test_deal_with_scalar_likes(self):
rng = np.random.default_rng()
fns = [
self.lnpdf,
self.lnpdf_arr1,
self.lnpdf_float64,
self.lnpdf_arr0D,
]
for fn in fns:
init = rng.random((50, 1))
sampler = EnsembleSampler(50, 1, fn)
_ = sampler.run_mcmc(initial_state=init, nsteps=20)
8 changes: 4 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[tox]
envlist = py{37,38,39,310}{,-extras},lint
envlist = py{39,310,311,312}{,-extras},lint

[gh-actions]
python =
3.7: py37
3.8: py38
3.9: py39-extras
3.9: py39
3.10: py310
3.11: py311-extras
3.12: py312

[testenv]
deps = coverage[toml]
Expand Down