Created
September 9, 2023 18:14
-
-
Save BlackHC/841cf8fb02722456a2147dd4d3e67305 to your computer and use it in GitHub Desktop.
Generic Early Stopping Generator
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| """ | |
| MIT License | |
| Copyright (c) 2023 Andreas 'blackhc' Kirsch | |
| Permission is hereby granted, free of charge, to any person obtaining a copy | |
| of this software and associated documentation files (the "Software"), to deal | |
| in the Software without restriction, including without limitation the rights | |
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| copies of the Software, and to permit persons to whom the Software is | |
| furnished to do so, subject to the following conditions: | |
| The above copyright notice and this permission notice shall be included in all | |
| copies or substantial portions of the Software. | |
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| SOFTWARE. | |
| """ | |
| import operator | |
| from dataclasses import dataclass | |
| @dataclass | |
| class EarlyStopping: | |
| """Early stopping generator. | |
| We can zip this generator with the training loop to stop training early. | |
| :param patience: how many epochs/upddates to wait for improvement. | |
| :param lower_is_better: whether a lower value is better. | |
| """ | |
| patience: int | |
| lower_is_better: bool = True | |
| def __post_init__(self): | |
| self.max_patience = self.patience | |
| if self.lower_is_better: | |
| self.best_score = float("inf") | |
| self.cmp = operator.lt | |
| else: | |
| self.best_score = -float("inf") | |
| self.cmp = operator.gt | |
| @property | |
| def patience_remaining(self) -> bool: | |
| return self.patience >= 0 | |
| def step(self, score): | |
| assert self.patience_remaining | |
| if self.cmp(score, self.best_score): | |
| self.best_score = score | |
| self.patience = self.max_patience | |
| else: | |
| self.patience -= 1 | |
| return self.patience_remaining | |
| def __iter__(self): | |
| while self.patience_remaining: | |
| yield self.step | |
| print("Early stopping with best score:", self.best_score) | |
| def test_early_stopping_improves(): | |
| # Test case where score improves every time | |
| early_stopping = EarlyStopping(patience=3, lower_is_better=True) | |
| scores = [0.5, 0.4, 0.3, 0.2, 0.1] | |
| for score in scores: | |
| assert early_stopping.step(score) > 0 | |
| assert early_stopping.best_score == 0.1 | |
| assert early_stopping.cmp == operator.lt | |
| def test_early_stopping_improves_with_higher_is_better(): | |
| # Test case where score improves every time and higher is better | |
| early_stopping = EarlyStopping(patience=3, lower_is_better=False) | |
| scores = [0.1, 0.2, 0.3, 0.4, 0.5] | |
| for score in scores: | |
| assert early_stopping.step(score) > 0 | |
| assert early_stopping.best_score == 0.5 | |
| assert early_stopping.cmp == operator.gt | |
| def test_early_stopping_does_not_improve(): | |
| import pytest | |
| # Test case where score never improves | |
| early_stopping = EarlyStopping(patience=2, lower_is_better=True) | |
| scores = [0.5, 0.6, 0.7, 0.8, 0.9] | |
| for i, score in enumerate(scores): | |
| if i < 3: | |
| assert early_stopping.step(score) | |
| elif i == 3: | |
| assert not early_stopping.step(score) | |
| else: | |
| with pytest.raises(AssertionError): | |
| early_stopping.step(score) | |
| assert early_stopping.best_score == 0.5 | |
| assert early_stopping.cmp == operator.lt | |
| def test_early_stopping_improves_sometimes(): | |
| # Test case where score improves sometimes | |
| early_stopping = EarlyStopping(patience=1, lower_is_better=True) | |
| scores = [0.5, 0.6, 0.4, 0.7, 0.3] | |
| for i, score in enumerate(scores): | |
| assert early_stopping.step(score) | |
| assert early_stopping.patience != (i % 2) | |
| assert early_stopping.best_score == 0.3 | |
| assert early_stopping.cmp == operator.lt | |
| def test_early_stopping_iter(): | |
| # Test case for __iter__ method | |
| early_stopping = EarlyStopping(patience=1, lower_is_better=True) | |
| scores = [0.5, 0.6, 0.7, 0.8] | |
| for score, _ in zip(scores, early_stopping): | |
| early_stopping.step(score) | |
| assert early_stopping.best_score == 0.5 | |
| assert early_stopping.cmp == operator.lt | |
| assert score == 0.7 | |
| def test_early_stopping_to_str(): | |
| # Test case for __str__ method | |
| early_stopping = EarlyStopping(patience=1, lower_is_better=True) | |
| assert str(early_stopping) == "EarlyStopping(patience=1, lower_is_better=True)" | |
| # Run pytests | |
| if __name__ == "__main__": | |
| import pytest | |
| pytest.main([__file__]) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment