Skip to content

Choice

Bases: Collection[T]

A list of values to choose from in a hyperparameter search.

Source code in src/safeds/ml/hyperparameters/_choice.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
class Choice(Collection[T]):
    """A list of values to choose from in a hyperparameter search."""

    def __init__(self, *args: T) -> None:
        """
        Create a new choice. Duplicate values will be removed.

        Duplicate values will be removed.

        Parameters
        ----------
        *args:
            The values to choose from.
        """
        if len(args) < 1:
            raise EmptyChoiceError
        self.elements = list(dict.fromkeys(args))

    def __contains__(self, value: Any) -> bool:
        """
        Check if a value is in this choice.

        Parameters
        ----------
        value:
            The value to check.

        Returns
        -------
        is_in_choice:
            Whether the value is in this choice.
        """
        return value in self.elements

    def __iter__(self) -> Iterator[T]:
        """
        Iterate over the values of this choice.

        Returns
        -------
        iterator:
            An iterator over the values of this choice.
        """
        return iter(self.elements)

    def __len__(self) -> int:
        """
        Get the number of values in this choice.

        Returns
        -------
        value_count:
            The number of values in this choice.
        """
        return len(self.elements)

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, Choice):
            return NotImplemented
        if self is other:
            return True
        return (self is other) or (self.elements == other.elements)

elements = list(dict.fromkeys(args))