refactor: add type hints to maths/softmax.py #14153
Conversation
poyea
force-pushed
the
type-hint-cleanup
branch
from
3207df5 to
f76d44d
Compare
algorithms-keeper
bot
removed
the
awaiting reviews
There was a problem hiding this comment.
Pull request overview
Adds modern Python type hints to maths/softmax.py to improve readability and align the function signature with current typing style.
Changes:
- Annotated
softmax()input and return types using PEP 604 unions. - Cleaned up docstring formatting and doctest inputs for consistency.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
|
|
||
| def softmax(vector): | ||
| def softmax(vector: np.ndarray | list | tuple) -> np.ndarray: |
There was a problem hiding this comment.
The new annotation vector: np.ndarray | list | tuple is very broad and loses element-type information. Consider using a typed protocol/ABC (e.g., Sequence[float] from collections.abc) for list/tuple inputs and/or specifying element types (e.g., list[float] | tuple[float, ...]) to make the type hint more informative and consistent with other modules (e.g., maths/polynomial_evaluation.py).
| def softmax(vector: np.ndarray | list | tuple) -> np.ndarray: | |
| def softmax(vector: np.ndarray | list[float] | tuple[float, ...]) -> np.ndarray: |
| vector (np.array | list | tuple): A numpy array of shape (1,n) | ||
| consisting of real values or a similar list, tuple | ||
| Returns: | ||
| softmax_vec (np.array): The input numpy array after applying | ||
| softmax. | ||
| np.array: The input numpy array after applying softmax. |
There was a problem hiding this comment.
The docstring uses np.array as a type name in Parameters/Returns, but the function returns an np.ndarray and np.array is the constructor function. Updating the docstring to np.ndarray (and adjusting the described shape to match the 1-D examples) would avoid confusion and keep documentation consistent with the new type hints.
2 participants
Added modern type hints (np.ndarray | list | tuple) to the softmax function to improve code readability and compliance with current Python standards. Verified with doctest (4 passed)