tensorwaves 0.4.18__tar.gz → 0.4.19__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/PKG-INFO +1 -1
  2. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/amplitude-analysis/phase-space.ipynb +20 -35
  3. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/data/__init__.py +8 -6
  4. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/data/phasespace.py +3 -1
  5. tensorwaves-0.4.19/src/tensorwaves/data/rng.py +173 -0
  6. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/optimizer/__init__.py +2 -2
  7. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/version.py +3 -3
  8. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/PKG-INFO +1 -1
  9. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/scm_version.json +2 -2
  10. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/data/test_phasespace.py +14 -1
  11. tensorwaves-0.4.19/tests/data/test_rng.py +90 -0
  12. tensorwaves-0.4.18/src/tensorwaves/data/rng.py +0 -88
  13. tensorwaves-0.4.18/tests/data/test_rng.py +0 -44
  14. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.binder/apt.txt +0 -0
  15. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.binder/postBuild +0 -0
  16. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.binder/runtime.txt +0 -0
  17. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.cspell.json +0 -0
  18. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.editorconfig +0 -0
  19. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.envrc +0 -0
  20. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.gitattributes +0 -0
  21. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/dependabot.yml +0 -0
  22. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/release-drafter.yml +0 -0
  23. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/benchmark.yml +0 -0
  24. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/cd.yml +0 -0
  25. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/ci.yml +0 -0
  26. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/clean-caches.yml +0 -0
  27. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/lock.yml +0 -0
  28. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/pr-linting.yml +0 -0
  29. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/redirect-gh-pages.yml +0 -0
  30. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.github/workflows/release-drafter.yml +0 -0
  31. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.gitignore +0 -0
  32. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.pre-commit-config.yaml +0 -0
  33. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.prettierignore +0 -0
  34. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.python-version +0 -0
  35. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.readthedocs.yml +0 -0
  36. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.vscode/extensions.json +0 -0
  37. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.vscode/launch.json +0 -0
  38. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/.vscode/settings.json +0 -0
  39. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/CITATION.cff +0 -0
  40. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/CONTRIBUTING.md +0 -0
  41. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/LICENSE +0 -0
  42. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/README.md +0 -0
  43. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/benchmarks/__init__.py +0 -0
  44. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/benchmarks/ampform.py +0 -0
  45. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/benchmarks/conftest.py +0 -0
  46. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/benchmarks/expression.py +0 -0
  47. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/benchmarks/precision.py +0 -0
  48. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/benchmarks/unbinned_nll.py +0 -0
  49. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/codecov.yml +0 -0
  50. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/.gitignore +0 -0
  51. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/_static/favicon.ico +0 -0
  52. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/_static/linebreaks-api.css +0 -0
  53. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/_static/mermaid.css +0 -0
  54. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/amplitude-analysis/analytic-continuation.ipynb +0 -0
  55. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/amplitude-analysis.ipynb +0 -0
  56. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/conf.py +0 -0
  57. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/index.md +0 -0
  58. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/install.md +0 -0
  59. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/tensorflow.txt +0 -0
  60. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage/basics.ipynb +0 -0
  61. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage/binned-fit.ipynb +0 -0
  62. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage/caching.ipynb +0 -0
  63. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage/chi-squared.ipynb +0 -0
  64. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage/faster-lambdify.ipynb +0 -0
  65. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage/unbinned-fit.ipynb +0 -0
  66. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/docs/usage.ipynb +0 -0
  67. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/pyproject.toml +0 -0
  68. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/setup.cfg +0 -0
  69. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/__init__.py +0 -0
  70. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/config.py +0 -0
  71. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/data/_attrs.py +0 -0
  72. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/data/_data_sample.py +0 -0
  73. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/data/transform.py +0 -0
  74. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/estimator.py +0 -0
  75. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/function/__init__.py +0 -0
  76. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/function/_backend.py +0 -0
  77. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/function/sympy/__init__.py +0 -0
  78. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/function/sympy/_printer.py +0 -0
  79. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/interface.py +0 -0
  80. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/optimizer/callbacks.py +0 -0
  81. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/optimizer/minuit.py +0 -0
  82. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/optimizer/parameter.py +0 -0
  83. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/optimizer/scipy.py +0 -0
  84. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves/py.typed +0 -0
  85. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/SOURCES.txt +0 -0
  86. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/dependency_links.txt +0 -0
  87. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/requires.txt +0 -0
  88. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/scm_file_list.json +0 -0
  89. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/src/tensorwaves.egg-info/top_level.txt +0 -0
  90. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/__init__.py +0 -0
  91. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/conftest.py +0 -0
  92. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/data/__init__.py +0 -0
  93. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/data/test_data.py +0 -0
  94. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/data/test_transform.py +0 -0
  95. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/function/__init__.py +0 -0
  96. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/function/test_ampform.py +0 -0
  97. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/function/test_backend.py +0 -0
  98. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/function/test_function.py +0 -0
  99. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/function/test_sympy.py +0 -0
  100. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/__init__.py +0 -0
  101. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/test_callbacks.py +0 -0
  102. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/test_fit_simple_model.py +0 -0
  103. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/test_gradient.py +0 -0
  104. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/test_minuit.py +0 -0
  105. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/test_parameter.py +0 -0
  106. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/optimizer/test_scipy.py +0 -0
  107. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/output/.gitignore +0 -0
  108. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/test_config.py +0 -0
  109. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/test_estimator.py +0 -0
  110. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/tests/test_interface.py +0 -0
  111. {tensorwaves-0.4.18 → tensorwaves-0.4.19}/uv.lock +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: tensorwaves
3
- Version: 0.4.18
3
+ Version: 0.4.19
4
4
  Summary: Python fitter package for multiple computational back-ends
5
5
  Author-email: Common Partial Wave Analysis <compwa-admin@ep1.rub.de>
6
6
  Maintainer-email: compwa-admin@ep1.rub.de
@@ -51,7 +51,7 @@
51
51
  "source": [
52
52
  "## Backends\n",
53
53
  "\n",
54
- "The backend is selected with the `backend` argument of the generator. All backends return a {obj}`.DataSample` of NumPy arrays with the same structure, so they can be swapped without changing the rest of an analysis."
54
+ "The backend is selected with the `backend` argument of the generator. All backends return a {obj}`.DataSample` of NumPy arrays with the same structure, so they can be swapped without changing the rest of an analysis. A {class}`.UniformRNG` takes the same `backend` argument, so one string selects both the generator and a matching random number generator."
55
55
  ]
56
56
  },
57
57
  {
@@ -60,32 +60,17 @@
60
60
  "metadata": {},
61
61
  "outputs": [],
62
62
  "source": [
63
- "from tensorwaves.data import (\n",
64
- " NumpyUniformRNG,\n",
65
- " TFPhaseSpaceGenerator,\n",
66
- " TFUniformRealNumberGenerator,\n",
67
- ")\n",
63
+ "from tensorwaves.data import TFPhaseSpaceGenerator, UniformRNG\n",
68
64
  "\n",
69
- "initial_state_mass = 3.0969\n",
70
- "final_state_masses = {0: 0.1350, 1: 0.1396, 2: 0.4937}\n",
71
- "generators = {\n",
72
- " \"numpy\": (\n",
73
- " TFPhaseSpaceGenerator(initial_state_mass, final_state_masses, backend=\"numpy\"),\n",
74
- " NumpyUniformRNG(seed=0),\n",
75
- " ),\n",
76
- " \"tensorflow\": (\n",
77
- " TFPhaseSpaceGenerator(\n",
78
- " initial_state_mass, final_state_masses, backend=\"tensorflow\"\n",
79
- " ),\n",
80
- " TFUniformRealNumberGenerator(seed=0),\n",
81
- " ),\n",
82
- " \"jax\": (\n",
83
- " TFPhaseSpaceGenerator(initial_state_mass, final_state_masses, backend=\"jax\"),\n",
84
- " NumpyUniformRNG(seed=0),\n",
85
- " ),\n",
86
- "}\n",
87
- "for generator, _ in generators.values():\n",
88
- " generator.show_progress = False"
65
+ "generators = {}\n",
66
+ "for backend in [\"numpy\", \"tensorflow\", \"jax\"]:\n",
67
+ " generator = TFPhaseSpaceGenerator(\n",
68
+ " initial_state_mass=3.0969,\n",
69
+ " final_state_masses={0: 0.1350, 1: 0.1396, 2: 0.4937},\n",
70
+ " backend=backend,\n",
71
+ " )\n",
72
+ " generator.show_progress = False\n",
73
+ " generators[backend] = (generator, UniformRNG(seed=0, backend=backend))"
89
74
  ]
90
75
  },
91
76
  {
@@ -195,7 +180,7 @@
195
180
  " final_state_masses=dict.fromkeys(range(n), 0.13957),\n",
196
181
  " backend=\"numpy\",\n",
197
182
  " )\n",
198
- " rng = NumpyUniformRNG(seed=0)\n",
183
+ " rng = UniformRNG(seed=0, backend=\"numpy\")\n",
199
184
  " weights[n] = weighted_generator.generate(100_000, rng)[\"weights\"]\n",
200
185
  "\n",
201
186
  "fig, (ax1, ax2) = plt.subplots(ncols=2, figsize=(10, 3.8), layout=\"constrained\")\n",
@@ -240,12 +225,10 @@
240
225
  "metadata": {},
241
226
  "outputs": [],
242
227
  "source": [
243
- "initial_state_mass = 3.0969\n",
244
- "final_state_masses = {0: 0.1350, 1: 0.1396, 2: 0.4937}\n",
245
- "default_generator = TFPhaseSpaceGenerator(initial_state_mass, final_state_masses)\n",
246
- "adaptive_generator = TFPhaseSpaceGenerator(\n",
247
- " initial_state_mass, final_state_masses, adaptive_max_weight=True\n",
248
- ")"
228
+ "is_mass = 3.0969\n",
229
+ "fs_masses = {0: 0.1350, 1: 0.1396, 2: 0.4937}\n",
230
+ "default_generator = TFPhaseSpaceGenerator(is_mass, fs_masses)\n",
231
+ "adaptive_generator = TFPhaseSpaceGenerator(is_mass, fs_masses, adaptive_max_weight=True)"
249
232
  ]
250
233
  },
251
234
  {
@@ -258,9 +241,11 @@
258
241
  "default_generator.show_progress = False\n",
259
242
  "adaptive_generator.show_progress = False\n",
260
243
  "samples = {\n",
261
- " \"Default\": default_generator.generate(size, TFUniformRealNumberGenerator(seed=0)),\n",
244
+ " \"Default\": default_generator.generate(\n",
245
+ " size, UniformRNG(seed=0, backend=\"tensorflow\")\n",
246
+ " ),\n",
262
247
  " \"adaptive_max_weight=True\": adaptive_generator.generate(\n",
263
- " size, TFUniformRealNumberGenerator(seed=0)\n",
248
+ " size, UniformRNG(seed=0, backend=\"tensorflow\")\n",
264
249
  " ),\n",
265
250
  "}"
266
251
  ]
@@ -21,12 +21,14 @@ from ._data_sample import (
21
21
  merge_events,
22
22
  select_events,
23
23
  )
24
- from .phasespace import (
25
- TFPhaseSpaceGenerator, # ruff:ignore[unused-import]
26
- TFWeightedPhaseSpaceGenerator, # ruff:ignore[unused-import]
27
- )
28
- from .rng import NumpyUniformRNG, TFUniformRealNumberGenerator # ruff:ignore[unused-import]
29
- from .transform import IdentityTransformer, SympyDataTransformer # ruff:ignore[unused-import]
24
+ from .phasespace import TFPhaseSpaceGenerator as TFPhaseSpaceGenerator
25
+ from .phasespace import TFWeightedPhaseSpaceGenerator as TFWeightedPhaseSpaceGenerator
26
+ from .rng import JAXUniformRNG as JAXUniformRNG
27
+ from .rng import NumpyUniformRNG as NumpyUniformRNG
28
+ from .rng import TFUniformRealNumberGenerator as TFUniformRealNumberGenerator
29
+ from .rng import UniformRNG as UniformRNG
30
+ from .transform import IdentityTransformer as IdentityTransformer
31
+ from .transform import SympyDataTransformer as SympyDataTransformer
30
32
 
31
33
  _LOGGER = logging.getLogger(__name__)
32
34
 
@@ -17,7 +17,7 @@ from ._data_sample import (
17
17
  merge_events,
18
18
  select_events,
19
19
  )
20
- from .rng import NumpyUniformRNG, TFUniformRealNumberGenerator
20
+ from .rng import NumpyUniformRNG, TFUniformRealNumberGenerator, UniformRNG
21
21
 
22
22
  if TYPE_CHECKING:
23
23
  from collections.abc import Mapping
@@ -206,6 +206,8 @@ def _activate_backend(backend: Backend) -> None:
206
206
  def _get_seed(
207
207
  rng: RealNumberGenerator, backend: Backend
208
208
  ) -> int | np.random.Generator | tf.random.Generator:
209
+ if isinstance(rng, UniformRNG):
210
+ rng = rng.implementation
209
211
  if backend == "numpy" and isinstance(rng, NumpyUniformRNG):
210
212
  return rng.generator
211
213
  if backend == "tensorflow" and isinstance(rng, TFUniformRealNumberGenerator):
@@ -0,0 +1,173 @@
1
+ """Implementations of `.RealNumberGenerator`."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import secrets
6
+ from typing import TYPE_CHECKING
7
+
8
+ import numpy as np
9
+
10
+ from tensorwaves.config import _tensorflow_precision
11
+ from tensorwaves.function._backend import raise_missing_module_error
12
+ from tensorwaves.interface import RealNumberGenerator
13
+
14
+ if TYPE_CHECKING: # pragma: no cover
15
+ import tensorflow as tf
16
+
17
+ from tensorwaves.data.phasespace import Backend
18
+
19
+ SeedLike = int | tf.random.Generator | None
20
+
21
+
22
+ class UniformRNG(RealNumberGenerator):
23
+ """Uniform real random number generator for a selectable computational backend.
24
+
25
+ Select the backend with the same string as `.TFPhaseSpaceGenerator`, so that a
26
+ script can switch backends through one variable. The numbers are generated by
27
+ `NumpyUniformRNG`, `TFUniformRealNumberGenerator`, or `JAXUniformRNG`, which is
28
+ available as `implementation`.
29
+ """
30
+
31
+ def __init__(self, seed: int | None = None, backend: Backend = "numpy") -> None:
32
+ implementations: dict[str, type[_BackendRNG]] = {
33
+ "jax": JAXUniformRNG,
34
+ "numpy": NumpyUniformRNG,
35
+ "tensorflow": TFUniformRealNumberGenerator,
36
+ }
37
+ if backend not in implementations:
38
+ msg = f'Backend must be one of {sorted(implementations)}, got "{backend}"'
39
+ raise ValueError(msg)
40
+ self.__backend = backend
41
+ self.__implementation = implementations[backend](seed)
42
+
43
+ def __call__(
44
+ self, size: int, min_value: float = 0.0, max_value: float = 1.0
45
+ ) -> np.ndarray:
46
+ return self.__implementation(size, min_value, max_value)
47
+
48
+ @property
49
+ def backend(self) -> Backend:
50
+ return self.__backend
51
+
52
+ @property
53
+ def implementation(self) -> _BackendRNG:
54
+ return self.__implementation
55
+
56
+ @property
57
+ def seed(self) -> int | None:
58
+ return self.__implementation.seed
59
+
60
+ @seed.setter
61
+ def seed(self, value: int | None) -> None:
62
+ self.__implementation.seed = value
63
+
64
+
65
+ class JAXUniformRNG(RealNumberGenerator):
66
+ """Implements a uniform real random number generator using `JAX <https://docs.jax.dev>`__.
67
+
68
+ The generator keeps a `jax.random` key and splits it on every call, so that
69
+ consecutive calls return different numbers.
70
+ """
71
+
72
+ def __init__(self, seed: int | None = None) -> None:
73
+ self.seed = seed
74
+
75
+ def __call__(
76
+ self, size: int, min_value: float = 0.0, max_value: float = 1.0
77
+ ) -> np.ndarray:
78
+ import jax # ruff:ignore[import-outside-top-level]
79
+
80
+ self.key, call_key = jax.random.split(self.key)
81
+ return jax.random.uniform( # ty:ignore[invalid-explicit-return]
82
+ call_key, shape=(size,), minval=min_value, maxval=max_value
83
+ )
84
+
85
+ @property
86
+ def seed(self) -> int | None:
87
+ return self.__seed
88
+
89
+ @seed.setter
90
+ def seed(self, value: int | None) -> None:
91
+ try:
92
+ import jax # ruff:ignore[import-outside-top-level]
93
+ except ImportError: # pragma: no cover
94
+ raise_missing_module_error("jax", extras_require="jax")
95
+ self.__seed = value
96
+ if value is None:
97
+ value = secrets.randbits(32)
98
+ self.key = jax.random.key(value)
99
+
100
+
101
+ class NumpyUniformRNG(RealNumberGenerator):
102
+ """Implements a uniform real random number generator using `numpy`."""
103
+
104
+ def __init__(self, seed: int | None = None) -> None:
105
+ self.seed = seed
106
+
107
+ def __call__(
108
+ self, size: int, min_value: float = 0.0, max_value: float = 1.0
109
+ ) -> np.ndarray:
110
+ return self.generator.uniform(size=size, low=min_value, high=max_value)
111
+
112
+ @property
113
+ def seed(self) -> int | None:
114
+ return self.__seed
115
+
116
+ @seed.setter
117
+ def seed(self, value: int | None) -> None:
118
+ self.__seed = value
119
+ self.generator: np.random.Generator = np.random.default_rng(seed=self.seed)
120
+
121
+
122
+ class TFUniformRealNumberGenerator(RealNumberGenerator):
123
+ """Implements a uniform real random number generator using tensorflow."""
124
+
125
+ def __init__(self, seed: int | None = None) -> None:
126
+ try:
127
+ import tensorflow as tf # ruff:ignore[import-outside-top-level]
128
+ except ImportError: # pragma: no cover
129
+ raise_missing_module_error("tensorflow", extras_require="tf")
130
+ self.seed = seed
131
+ self.dtype = tf.float32 if _tensorflow_precision() == "float32" else tf.float64
132
+
133
+ def __call__(
134
+ self, size: int, min_value: float = 0.0, max_value: float = 1.0
135
+ ) -> np.ndarray:
136
+ return self.generator.uniform(
137
+ shape=[size],
138
+ minval=min_value,
139
+ maxval=max_value,
140
+ dtype=self.dtype,
141
+ ).numpy()
142
+
143
+ @property
144
+ def seed(self) -> int | None:
145
+ return self.__seed
146
+
147
+ @seed.setter
148
+ def seed(self, value: int | None) -> None:
149
+ self.__seed = value
150
+ self.generator = _get_tensorflow_rng(self.seed)
151
+
152
+
153
+ _BackendRNG = JAXUniformRNG | NumpyUniformRNG | TFUniformRealNumberGenerator
154
+
155
+
156
+ def _get_tensorflow_rng(seed: SeedLike | None = None) -> tf.random.Generator:
157
+ """Get or create a `tf.random.Generator`.
158
+
159
+ https://github.com/zfit/phasespace/blob/5998e2b/phasespace/random.py#L15-L41
160
+ """
161
+ try:
162
+ import tensorflow as tf # ruff:ignore[import-outside-top-level]
163
+ except ImportError: # pragma: no cover
164
+ raise_missing_module_error("tensorflow", extras_require="tf")
165
+
166
+ if seed is None:
167
+ return tf.random.get_global_generator()
168
+ if isinstance(seed, int):
169
+ return tf.random.Generator.from_seed(seed=seed)
170
+ if isinstance(seed, tf.random.Generator):
171
+ return seed
172
+ msg = f"Cannot create a tf.random.Generator from a {type(seed).__name__}"
173
+ raise TypeError(msg)
@@ -10,11 +10,11 @@ __all__ = [
10
10
  ]
11
11
 
12
12
  from . import callbacks, minuit
13
- from .minuit import Minuit2 # ruff:ignore[unused-import]
13
+ from .minuit import Minuit2 as Minuit2
14
14
 
15
15
  try:
16
16
  from . import scipy
17
- from .scipy import ScipyMinimizer # ruff:ignore[unused-import]
17
+ from .scipy import ScipyMinimizer as ScipyMinimizer
18
18
 
19
19
  __all__ += [
20
20
  "scipy",
@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
18
18
  commit_id: str | None
19
19
  __commit_id__: str | None
20
20
 
21
- __version__ = version = '0.4.18'
22
- __version_tuple__ = version_tuple = (0, 4, 18)
21
+ __version__ = version = '0.4.19'
22
+ __version_tuple__ = version_tuple = (0, 4, 19)
23
23
 
24
- __commit_id__ = commit_id = 'gd2bd1dc26'
24
+ __commit_id__ = commit_id = 'g7bd63d32b'
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: tensorwaves
3
- Version: 0.4.18
3
+ Version: 0.4.19
4
4
  Summary: Python fitter package for multiple computational back-ends
5
5
  Author-email: Common Partial Wave Analysis <compwa-admin@ep1.rub.de>
6
6
  Maintainer-email: compwa-admin@ep1.rub.de
@@ -1,7 +1,7 @@
1
1
  {
2
- "tag": "0.4.18",
2
+ "tag": "0.4.19",
3
3
  "distance": 0,
4
- "node": "gd2bd1dc268e08bc6366a5b878edb14efcc7fb131",
4
+ "node": "g7bd63d32bfd20c61f9ed01a22095de3abb57a81e",
5
5
  "dirty": false,
6
6
  "branch": "HEAD",
7
7
  "node_date": "2026-11-19"
@@ -8,10 +8,12 @@ import numpy as np
8
8
  import pytest
9
9
 
10
10
  from tensorwaves.data import (
11
+ JAXUniformRNG,
11
12
  NumpyUniformRNG,
12
13
  TFPhaseSpaceGenerator,
13
14
  TFUniformRealNumberGenerator,
14
15
  TFWeightedPhaseSpaceGenerator,
16
+ UniformRNG,
15
17
  )
16
18
 
17
19
  if TYPE_CHECKING:
@@ -299,7 +301,7 @@ def describe_backend():
299
301
 
300
302
  @pytest.mark.parametrize("backend", ["numpy", "tensorflow", "jax"])
301
303
  @pytest.mark.parametrize(
302
- "rng_type", [NumpyUniformRNG, TFUniformRealNumberGenerator]
304
+ "rng_type", [NumpyUniformRNG, TFUniformRealNumberGenerator, JAXUniformRNG]
303
305
  )
304
306
  def it_returns_reproducible_numpy_arrays(backend, rng_type):
305
307
  generator = TFPhaseSpaceGenerator(3.0, masses, backend=backend)
@@ -314,6 +316,17 @@ def describe_backend():
314
316
  total_energy = sum(p[:, 0] for p in sample1.values())
315
317
  assert pytest.approx(total_energy) == np.full(10, 3.0)
316
318
 
319
+ @pytest.mark.parametrize("backend", ["numpy", "tensorflow", "jax"])
320
+ def it_generates_the_same_sample_with_a_uniform_rng_for_the_backend(backend):
321
+ generator = TFPhaseSpaceGenerator(3.0, masses, backend=backend)
322
+ generator.show_progress = False
323
+ rng = UniformRNG(seed=0, backend=backend)
324
+ reference_rng = type(rng.implementation)(seed=0)
325
+ sample = generator.generate(10, rng)
326
+ reference = generator.generate(10, reference_rng)
327
+ for key, momenta in sample.items():
328
+ np.testing.assert_array_equal(momenta, reference[key])
329
+
317
330
  def it_uses_tensorflow_by_default():
318
331
  import phasespace
319
332
 
@@ -0,0 +1,90 @@
1
+ import numpy as np
2
+ import pytest
3
+
4
+ from tensorwaves.data.rng import (
5
+ JAXUniformRNG,
6
+ NumpyUniformRNG,
7
+ TFUniformRealNumberGenerator,
8
+ UniformRNG,
9
+ _get_tensorflow_rng,
10
+ )
11
+
12
+
13
+ def describe_NumpyUniformRNG():
14
+ def it_generates_the_same_sequence_for_the_same_seed():
15
+ rng1 = NumpyUniformRNG(seed=0)
16
+ rng2 = NumpyUniformRNG(seed=0)
17
+ assert pytest.approx(rng1(size=3)) == [0.6369617, 0.2697867, 0.0409735]
18
+ assert pytest.approx(rng2(size=2)) == [0.6369617, 0.2697867]
19
+ assert pytest.approx(rng2(size=1)) == [0.0409735]
20
+
21
+ def it_generates_different_sequences_without_a_seed():
22
+ rng1 = NumpyUniformRNG()
23
+ rng2 = NumpyUniformRNG()
24
+ with pytest.raises(AssertionError):
25
+ assert pytest.approx(rng1(size=2)) == rng2(size=2)
26
+
27
+ def it_restarts_the_sequence_when_the_seed_is_set_again():
28
+ rng = NumpyUniformRNG(seed=0)
29
+ assert pytest.approx(rng(size=2)) == [0.6369617, 0.2697867]
30
+ rng.seed = 0 # reset
31
+ assert pytest.approx(rng(size=2)) == [0.6369617, 0.2697867]
32
+
33
+
34
+ def describe_TFUniformRealNumberGenerator():
35
+ def it_generates_the_same_sequence_for_the_same_seed():
36
+ generator = TFUniformRealNumberGenerator(seed=456)
37
+ sample = generator(size=3, min_value=-1, max_value=+1)
38
+ assert pytest.approx(sample) == [-0.38057342, -0.21197986, 0.14724727]
39
+
40
+
41
+ def describe_get_tensorflow_rng():
42
+ def it_accepts_a_seed_a_generator_or_nothing():
43
+ import tensorflow as tf
44
+
45
+ for seed in [None, 100, tf.random.Generator.from_seed(seed=0)]:
46
+ rng = _get_tensorflow_rng(seed)
47
+ assert isinstance(rng, tf.random.Generator)
48
+
49
+
50
+ def describe_JAXUniformRNG():
51
+ def it_generates_the_same_sequence_for_the_same_seed():
52
+ rng1 = JAXUniformRNG(seed=0)
53
+ rng2 = JAXUniformRNG(seed=0)
54
+ values = rng1(size=3)
55
+ assert values.shape == (3,)
56
+ np.testing.assert_array_equal(rng2(size=3), values)
57
+ assert not np.array_equal(rng2(size=3), values)
58
+
59
+ def it_restarts_the_sequence_when_the_seed_is_set_again():
60
+ rng = JAXUniformRNG(seed=0)
61
+ values = rng(size=2)
62
+ rng.seed = 0
63
+ np.testing.assert_array_equal(rng(size=2), values)
64
+
65
+ def it_respects_the_range():
66
+ values = JAXUniformRNG(seed=0)(size=100, min_value=2.0, max_value=3.0)
67
+ assert np.all((values >= 2.0) & (values < 3.0))
68
+
69
+
70
+ def describe_UniformRNG():
71
+ @pytest.mark.parametrize(
72
+ ("backend", "expected_type"),
73
+ [
74
+ ("numpy", NumpyUniformRNG),
75
+ ("jax", JAXUniformRNG),
76
+ ("tensorflow", TFUniformRealNumberGenerator),
77
+ ],
78
+ )
79
+ def it_delegates_to_the_backend_implementation(backend, expected_type):
80
+ rng = UniformRNG(seed=0, backend=backend)
81
+ assert rng.backend == backend
82
+ assert type(rng.implementation) is expected_type
83
+ reference = expected_type(seed=0)
84
+ np.testing.assert_array_equal(rng(size=3), reference(size=3))
85
+ rng.seed = 1
86
+ assert rng.implementation.seed == 1
87
+
88
+ def it_rejects_an_unknown_backend():
89
+ with pytest.raises(ValueError, match="Backend must be one of"):
90
+ UniformRNG(backend="torch") # ty: ignore[invalid-argument-type]
@@ -1,88 +0,0 @@
1
- """Implementations of `.RealNumberGenerator`."""
2
-
3
- from __future__ import annotations
4
-
5
- from typing import TYPE_CHECKING
6
-
7
- import numpy as np
8
-
9
- from tensorwaves.config import _tensorflow_precision
10
- from tensorwaves.function._backend import raise_missing_module_error
11
- from tensorwaves.interface import RealNumberGenerator
12
-
13
- if TYPE_CHECKING: # pragma: no cover
14
- import tensorflow as tf
15
-
16
- SeedLike = int | tf.random.Generator | None
17
-
18
-
19
- class NumpyUniformRNG(RealNumberGenerator):
20
- """Implements a uniform real random number generator using `numpy`."""
21
-
22
- def __init__(self, seed: int | None = None) -> None:
23
- self.seed = seed
24
-
25
- def __call__(
26
- self, size: int, min_value: float = 0.0, max_value: float = 1.0
27
- ) -> np.ndarray:
28
- return self.generator.uniform(size=size, low=min_value, high=max_value)
29
-
30
- @property
31
- def seed(self) -> int | None:
32
- return self.__seed
33
-
34
- @seed.setter
35
- def seed(self, value: int | None) -> None:
36
- self.__seed = value
37
- self.generator: np.random.Generator = np.random.default_rng(seed=self.seed)
38
-
39
-
40
- class TFUniformRealNumberGenerator(RealNumberGenerator):
41
- """Implements a uniform real random number generator using tensorflow."""
42
-
43
- def __init__(self, seed: int | None = None) -> None:
44
- try:
45
- import tensorflow as tf # ruff:ignore[import-outside-top-level]
46
- except ImportError: # pragma: no cover
47
- raise_missing_module_error("tensorflow", extras_require="tf")
48
- self.seed = seed
49
- self.dtype = tf.float32 if _tensorflow_precision() == "float32" else tf.float64
50
-
51
- def __call__(
52
- self, size: int, min_value: float = 0.0, max_value: float = 1.0
53
- ) -> np.ndarray:
54
- return self.generator.uniform(
55
- shape=[size],
56
- minval=min_value,
57
- maxval=max_value,
58
- dtype=self.dtype,
59
- ).numpy()
60
-
61
- @property
62
- def seed(self) -> int | None:
63
- return self.__seed
64
-
65
- @seed.setter
66
- def seed(self, value: int | None) -> None:
67
- self.__seed = value
68
- self.generator = _get_tensorflow_rng(self.seed)
69
-
70
-
71
- def _get_tensorflow_rng(seed: SeedLike | None = None) -> tf.random.Generator:
72
- """Get or create a `tf.random.Generator`.
73
-
74
- https://github.com/zfit/phasespace/blob/5998e2b/phasespace/random.py#L15-L41
75
- """
76
- try:
77
- import tensorflow as tf # ruff:ignore[import-outside-top-level]
78
- except ImportError: # pragma: no cover
79
- raise_missing_module_error("tensorflow", extras_require="tf")
80
-
81
- if seed is None:
82
- return tf.random.get_global_generator()
83
- if isinstance(seed, int):
84
- return tf.random.Generator.from_seed(seed=seed)
85
- if isinstance(seed, tf.random.Generator):
86
- return seed
87
- msg = f"Cannot create a tf.random.Generator from a {type(seed).__name__}"
88
- raise TypeError(msg)
@@ -1,44 +0,0 @@
1
- import pytest
2
-
3
- from tensorwaves.data.rng import (
4
- NumpyUniformRNG,
5
- TFUniformRealNumberGenerator,
6
- _get_tensorflow_rng,
7
- )
8
-
9
-
10
- def describe_NumpyUniformRNG():
11
- def it_generates_the_same_sequence_for_the_same_seed():
12
- rng1 = NumpyUniformRNG(seed=0)
13
- rng2 = NumpyUniformRNG(seed=0)
14
- assert pytest.approx(rng1(size=3)) == [0.6369617, 0.2697867, 0.0409735]
15
- assert pytest.approx(rng2(size=2)) == [0.6369617, 0.2697867]
16
- assert pytest.approx(rng2(size=1)) == [0.0409735]
17
-
18
- def it_generates_different_sequences_without_a_seed():
19
- rng1 = NumpyUniformRNG()
20
- rng2 = NumpyUniformRNG()
21
- with pytest.raises(AssertionError):
22
- assert pytest.approx(rng1(size=2)) == rng2(size=2)
23
-
24
- def it_restarts_the_sequence_when_the_seed_is_set_again():
25
- rng = NumpyUniformRNG(seed=0)
26
- assert pytest.approx(rng(size=2)) == [0.6369617, 0.2697867]
27
- rng.seed = 0 # reset
28
- assert pytest.approx(rng(size=2)) == [0.6369617, 0.2697867]
29
-
30
-
31
- def describe_TFUniformRealNumberGenerator():
32
- def it_generates_the_same_sequence_for_the_same_seed():
33
- generator = TFUniformRealNumberGenerator(seed=456)
34
- sample = generator(size=3, min_value=-1, max_value=+1)
35
- assert pytest.approx(sample) == [-0.38057342, -0.21197986, 0.14724727]
36
-
37
-
38
- def describe_get_tensorflow_rng():
39
- def it_accepts_a_seed_a_generator_or_nothing():
40
- import tensorflow as tf
41
-
42
- for seed in [None, 100, tf.random.Generator.from_seed(seed=0)]:
43
- rng = _get_tensorflow_rng(seed)
44
- assert isinstance(rng, tf.random.Generator)
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes