reax 0.7.0.dev4__tar.gz → 0.7.0.dev5__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 (103) hide show
  1. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/PKG-INFO +1 -1
  2. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/__init__.py +1 -1
  3. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/early_stopping.py +17 -3
  4. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/modules.py +3 -3
  5. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/results.py +6 -4
  6. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/_loops.py +1 -1
  7. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/stages.py +1 -1
  8. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/trainer.py +1 -1
  9. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/types.py +4 -0
  10. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/LICENSE.txt +0 -0
  11. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/README.rst +0 -0
  12. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/pyproject.toml +0 -0
  13. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/_engine.py +0 -0
  14. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/_module_hooks.py +0 -0
  15. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/_vendor/__init__.py +0 -0
  16. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/_vendor/simple_pytree.py +0 -0
  17. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/__init__.py +0 -0
  18. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/_datasource_manager.py +0 -0
  19. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/_datasources.py +0 -0
  20. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/_loaders.py +0 -0
  21. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/_types.py +0 -0
  22. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/collate.py +0 -0
  23. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/dataloaders.py +0 -0
  24. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/datamodules.py +0 -0
  25. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/datasets.py +0 -0
  26. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/fetchers.py +0 -0
  27. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/kfold.py +0 -0
  28. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/samplers.py +0 -0
  29. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/data/utils.py +0 -0
  30. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/demos/__init__.py +0 -0
  31. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/demos/boring_classes.py +0 -0
  32. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/demos/mnist.py +0 -0
  33. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/exceptions.py +0 -0
  34. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/hooks.py +0 -0
  35. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/keys.py +0 -0
  36. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/lightning/LICENSE +0 -0
  37. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/lightning/__init__.py +0 -0
  38. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/lightning/rank_zero.py +0 -0
  39. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/__init__.py +0 -0
  40. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/checkpointer.py +0 -0
  41. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/model_checkpoint.py +0 -0
  42. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/progress/__init__.py +0 -0
  43. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/progress/progress_bar.py +0 -0
  44. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/progress/rich_progress.py +0 -0
  45. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/progress/tqdm_progress.py +0 -0
  46. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/listeners/utils.py +0 -0
  47. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/__init__.py +0 -0
  48. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/_utils.py +0 -0
  49. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/csv_logs.py +0 -0
  50. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/logger.py +0 -0
  51. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/mlflow.py +0 -0
  52. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/pandas.py +0 -0
  53. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/loggers/tensorboard.py +0 -0
  54. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/__init__.py +0 -0
  55. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/_classification.py +0 -0
  56. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/_evaluators.py +0 -0
  57. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/_globals.py +0 -0
  58. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/_metric.py +0 -0
  59. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/_registry.py +0 -0
  60. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/aggregation.py +0 -0
  61. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/collections.py +0 -0
  62. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/jm/__init__.py +0 -0
  63. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/jm/types.py +0 -0
  64. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/jm/utils.py +0 -0
  65. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/regression.py +0 -0
  66. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/metrics/utils.py +0 -0
  67. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/optimizers.py +0 -0
  68. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/plugins.py +0 -0
  69. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/profilers/__init__.py +0 -0
  70. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/profilers/jax_profiler.py +0 -0
  71. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/profilers/profiler.py +0 -0
  72. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/pytree.py +0 -0
  73. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/random.py +0 -0
  74. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/saving.py +0 -0
  75. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/__init__.py +0 -0
  76. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/_timer.py +0 -0
  77. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/common.py +0 -0
  78. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/fit.py +0 -0
  79. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/predict.py +0 -0
  80. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/stats.py +0 -0
  81. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/test.py +0 -0
  82. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/train.py +0 -0
  83. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/stages/validation.py +0 -0
  84. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/__init__.py +0 -0
  85. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/_factory.py +0 -0
  86. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/_jax.py +0 -0
  87. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/_parallel.py +0 -0
  88. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/_single_device.py +0 -0
  89. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/_strategies.py +0 -0
  90. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/strategies/_utils.py +0 -0
  91. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/testing.py +0 -0
  92. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/__init__.py +0 -0
  93. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/_checkpoint_connector.py +0 -0
  94. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/_checkpointing.py +0 -0
  95. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/_hooks_map.py +0 -0
  96. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/_logger_connector.py +0 -0
  97. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/training/_utils.py +0 -0
  98. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/utils/__init__.py +0 -0
  99. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/utils/arrays.py +0 -0
  100. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/utils/containers.py +0 -0
  101. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/utils/events.py +0 -0
  102. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/utils/grads.py +0 -0
  103. {reax-0.7.0.dev4 → reax-0.7.0.dev5}/src/reax/utils/masking.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: reax
3
- Version: 0.7.0.dev4
3
+ Version: 0.7.0.dev5
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>
@@ -68,4 +68,4 @@ __all__ = (
68
68
  )
69
69
  )
70
70
 
71
- __version__ = "0.7.0.dev4"
71
+ __version__ = "0.7.0.dev5"
@@ -106,6 +106,9 @@ class EarlyStopping(hooks.TrainerListener):
106
106
  log_rank_zero_only (bool, optional): When set ``True``, logs the
107
107
  status of the early stopping listener only for rank 0
108
108
  process, defaults to False.
109
+ start_from_epoch (int, optional): Epoch at which early stopping
110
+ checks should begin. Checks will not run if the current epoch
111
+ is strictly less than ``start_from_epoch``, defaults to 0.
109
112
 
110
113
  Raises:
111
114
  MisconfigurationException: If ``mode`` is none of ``"min"`` or
@@ -138,6 +141,7 @@ class EarlyStopping(hooks.TrainerListener):
138
141
  divergence_threshold: float | None = None,
139
142
  check_on_train_epoch_end: bool | None = None,
140
143
  log_rank_zero_only: bool = False,
144
+ start_from_epoch: int = 0,
141
145
  ):
142
146
  # Params
143
147
  self._monitor: Final[str] = monitor
@@ -152,6 +156,7 @@ class EarlyStopping(hooks.TrainerListener):
152
156
  self.__check_on_train_epoch_end = check_on_train_epoch_end
153
157
  self._log_rank_zero_only = log_rank_zero_only
154
158
  self._min_delta: Final[float] = min_delta if mode == "max" else -min_delta
159
+ self._start_from_epoch: Final[int] = start_from_epoch
155
160
 
156
161
  # State
157
162
  self._check_on_train_epoch_end = check_on_train_epoch_end
@@ -175,7 +180,9 @@ class EarlyStopping(hooks.TrainerListener):
175
180
 
176
181
  def _should_skip_check(self, trainer: "reax.Trainer") -> bool:
177
182
  """Should skip check."""
178
- return not isinstance(trainer.stage, stages.Fit) and not trainer.sanity_checking
183
+ if trainer.current_epoch < self._start_from_epoch:
184
+ return True
185
+ return not isinstance(trainer.stage, stages.Fit) or trainer.sanity_checking
179
186
 
180
187
  @override
181
188
  def on_fit_start(self, _trainer: "reax.Trainer", stage: "reax.stages.Fit", /) -> None:
@@ -197,8 +204,15 @@ class EarlyStopping(hooks.TrainerListener):
197
204
  self._run_early_stopping_check(trainer, stage)
198
205
 
199
206
  @override
200
- def on_validation_end(self, trainer: "reax.Trainer", stage: "reax.stages.Validate", /) -> None:
201
- """On validation end."""
207
+ def on_validation_epoch_end(
208
+ self, trainer: "reax.Trainer", stage: "reax.Stage", _loop: "reax.stages.ValidationEpoch", /
209
+ ) -> None:
210
+ """On validation epoch end.
211
+
212
+ Validation nested inside ``fit`` fires this hook, whereas ``on_validation_end`` only
213
+ fires for a standalone validation stage. This is therefore where the check has to run
214
+ when ``check_on_train_epoch_end`` is false.
215
+ """
202
216
  if self._check_on_train_epoch_end or self._should_skip_check(trainer):
203
217
  return
204
218
  self._run_early_stopping_check(trainer, stage)
@@ -186,7 +186,7 @@ class Module(
186
186
  value: MetricType,
187
187
  *,
188
188
  prog_bar: bool = False,
189
- batch_size: int | None = None,
189
+ batch_size: "reax.types.BatchSize | None" = None,
190
190
  logger: bool | None = None,
191
191
  on_step=True,
192
192
  on_epoch=True,
@@ -250,7 +250,7 @@ class Module(
250
250
  logger: bool | None = None,
251
251
  on_step: bool | None = None,
252
252
  on_epoch: bool | None = None,
253
- batch_size: int | None = None,
253
+ batch_size: "reax.types.BatchSize | None" = None,
254
254
  ) -> None:
255
255
  """Log a dictionary of values at once.
256
256
 
@@ -275,7 +275,7 @@ class Module(
275
275
  determined by the hook. See
276
276
  :ref:`extensions/logging:Automatic Logging` for details,
277
277
  defaults to None.
278
- batch_size (Optional[int], optional): Current batch size.
278
+ batch_size (Optional[int | jax.Array], optional): Current batch size.
279
279
  This will be directly inferred from the loaded batch,
280
280
  but some data structures might need to explicitly
281
281
  provide it, defaults to None.
@@ -45,7 +45,7 @@ class ArrayResultMetric(_metric.Metric[jax.Array]):
45
45
  # pylint: disable=arguments-differ
46
46
  cls,
47
47
  value: jt.ArrayLike,
48
- batch_size: int | None = None,
48
+ batch_size: "reax.types.BatchSize | None" = None,
49
49
  reduce_fn: "reax.types.ReduceFn" = "mean",
50
50
  ) -> "ArrayResultMetric":
51
51
  """Create function."""
@@ -61,7 +61,7 @@ class ArrayResultMetric(_metric.Metric[jax.Array]):
61
61
  # pylint: disable=arguments-differ
62
62
  self,
63
63
  value: jt.ArrayLike,
64
- batch_size: int | None = None,
64
+ batch_size: "reax.types.BatchSize | None" = None,
65
65
  ) -> "ArrayResultMetric":
66
66
  """Update function."""
67
67
  weight = _weight(batch_size, self.reduce_fn)
@@ -96,7 +96,9 @@ class ArrayResultMetric(_metric.Metric[jax.Array]):
96
96
  return self.value / self.weight
97
97
 
98
98
 
99
- def _weight(batch_size: int | None, reduce_fn: "reax.types.ReduceFn") -> int:
99
+ def _weight(
100
+ batch_size: "reax.types.BatchSize | None", reduce_fn: "reax.types.ReduceFn"
101
+ ) -> "reax.types.BatchSize":
100
102
  """How much a value logged with ``batch_size`` counts for.
101
103
 
102
104
  Totals are added up as they are, so they carry no weight. Averages are weighted by the number
@@ -162,7 +164,7 @@ class ResultCollection(dict[str, ResultEntry]):
162
164
  logger: bool = False,
163
165
  on_step: bool = False,
164
166
  on_epoch: bool = True,
165
- batch_size: int | None = None,
167
+ batch_size: "reax.types.BatchSize | None" = None,
166
168
  reduce_fn: "reax.types.ReduceFn" = "mean",
167
169
  ):
168
170
  """Log function.
@@ -490,7 +490,7 @@ class LoopOverBatches(Loop[_DataStageT]):
490
490
  self,
491
491
  name: str,
492
492
  value: "jt.ArrayLike | reax.types.MetricInstance",
493
- batch_size: int | None = None,
493
+ batch_size: "reax.types.BatchSize | None" = None,
494
494
  prog_bar: bool = False,
495
495
  logger: bool = False,
496
496
  on_step=False,
@@ -224,7 +224,7 @@ class Stage(abc.ABC):
224
224
  self,
225
225
  name: str,
226
226
  value,
227
- batch_size: int | None = None,
227
+ batch_size: "reax.types.BatchSize | None" = None,
228
228
  prog_bar: bool = False,
229
229
  logger: bool = False,
230
230
  on_step=False,
@@ -432,7 +432,7 @@ class Trainer(stages.StageListener):
432
432
  value,
433
433
  *,
434
434
  prog_bar: bool = False,
435
- batch_size: int | None = None,
435
+ batch_size: "reax.types.BatchSize | None" = None,
436
436
  logger: bool | None = None,
437
437
  on_step=True,
438
438
  on_epoch=True,
@@ -17,6 +17,10 @@ MetricsDict = dict[str, ScalarLike]
17
17
  #: single value at the end of it: either their mean, or their total.
18
18
  ReduceFn = Literal["sum", "mean"]
19
19
 
20
+ #: The number of samples in a batch. This can be a (scalar) JAX array, so that it can be computed
21
+ #: on the device (e.g. from a padding mask) without forcing a sync with the host.
22
+ BatchSize = int | jax.Array
23
+
20
24
 
21
25
  @runtime_checkable
22
26
  class MetricType(Protocol[_OutT]):
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