Skip to content

changes Strategies to a RATEnum #65

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.

Sign up for GitHub

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

Merged
alexhroom merged 4 commits into from
Aug 20, 2024
Merged

changes Strategies to a RATEnum #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad61244
changed Strategies to a RATEnum
alexhroom Aug 13, 2024
8b4cf3e
Update enums.py
alexhroom Aug 13, 2024
2af0c14
added integer input
alexhroom Aug 19, 2024
d2eeab3
throws error for bad indices
alexhroom Aug 19, 2024
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
2 changes: 1 addition & 1 deletion RATapi/inputs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ def make_controls(input_controls: RATapi.Controls, checks: Checks) -> Control:
controls.populationSize = input_controls.populationSize
controls.fWeight = input_controls.fWeight
controls.crossoverProbability = input_controls.crossoverProbability
controls.strategy = input_controls.strategy.value # Required for the IntEnum
controls.strategy = int(input_controls.strategy) # RAT core expects strategy as an integer
controls.targetValue = input_controls.targetValue
controls.numGenerations = input_controls.numGenerations
# NS
Expand Down
31 changes: 22 additions & 9 deletions RATapi/utils/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from enum import Enum
from typing import Union

try:
from enum import StrEnum
Expand Down Expand Up @@ -48,15 +48,28 @@ class Display(RATEnum):
Final = "final"


class Strategies(Enum):
"""Defines the available options for strategies"""
class Strategies(RATEnum):
"""Defines the available options for differential evolution strategies"""

Random = 1
LocalToBest = 2
BestWithJitter = 3
RandomWithPerVectorDither = 4
RandomWithPerGenerationDither = 5
RandomEitherOrAlgorithm = 6
Random = "random"
LocalToBest = "local to best"
BestWithJitter = "best jitter"
RandomWithPerVectorDither = "vector dither"
RandomWithPerGenerationDither = "generation dither"
RandomEitherOrAlgorithm = "either or"

@classmethod
def _missing_(cls, value: Union[int, str]):
# legacy compatibility with strategies being 1-indexed ints under the hood
if isinstance(value, int):
if value < 1 or value > 6:
raise IndexError("Strategy indices must be between 1 and 6.")
return list(cls)[value - 1]
return super()._missing_(value)

def __int__(self):
# as RAT core expects strategy as an integer
return list(Strategies).index(self) + 1


class BoundHandling(RATEnum):
Expand Down
34 changes: 17 additions & 17 deletions tests/test_controls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,23 +374,23 @@ def setup_class(self):
@pytest.fixture
def table_str(self):
table_str = (
"+----------------------+--------------------------------------+\n"
"| Property | Value |\n"
"+----------------------+--------------------------------------+\n"
"| procedure | de |\n"
"| parallel | single |\n"
"| calcSldDuringFit | False |\n"
"| resampleParams | [0.9, 50] |\n"
"| display | iter |\n"
"| populationSize | 20 |\n"
"| fWeight | 0.5 |\n"
"| crossoverProbability | 0.8 |\n"
"| strategy | Strategies.RandomWithPerVectorDither |\n"
"| targetValue | 1.0 |\n"
"| numGenerations | 500 |\n"
"| updateFreq | 1 |\n"
"| updatePlotFreq | 20 |\n"
"+----------------------+--------------------------------------+"
"+----------------------+---------------+\n"
"| Property | Value |\n"
"+----------------------+---------------+\n"
"| procedure | de |\n"
"| parallel | single |\n"
"| calcSldDuringFit | False |\n"
"| resampleParams | [0.9, 50] |\n"
"| display | iter |\n"
"| populationSize | 20 |\n"
"| fWeight | 0.5 |\n"
"| crossoverProbability | 0.8 |\n"
"| strategy | vector dither |\n"
"| targetValue | 1.0 |\n"
"| numGenerations | 500 |\n"
"| updateFreq | 1 |\n"
"| updatePlotFreq | 20 |\n"
"+----------------------+---------------+"
)

return table_str
Expand Down
6 changes: 6 additions & 0 deletions tests/test_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
Priors,
Procedures,
RATEnum,
Strategies,
TypeOptions,
)

Expand Down Expand Up @@ -98,3 +99,8 @@ def test_alternative_spellings(test_enum: Callable, test_str: str, expected_valu
assert test_enum(test_str) == expected_value
assert test_enum(test_str.upper()) == expected_value
assert test_enum(test_str.title()) == expected_value


def test_integer_strategies():
"""Test that strategies can be input as integers."""
assert [Strategies(i) for i in range(1, len(Strategies) + 1)] == list(Strategies)