Skip to content
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

docs: Add typehint aliases #1969

Merged
merged 5 commits into from
Aug 29, 2022
Merged

docs: Add typehint aliases #1969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da7717a
add configuration for rendering docs
kratsg Aug 29, 2022
882fbaf
found a typo in how we wrote out the dtype signature type
kratsg Aug 29, 2022
bfc64d0
drop print
kratsg Aug 29, 2022
950b0cb
Merge branch 'master' into docs/autodoc_type_aliases
kratsg Aug 29, 2022
222d3ab
Merge branch 'master' into docs/autodoc_type_aliases
matthewfeickert Aug 29, 2022
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
30 changes: 30 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,36 @@ def setup(app):
'tensorflow_probability',
]


_type_aliases_inverted = {
'pyhf.typing': [
'PathOrStr',
'ParameterBase',
'Parameter',
'Measurement',
'ModifierBase',
'NormSys',
'NormFactor',
'HistoSys',
'StatError',
'ShapeSys',
'ShapeFactor',
'LumiSys',
'Modifier',
'Sample',
'Channel',
'Observation',
'Workspace',
'Literal',
],
'numpy.typing': ['ArrayLike', 'DTypeLike', 'NBitBase', 'NDArray'],
}
autodoc_type_aliases = {
item: f'{k}.{item}' for k, v in _type_aliases_inverted.items() for item in v
}

autodoc_typehints_format = 'fully-qualified'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
Expand Down
14 changes: 5 additions & 9 deletions src/pyhf/tensor/numpy_backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
T = TypeVar("T", bound=NBitBase)

Tensor = Union["NDArray[np.number[T]]", "NDArray[np.bool_]"]

FloatIntOrBool = Literal["float", "int", "bool"]
log = logging.getLogger(__name__)


Expand Down Expand Up @@ -53,7 +53,7 @@ def __init__(self, **kwargs: dict[str, str]):
self.name = 'numpy'
self.precision = kwargs.get('precision', '64b')
self.dtypemap: Mapping[
Literal['float', 'int', 'bool'],
FloatIntOrBool,
DTypeLike, # Type[np.floating[T]] | Type[np.integer[T]] | Type[np.bool_],
] = {
'float': np.float64 if self.precision == '64b' else np.float32,
Expand Down Expand Up @@ -206,7 +206,7 @@ def isfinite(self, tensor: Tensor[T]) -> NDArray[np.bool_]:
return np.isfinite(tensor)

def astensor(
self, tensor_in: ArrayLike, dtype: Literal['float'] = 'float'
self, tensor_in: ArrayLike, dtype: FloatIntOrBool = 'float'
) -> ArrayLike:
"""
Convert to a NumPy array.
Expand Down Expand Up @@ -247,9 +247,7 @@ def product(self, tensor_in: Tensor[T], axis: Shape | None = None) -> ArrayLike:
def abs(self, tensor: Tensor[T]) -> ArrayLike:
return np.abs(tensor)

def ones(
self, shape: Shape, dtype: Literal["float", "int", "bool"] = "float"
) -> ArrayLike:
def ones(self, shape: Shape, dtype: FloatIntOrBool = "float") -> ArrayLike:
try:
dtype_obj = self.dtypemap[dtype]
except KeyError:
Expand All @@ -261,9 +259,7 @@ def ones(

return np.ones(shape, dtype=dtype_obj)

def zeros(
self, shape: Shape, dtype: Literal["float", "int", "bool"] = "float"
) -> ArrayLike:
def zeros(self, shape: Shape, dtype: FloatIntOrBool = "float") -> ArrayLike:
try:
dtype_obj = self.dtypemap[dtype]
except KeyError:
Expand Down