Document supported file formats for dask_image.imread

[K-Meech]

Currently, the docstring for dask_image.imread.imread provides no information about supported image file formats. This means it can take a bit of trial and error to determine if a particular file format can be read.

Would it be possible to update the docstring to:

• mention pims and potentially link to their documentation about built-in readers. I believe pims is what is used underneath dask_image.imread.imread?
• possibly link to dask.array.image.imread as an alternative option? It isn't immediately clear that there are two separate functions for loading images into dask.

I'd be happy to make a PR with these changes, if you think they would be useful additions.

[m-albert]

@K-Meech sorry for the delay in reacting here and thank you for raising this point, which I think is very valid!

The current implementatin of dask_image.imread.imread is far from ideal and has a number of problems that currently are only documented in this repo's issues.

I'd be happy to make a PR with these changes, if you think they would be useful additions.

Clarifying in the docstring the two points you mention would be highly appreciated!

possibly link to dask.array.image.imread as an alternative option? It isn't immediately clear that there are two separate functions for loading images into dask.

Here you could also include bioio as an alternative reader.

[K-Meech]

Sorry for the long delay in getting back to you! I've opened a small PR with these changes: #411