1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
"""
Types for iminuit.
These are used by mypy and similar tools.
"""
from typing import (
Protocol,
Optional,
List,
Union,
runtime_checkable,
NamedTuple,
Annotated,
)
from numpy.typing import NDArray
import numpy as np
import dataclasses
# Key for ValueView, ErrorView, etc.
Key = Union[int, str, slice, List[Union[int, str]]]
@runtime_checkable
class Model(Protocol):
"""Type for user-defined model."""
def __call__(self, x: np.ndarray, *args: float) -> np.ndarray:
"""Evaluate model at locations x and return results as an array."""
... # pragma: no cover
@runtime_checkable
class ModelGradient(Protocol):
"""Type for user-defined model gradient."""
def __call__(self, x: np.ndarray, *args: float) -> np.ndarray:
"""Evaluate model gradient at locations x and return results as an array."""
... # pragma: no cover
@runtime_checkable
class Cost(Protocol):
"""Type for user-defined cost function."""
def __call__(self, *args: float) -> float:
"""Evaluate cost and return results as a float."""
... # pragma: no cover
@runtime_checkable
class CostGradient(Protocol):
"""Type for user-defined gradient of a cost function."""
def __call__(self, *args: float) -> np.ndarray:
"""Evaluate gradient and return results as an array."""
... # pragma: no cover
@runtime_checkable
class LossFunction(Protocol):
"""Type for user-defined loss function for LeastSquares clas."""
def __call__(self, z: NDArray) -> NDArray:
"""Evaluate loss function on values."""
... # pragma: no cover
class UserBound(NamedTuple):
"""Type for user-defined limit."""
min: Optional[float]
max: Optional[float]
@dataclasses.dataclass
class Gt:
"""Annotation compatible with annotated-types."""
gt: float
@dataclasses.dataclass
class Ge:
"""Annotation compatible with annotated-types."""
ge: float
@dataclasses.dataclass
class Lt:
"""Annotation compatible with annotated-types."""
lt: float
@dataclasses.dataclass
class Le:
"""Annotation compatible with annotated-types."""
le: float
@dataclasses.dataclass
class Interval:
"""Annotation compatible with annotated-types."""
gt: Optional[float] = None
ge: Optional[float] = None
lt: Optional[float] = None
le: Optional[float] = None
# common convenience types
PositiveFloat = Annotated[float, Gt(0)]
Probability = Annotated[float, Interval(ge=0, le=1)]
|