reax 0.7.0.dev2__tar.gz → 0.7.0.dev4__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 (105) hide show
  1. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/PKG-INFO +2 -2
  2. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/pyproject.toml +5 -3
  3. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/__init__.py +1 -1
  4. reax-0.7.0.dev4/src/reax/_vendor/__init__.py +1 -0
  5. reax-0.7.0.dev4/src/reax/_vendor/simple_pytree.py +248 -0
  6. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/_loaders.py +46 -24
  7. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/_types.py +7 -3
  8. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/samplers.py +74 -64
  9. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/model_checkpoint.py +11 -1
  10. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/_classification.py +14 -15
  11. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/_evaluators.py +3 -2
  12. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/_metric.py +6 -5
  13. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/aggregation.py +16 -19
  14. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/collections.py +3 -4
  15. reax-0.7.0.dev4/src/reax/metrics/utils.py +160 -0
  16. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/optimizers.py +8 -5
  17. reax-0.7.0.dev4/src/reax/pytree.py +87 -0
  18. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/results.py +2 -3
  19. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/stats.py +15 -4
  20. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/_jax.py +3 -3
  21. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/_parallel.py +4 -0
  22. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/_single_device.py +1 -1
  23. reax-0.7.0.dev4/src/reax/utils/__init__.py +4 -0
  24. reax-0.7.0.dev4/src/reax/utils/masking.py +97 -0
  25. reax-0.7.0.dev2/src/reax/metrics/utils.py +0 -252
  26. reax-0.7.0.dev2/src/reax/utils/__init__.py +0 -4
  27. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/LICENSE.txt +0 -0
  28. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/README.rst +0 -0
  29. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/_engine.py +0 -0
  30. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/_module_hooks.py +0 -0
  31. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/__init__.py +0 -0
  32. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/_datasource_manager.py +0 -0
  33. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/_datasources.py +0 -0
  34. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/collate.py +0 -0
  35. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/dataloaders.py +0 -0
  36. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/datamodules.py +0 -0
  37. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/datasets.py +0 -0
  38. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/fetchers.py +0 -0
  39. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/kfold.py +0 -0
  40. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/data/utils.py +0 -0
  41. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/demos/__init__.py +0 -0
  42. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/demos/boring_classes.py +0 -0
  43. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/demos/mnist.py +0 -0
  44. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/exceptions.py +0 -0
  45. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/hooks.py +0 -0
  46. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/keys.py +0 -0
  47. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/lightning/LICENSE +0 -0
  48. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/lightning/__init__.py +0 -0
  49. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/lightning/rank_zero.py +0 -0
  50. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/__init__.py +0 -0
  51. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/checkpointer.py +0 -0
  52. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/early_stopping.py +0 -0
  53. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/progress/__init__.py +0 -0
  54. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/progress/progress_bar.py +0 -0
  55. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/progress/rich_progress.py +0 -0
  56. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/progress/tqdm_progress.py +0 -0
  57. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/listeners/utils.py +0 -0
  58. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/__init__.py +0 -0
  59. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/_utils.py +0 -0
  60. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/csv_logs.py +0 -0
  61. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/logger.py +0 -0
  62. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/mlflow.py +0 -0
  63. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/pandas.py +0 -0
  64. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/loggers/tensorboard.py +0 -0
  65. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/__init__.py +0 -0
  66. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/_globals.py +0 -0
  67. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/_registry.py +0 -0
  68. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/jm/__init__.py +0 -0
  69. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/jm/types.py +0 -0
  70. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/jm/utils.py +0 -0
  71. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/metrics/regression.py +0 -0
  72. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/modules.py +0 -0
  73. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/plugins.py +0 -0
  74. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/profilers/__init__.py +0 -0
  75. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/profilers/jax_profiler.py +0 -0
  76. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/profilers/profiler.py +0 -0
  77. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/random.py +0 -0
  78. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/saving.py +0 -0
  79. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/__init__.py +0 -0
  80. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/_loops.py +0 -0
  81. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/_timer.py +0 -0
  82. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/common.py +0 -0
  83. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/fit.py +0 -0
  84. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/predict.py +0 -0
  85. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/stages.py +0 -0
  86. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/test.py +0 -0
  87. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/train.py +0 -0
  88. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/stages/validation.py +0 -0
  89. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/__init__.py +0 -0
  90. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/_factory.py +0 -0
  91. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/_strategies.py +0 -0
  92. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/strategies/_utils.py +0 -0
  93. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/testing.py +0 -0
  94. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/__init__.py +0 -0
  95. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/_checkpoint_connector.py +0 -0
  96. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/_checkpointing.py +0 -0
  97. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/_hooks_map.py +0 -0
  98. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/_logger_connector.py +0 -0
  99. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/_utils.py +0 -0
  100. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/training/trainer.py +0 -0
  101. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/types.py +0 -0
  102. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/utils/arrays.py +0 -0
  103. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/utils/containers.py +0 -0
  104. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/utils/events.py +0 -0
  105. {reax-0.7.0.dev2 → reax-0.7.0.dev4}/src/reax/utils/grads.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: reax
3
- Version: 0.7.0.dev2
3
+ Version: 0.7.0.dev4
4
4
  Summary: REAX: A simple training framework for JAX-based projects
5
5
  Keywords: machine learning,jax,research
6
6
  Author-email: Martin Uhrin <martin.uhrin.10@ucl.ac.uk>
@@ -17,7 +17,6 @@ Classifier: Programming Language :: Python :: 3.14
17
17
  License-File: LICENSE.txt
18
18
  Requires-Dist: beartype
19
19
  Requires-Dist: einops
20
- Requires-Dist: equinox
21
20
  Requires-Dist: flax
22
21
  Requires-Dist: fsspec
23
22
  Requires-Dist: jax
@@ -45,6 +44,7 @@ Requires-Dist: pylint ; extra == "dev"
45
44
  Requires-Dist: ruff ; extra == "dev"
46
45
  Requires-Dist: ty==0.0.84 ; extra == "dev"
47
46
  Requires-Dist: docutils ; extra == "docs"
47
+ Requires-Dist: equinox ; extra == "docs"
48
48
  Requires-Dist: jupyter ; extra == "docs"
49
49
  Requires-Dist: myst-nb ; extra == "docs"
50
50
  Requires-Dist: pandoc ; extra == "docs"
@@ -25,7 +25,6 @@ requires-python = '>=3.10'
25
25
  dependencies = [
26
26
  'beartype',
27
27
  "einops",
28
- "equinox",
29
28
  "flax",
30
29
  'fsspec',
31
30
  'jax',
@@ -47,6 +46,7 @@ Source = 'https://github.com/camml-lab/reax'
47
46
  [project.optional-dependencies]
48
47
  docs = [
49
48
  'docutils',
49
+ 'equinox', # Used by the example model in the introduction notebook
50
50
  'jupyter', # For running doc examples
51
51
  'myst-nb', # Jupyter notebooks in docs
52
52
  'pandoc',
@@ -147,13 +147,11 @@ exclude = [
147
147
  'docs/source/get_started/quick_start.ipynb',
148
148
  'examples/autoencoder.py',
149
149
  'src/reax/data/_datasource_manager.py',
150
- 'src/reax/data/_loaders.py',
151
150
  'src/reax/data/_types.py',
152
151
  'src/reax/data/collate.py',
153
152
  'src/reax/data/datamodules.py',
154
153
  'src/reax/data/datasets.py',
155
154
  'src/reax/data/fetchers.py',
156
- 'src/reax/data/samplers.py',
157
155
  'src/reax/data/utils.py',
158
156
  'src/reax/demos/boring_classes.py',
159
157
  'src/reax/demos/mnist.py',
@@ -210,6 +208,10 @@ exclude = [
210
208
  'tests/utils/test_containers.py',
211
209
  ]
212
210
 
211
+ [tool.ty.analysis]
212
+ allowed-unresolved-imports = ["torch.**"]
213
+
214
+
213
215
  [tool.pylint.MASTER]
214
216
  ignore-paths = '^src/reax/lightning/.*$' # These are copy-paste from lightning, so don't lint
215
217
 
@@ -68,4 +68,4 @@ __all__ = (
68
68
  )
69
69
  )
70
70
 
71
- __version__ = "0.7.0.dev2"
71
+ __version__ = "0.7.0.dev4"
@@ -0,0 +1 @@
1
+ """Third-party code vendored into reax."""
@@ -0,0 +1,248 @@
1
+ # Vendored from simple-pytree 0.2.3 (https://github.com/cgarciae/simple-pytree,
2
+ # commit 182178837e4e8b75021c6e622ea249564703dae3), which is no longer developed.
3
+ #
4
+ # MIT License
5
+ #
6
+ # Copyright (c) 2023 Cristian Garcia
7
+ #
8
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ # of this software and associated documentation files (the "Software"), to deal
10
+ # in the Software without restriction, including without limitation the rights
11
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ # copies of the Software, and to permit persons to whom the Software is
13
+ # furnished to do so, subject to the following conditions:
14
+ #
15
+ # The above copyright notice and this permission notice shall be included in all
16
+ # copies or substantial portions of the Software.
17
+ #
18
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24
+ # SOFTWARE.
25
+ #
26
+ # Changes from upstream:
27
+ # * Dropped the fallback for jax < 0.4.7.
28
+ # * A dataclass field counts as static if its metadata has ``pytree_node=False`` *or*
29
+ # ``static=True`` (the latter is what ``equinox.field(static=True)`` sets).
30
+ # * Static data is stored in the treedef as a sorted tuple of ``(name, value)`` pairs
31
+ # instead of an (unhashable) ``MappingProxyType``. Static fields that were never set on
32
+ # the instance are skipped rather than raising a ``KeyError``.
33
+ # * ``replace()`` always copies the instance and swaps the values, it never calls
34
+ # ``__init__`` (``dataclasses.replace`` does, which breaks custom ``__init__`` methods).
35
+ # pylint: skip-file
36
+ from abc import ABCMeta
37
+ import copy as copy_
38
+ import dataclasses
39
+ from functools import partial
40
+ import importlib.util
41
+ import typing as tp
42
+
43
+ import jax
44
+
45
+ __all__ = ("Pytree", "PytreeMeta", "is_static_field")
46
+
47
+ P = tp.TypeVar("P", bound="Pytree")
48
+
49
+ _NODE_FIELDS = "_pytree__node_fields"
50
+
51
+
52
+ def is_static_field(field: dataclasses.Field) -> bool:
53
+ """Whether the passed dataclass field is marked as static (i.e. not a pytree node)."""
54
+ return not field.metadata.get("pytree_node", True) or bool(field.metadata.get("static", False))
55
+
56
+
57
+ class PytreeMeta(ABCMeta):
58
+ def __call__(cls: type[P], *args: tp.Any, **kwargs: tp.Any) -> P:
59
+ obj: P = cls.__new__(cls, *args, **kwargs)
60
+ obj.__dict__["_pytree__initializing"] = True
61
+ try:
62
+ obj.__init__(*args, **kwargs)
63
+ finally:
64
+ del obj.__dict__["_pytree__initializing"]
65
+
66
+ vars_dict = vars(obj)
67
+ vars_dict[_NODE_FIELDS] = tuple(
68
+ sorted(field for field in vars_dict if field not in cls._pytree__static_fields)
69
+ )
70
+ return obj
71
+
72
+
73
+ class Pytree(metaclass=PytreeMeta):
74
+ _pytree__initializing: bool
75
+ _pytree__class_is_mutable: bool
76
+ _pytree__static_fields: tuple[str, ...]
77
+ _pytree__node_fields: tuple[str, ...]
78
+ _pytree__setter_descriptors: frozenset[str]
79
+
80
+ def __init_subclass__(cls, mutable: bool = False, **kwargs):
81
+ super().__init_subclass__(**kwargs)
82
+
83
+ # gather class info
84
+ class_vars = vars(cls)
85
+ setter_descriptors = set()
86
+ static_fields = _inherited_static_fields(cls)
87
+
88
+ # add special static fields
89
+ static_fields.add(_NODE_FIELDS)
90
+
91
+ for field, value in class_vars.items():
92
+ if isinstance(value, dataclasses.Field) and is_static_field(value):
93
+ static_fields.add(field)
94
+
95
+ # add setter descriptors
96
+ if hasattr(value, "__set__"):
97
+ setter_descriptors.add(field)
98
+
99
+ static_fields = tuple(sorted(static_fields))
100
+
101
+ # init class variables
102
+ cls._pytree__initializing = False
103
+ cls._pytree__class_is_mutable = mutable
104
+ cls._pytree__static_fields = static_fields
105
+ cls._pytree__setter_descriptors = frozenset(setter_descriptors)
106
+
107
+ jax.tree_util.register_pytree_with_keys(
108
+ cls,
109
+ partial(cls._pytree__flatten, with_key_paths=True),
110
+ cls._pytree__unflatten, # ty: ignore[invalid-argument-type]
111
+ flatten_func=partial(cls._pytree__flatten, with_key_paths=False),
112
+ )
113
+
114
+ # flax serialization support
115
+ if importlib.util.find_spec("flax") is not None:
116
+ from flax import serialization
117
+
118
+ serialization.register_serialization_state(
119
+ cls,
120
+ partial(cls._to_flax_state_dict, cls._pytree__static_fields),
121
+ partial(cls._from_flax_state_dict, cls._pytree__static_fields),
122
+ )
123
+
124
+ @classmethod
125
+ def _pytree__flatten(
126
+ cls,
127
+ pytree: "Pytree",
128
+ *,
129
+ with_key_paths: bool,
130
+ ) -> tuple[tuple[tp.Any, ...], tuple[tuple[str, tp.Any], ...]]:
131
+ all_vars = vars(pytree).copy()
132
+ static = tuple(
133
+ (name, all_vars.pop(name)) for name in pytree._pytree__static_fields if name in all_vars
134
+ )
135
+
136
+ if with_key_paths:
137
+ node_values = tuple(
138
+ (jax.tree_util.GetAttrKey(field), all_vars.pop(field))
139
+ for field in pytree._pytree__node_fields
140
+ )
141
+ else:
142
+ node_values = tuple(all_vars.pop(field) for field in pytree._pytree__node_fields)
143
+
144
+ if all_vars:
145
+ raise ValueError(
146
+ f"Unexpected fields in {cls.__name__}: {', '.join(all_vars.keys())}."
147
+ "You cannot add new fields to a Pytree after it has been initialized."
148
+ )
149
+
150
+ return node_values, static
151
+
152
+ @classmethod
153
+ def _pytree__unflatten(
154
+ cls: type[P],
155
+ static_fields: tuple[tuple[str, tp.Any], ...],
156
+ node_values: tuple[tp.Any, ...],
157
+ ) -> P:
158
+ pytree = object.__new__(cls)
159
+ static = dict(static_fields)
160
+ pytree.__dict__.update(zip(static[_NODE_FIELDS], node_values, strict=True))
161
+ pytree.__dict__.update(static)
162
+ return pytree
163
+
164
+ @classmethod
165
+ def _to_flax_state_dict(
166
+ cls, static_field_names: tuple[str, ...], pytree: "Pytree"
167
+ ) -> dict[str, tp.Any]:
168
+ from flax import serialization
169
+
170
+ state_dict = {
171
+ name: serialization.to_state_dict(getattr(pytree, name))
172
+ for name in pytree.__dict__
173
+ if name not in static_field_names
174
+ }
175
+ return state_dict
176
+
177
+ @classmethod
178
+ def _from_flax_state_dict(
179
+ cls,
180
+ static_field_names: tuple[str, ...],
181
+ pytree: P,
182
+ state: dict[str, tp.Any],
183
+ ) -> P:
184
+ """Restore the state of a data class."""
185
+ from flax import serialization
186
+
187
+ state = state.copy() # copy the state so we can pop the restored fields.
188
+ updates = {}
189
+ for name in pytree.__dict__:
190
+ if name in static_field_names:
191
+ continue
192
+ if name not in state:
193
+ raise ValueError(
194
+ f"Missing field {name} in state dict while restoring"
195
+ f" an instance of {type(pytree).__name__},"
196
+ f" at path {serialization.current_path()}"
197
+ )
198
+ value = getattr(pytree, name)
199
+ value_state = state.pop(name)
200
+ updates[name] = serialization.from_state_dict(value, value_state, name=name)
201
+ if state:
202
+ names = ",".join(state.keys())
203
+ raise ValueError(
204
+ f'Unknown field(s) "{names}" in state dict while'
205
+ f" restoring an instance of {type(pytree).__name__}"
206
+ f" at path {serialization.current_path()}"
207
+ )
208
+ return pytree.replace(**updates)
209
+
210
+ def replace(self: P, **kwargs: tp.Any) -> P:
211
+ """Return a copy of this object with the passed fields replaced by new values.
212
+
213
+ This never calls ``__init__``, the stored values are swapped directly.
214
+ """
215
+ unknown_keys = set(kwargs) - set(vars(self))
216
+ if unknown_keys:
217
+ raise ValueError(
218
+ f"Trying to replace unknown fields {unknown_keys} for '{type(self).__name__}'"
219
+ )
220
+
221
+ pytree = copy_.copy(self)
222
+ pytree.__dict__.update(kwargs)
223
+ return pytree
224
+
225
+ if not tp.TYPE_CHECKING:
226
+
227
+ def __setattr__(self: P, field: str, value: tp.Any):
228
+ if self._pytree__initializing or field in self._pytree__setter_descriptors:
229
+ pass
230
+ elif not hasattr(self, field) and not self._pytree__initializing:
231
+ raise AttributeError(f"Cannot add new fields to {type(self)} after initialization")
232
+ elif not self._pytree__class_is_mutable:
233
+ raise AttributeError(f"{type(self)} is immutable, trying to update field {field}")
234
+
235
+ object.__setattr__(self, field, value)
236
+
237
+
238
+ def _inherited_static_fields(cls: type) -> set[str]:
239
+ static_fields = set()
240
+ for parent_class in cls.mro():
241
+ if parent_class is not cls and parent_class is not Pytree:
242
+ if issubclass(parent_class, Pytree):
243
+ static_fields.update(parent_class._pytree__static_fields)
244
+ elif dataclasses.is_dataclass(parent_class):
245
+ for field in dataclasses.fields(parent_class):
246
+ if is_static_field(field):
247
+ static_fields.add(field.name)
248
+ return static_fields
@@ -1,5 +1,5 @@
1
- from collections.abc import Iterable, Iterator
2
- from typing import TYPE_CHECKING, Final, TypeVar
1
+ from collections.abc import Iterator
2
+ from typing import TYPE_CHECKING, Any, Final, TypeVar
3
3
 
4
4
  import beartype
5
5
  import jax
@@ -18,7 +18,8 @@ __all__ = "ArrayLoader", "CachingLoader", "ReaxDataLoader", "FetcherDataLoader",
18
18
  T = TypeVar("T")
19
19
  _U = TypeVar("_U")
20
20
  _T_co = TypeVar("_T_co", covariant=True)
21
- ArrayOrArrayTuple = jt.ArrayLike | tuple[jt.ArrayLike, ...]
21
+ Array = jax.Array | np.ndarray
22
+ ArrayOrArrayTuple = Array | tuple[Array, ...]
22
23
 
23
24
 
24
25
  def _single_or_value(value: tuple[T, ...], to_test=None) -> T | tuple[T, ...]:
@@ -37,7 +38,7 @@ class FetcherDataLoader(_types.DataLoader[_T_co, _U]):
37
38
  def __init__(
38
39
  self,
39
40
  dataset: "reax.data.Dataset[_T_co]",
40
- sampler: _types.Sampler | Iterable,
41
+ sampler: _types.Sampler,
41
42
  collate_fn: _types.CollateFn,
42
43
  ):
43
44
  # Params
@@ -54,7 +55,7 @@ class FetcherDataLoader(_types.DataLoader[_T_co, _U]):
54
55
 
55
56
  @override
56
57
  @property
57
- def sampler(self):
58
+ def sampler(self) -> "reax.data.Sampler":
58
59
  return self._sampler
59
60
 
60
61
  def __iter__(self) -> Iterator[_U]:
@@ -83,7 +84,7 @@ class ReaxDataLoader(FetcherDataLoader[_T_co, _U]):
83
84
  dataset: "reax.data.Dataset[_T_co]",
84
85
  batch_size: int = 1,
85
86
  shuffle: bool = False,
86
- sampler=None,
87
+ sampler: "reax.data.Sampler | None" = None,
87
88
  collate_fn: _types.CollateFn | None = None,
88
89
  ):
89
90
  sampler = samplers.create_sampler(
@@ -96,7 +97,7 @@ class ReaxDataLoader(FetcherDataLoader[_T_co, _U]):
96
97
  super().__init__(dataset, sampler, collate_fn)
97
98
 
98
99
 
99
- class ArrayLoader(_types.DataLoader[ArrayOrArrayTuple, ArrayOrArrayTuple]):
100
+ class ArrayLoader(_types.DataLoader[Any, ArrayOrArrayTuple]):
100
101
  """A more efficient loader for array datasets that uses .take() to batch over slices of an
101
102
  array dataset.
102
103
  """
@@ -106,12 +107,24 @@ class ArrayLoader(_types.DataLoader[ArrayOrArrayTuple, ArrayOrArrayTuple]):
106
107
  self,
107
108
  arrays: ArrayOrArrayTuple,
108
109
  batch_size: int = 1,
109
- shuffle=False,
110
+ shuffle: bool = False,
110
111
  sampler: "reax.data.Sampler | None" = None,
112
+ *,
113
+ _batched_sampler: "reax.data.Sampler | None" = None,
111
114
  ):
115
+ """Init function.
116
+
117
+ Args:
118
+ arrays: The array, or tuple of equal-length arrays, to load from.
119
+ batch_size: Number of rows per batch.
120
+ shuffle: Whether to shuffle the rows.
121
+ sampler: Optional per-row index sampler. It is batched using ``batch_size``.
122
+ _batched_sampler: Internal, used by :meth:`with_new_sampler`. An already batched
123
+ sampler that is used as-is.
124
+ """
112
125
  # Params
113
- self._batch_size: int = batch_size
114
- self._shuffle: bool = shuffle
126
+ self._batch_size: Final[int] = batch_size
127
+ self._shuffle: Final[bool] = shuffle
115
128
 
116
129
  if isinstance(arrays, tuple):
117
130
  if not all(arrays[0].shape[0] == array.shape[0] for array in arrays):
@@ -123,24 +136,26 @@ class ArrayLoader(_types.DataLoader[ArrayOrArrayTuple, ArrayOrArrayTuple]):
123
136
  first_array = arrays
124
137
 
125
138
  # State
126
- self._arrays = arrays
127
- self._sampler = samplers.create_sampler(
128
- first_array, batch_size=batch_size, shuffle=shuffle, sampler=sampler
129
- )
139
+ self._arrays: Final[ArrayOrArrayTuple] = arrays
140
+ self._sampler: reax.data.Sampler
141
+ if _batched_sampler is not None:
142
+ self._sampler = _batched_sampler
143
+ else:
144
+ self._sampler = samplers.create_sampler(
145
+ first_array, batch_size=batch_size, shuffle=shuffle, sampler=sampler
146
+ )
130
147
 
131
148
  def __iter__(self) -> Iterator[ArrayOrArrayTuple]:
132
149
  """Iter function."""
133
- for idx in self._sampler:
134
- idx = np.asarray(idx)
150
+ for indices in self._sampler:
151
+ if len(indices) == 0:
152
+ continue # Padding entry from a DistributedSampler
153
+ idx = np.asarray(indices, dtype=np.intp)
135
154
  if isinstance(self._arrays, tuple):
136
155
  yield tuple(array.take(idx, axis=0) for array in self._arrays)
137
156
  else:
138
157
  yield self._arrays.take(idx, axis=0)
139
158
 
140
- def __len__(self) -> int:
141
- """Len function."""
142
- return len(self._sampler)
143
-
144
159
  @property
145
160
  def batch_size(self) -> int:
146
161
  return self._batch_size
@@ -149,21 +164,28 @@ class ArrayLoader(_types.DataLoader[ArrayOrArrayTuple, ArrayOrArrayTuple]):
149
164
  def shuffle(self) -> bool:
150
165
  return self._shuffle
151
166
 
167
+ @override
152
168
  @property
153
169
  def dataset(self) -> ArrayOrArrayTuple:
154
170
  return self._arrays
155
171
 
172
+ @override
156
173
  @property
157
- def sampler(self):
174
+ def sampler(self) -> "reax.data.Sampler":
158
175
  return self._sampler
159
176
 
160
177
  def first(self) -> ArrayOrArrayTuple:
161
178
  """First function."""
162
179
  return next(iter(self))
163
180
 
181
+ @override
164
182
  def with_new_sampler(self, sampler: "reax.data.Sampler") -> "ArrayLoader":
183
+ # Like the other loaders, ``sampler`` replaces ``self.sampler`` (which is already batched)
165
184
  return ArrayLoader(
166
- arrays=self.dataset, batch_size=self._batch_size, shuffle=self._shuffle, sampler=sampler
185
+ arrays=self._arrays,
186
+ batch_size=self._batch_size,
187
+ shuffle=self._shuffle,
188
+ _batched_sampler=sampler,
167
189
  )
168
190
 
169
191
 
@@ -178,7 +200,7 @@ class CachingLoader(_types.DataLoader[_T_co, _U]):
178
200
  self._loader = loader
179
201
  self._reset_every = reset_every
180
202
  self._time_since_reset = 0
181
- self._cache = None
203
+ self._cache: list[_U] | None = None
182
204
 
183
205
  def __iter__(self) -> Iterator[_U]:
184
206
  """Iter function."""
@@ -205,7 +227,7 @@ class CachingLoader(_types.DataLoader[_T_co, _U]):
205
227
 
206
228
  @override
207
229
  @property
208
- def sampler(self):
230
+ def sampler(self) -> "reax.data.Sampler":
209
231
  return self._loader.sampler
210
232
 
211
233
  @override
@@ -1,11 +1,11 @@
1
1
  import abc
2
- from collections.abc import Callable, Iterable, Sequence
2
+ from collections.abc import Callable, Iterable, Sequence, Sized
3
3
  from typing import TYPE_CHECKING, Generic, TypeVar
4
4
 
5
5
  if TYPE_CHECKING:
6
6
  import reax
7
7
 
8
- __all__ = "Sampler", "DataLoader", "Dataset", "CollateFn"
8
+ __all__ = "Sampler", "DataLoader", "Dataset", "CollateFn", "BatchSampler"
9
9
 
10
10
  _T_co = TypeVar("_T_co", covariant=True)
11
11
  U = TypeVar("U")
@@ -13,6 +13,7 @@ IdxT = TypeVar("IdxT")
13
13
 
14
14
  Dataset = Iterable[_T_co] | Sequence[_T_co]
15
15
  Sampler = Iterable[IdxT]
16
+ BatchSampler = Sampler[list[IdxT]]
16
17
  CollateFn = Callable[[Sequence[_T_co]], U]
17
18
 
18
19
 
@@ -25,7 +26,10 @@ class DataLoader(Generic[_T_co, U], Iterable[U], abc.ABC):
25
26
  """
26
27
 
27
28
  def __len__(self) -> int:
28
- return len(self.sampler)
29
+ sampler = self.sampler
30
+ if not isinstance(sampler, Sized):
31
+ raise TypeError(f"Sampler {type(sampler).__name__} has no length.")
32
+ return len(sampler)
29
33
 
30
34
  @property
31
35
  @abc.abstractmethod