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

Jump to bottom

Make scico.DType type more specific #165

Closed
Michael-T-McCann opened this issue Jan 10, 2022 · 2 comments · Fixed by #415
Closed

Make scico.DType type more specific #165

Michael-T-McCann opened this issue Jan 10, 2022 · 2 comments · Fixed by #415
Labels
enhancement New feature or request priority: low Low priority

Comments

@Michael-T-McCann
Copy link
Contributor

Right now, arguments of type scico.DType can be anything:

scico/scico/typing.py

Line 29 in 445412e

DType = Any # TODO: can we do better than this? Maybe with the new numpy typing?

It would be more useful for automated type checking to set this to the types we intend to support. As a first guess, I'd say Union[np.float32, np.float64, np.complex64].
@Michael-T-McCann Michael-T-McCann added the priority: low Low priority label Jan 10, 2022
@lukepfister
Copy link
Contributor

iirc I didn’t push any further on this because DType is aliases to Any inside of jax

@bwohlberg bwohlberg added the enhancement New feature or request label Jan 11, 2022
@Michael-T-McCann Michael-T-McCann mentioned this issue Oct 5, 2022
Open
@bwohlberg
Copy link
Collaborator

bwohlberg commented May 9, 2023 •
edited

See jaxtyping. Also, note that all numpy supported dtypes are listed in numpy.sctypes. Jax only supports the numeric dtypes of length 64 or smaller, and the bool dtype.

Also, see numpy.typing, which includes ArrayLike and DTypeLike types.

bwohlberg added a commit that referenced this issue May 9, 2023
@bwohlberg
Address #165
f5a54e1
@bwohlberg bwohlberg mentioned this issue May 9, 2023
Merged
bwohlberg added a commit that referenced this issue May 15, 2023
@bwohlberg
Resolve #165 (#415)
3caa0f3 
* Add function for computing gaussian distribution

* Typing fix and better default sigma

* Address #165

* Fix docs typos and suppress apparently-spurious type error

* Target clean also cleans _autosummary directory

* Use new TypeAlias declaration

* Suppress type error

* Avoid pollution of docs with excessively long type alias definition

* Add comment as per PR review suggestion
Michael-T-McCann pushed a commit that referenced this issue May 19, 2023
@bwohlberg @tbalke
Implement #419 review recommendations (#421)
6ac40d4 
* Resolve #261 (#416)

* Improve markup for numpy.float32 etc. as well as some other docs improvements

* Add note to style docs

* Minor docs edit

* Some markup changes

* Resolve #165 (#415)

* Add function for computing gaussian distribution

* Typing fix and better default sigma

* Address #165

* Fix docs typos and suppress apparently-spurious type error

* Target clean also cleans _autosummary directory

* Use new TypeAlias declaration

* Suppress type error

* Avoid pollution of docs with excessively long type alias definition

* Add comment as per PR review suggestion

* Resolve #83 (#417)

* Attempt to remove rtd edit on github button

* Bump jaxlib/jax max versions

* Remove function no longer in jax.numpy

* Resolve #377 (#418)

* Fix markup

* Docstring edits

* Change sphinx theme

* Docstring fixes

* Theme customization

* Clean up

* Fix inheritance diagram insertion

* Resolve document not in any toctree warning for index.ipynb

* Clean up

* Update submodule

* Adjust css

* Avoid problems with dark mode

* Add version number in sidebar

* Change inheritance diagram color scheme

* Clean up

* Correct path to docs_requirements

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>

* Implement PR review recommendations

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>
Michael-T-McCann added a commit that referenced this issue May 19, 2023
@Michael-T-McCann @bwohlberg @tbalke
Add broadcast_block_shapes (#419)
a09343d 
* Rename test file

* Add function and tests

* Replace try-and-see code with new function

* Implement #419 review recommendations (#421)

* Resolve #261 (#416)

* Improve markup for numpy.float32 etc. as well as some other docs improvements

* Add note to style docs

* Minor docs edit

* Some markup changes

* Resolve #165 (#415)

* Add function for computing gaussian distribution

* Typing fix and better default sigma

* Address #165

* Fix docs typos and suppress apparently-spurious type error

* Target clean also cleans _autosummary directory

* Use new TypeAlias declaration

* Suppress type error

* Avoid pollution of docs with excessively long type alias definition

* Add comment as per PR review suggestion

* Resolve #83 (#417)

* Attempt to remove rtd edit on github button

* Bump jaxlib/jax max versions

* Remove function no longer in jax.numpy

* Resolve #377 (#418)

* Fix markup

* Docstring edits

* Change sphinx theme

* Docstring fixes

* Theme customization

* Clean up

* Fix inheritance diagram insertion

* Resolve document not in any toctree warning for index.ipynb

* Clean up

* Update submodule

* Adjust css

* Avoid problems with dark mode

* Add version number in sidebar

* Change inheritance diagram color scheme

* Clean up

* Correct path to docs_requirements

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>

* Implement PR review recommendations

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>

---------

Co-authored-by: Brendt Wohlberg <bwohlberg@users.noreply.github.com>
Co-authored-by: Thilo Balke <thilo.balke@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request priority: low Low priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Resolve #165 lanl/scico
3 participants
@lukepfister @bwohlberg @Michael-T-McCann