[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

[WIP] torch DataSet + utils - #145

Merged
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader
Mar 14, 2023
Merged

[WIP] torch DataSet + utils#145
LucaMarconato merged 23 commits into
scverse:mainfrom
kevinyamauchi:torch-dataloader

Conversation

@kevinyamauchi

@kevinyamauchikevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
Collaborator

This PR adds a torch DataSet with some addition utils. Initially, this implements a spot ROI dataset for replicating this squidpy example. The DataSet is implemented such that it is compatible with monai and pytorch lightning, which gives us access to a ton of tooling (e.g., multi-GPU training, tensorboard logging, learning rate schedulers).

This PR requires #132, #143, and image bounding box query with transforms to be merged.

@codecov

codecovBot commented Feb 20, 2023

Copy link
Copy Markdown

Codecov Report

Merging #145 (41d818a) into main (9975a5c) will decrease coverage by 2.64%.
The diff coverage is 34.61%.

Additional details and impacted files
@@ Coverage Diff @@## main #145 +/- ##
==========================================
- Coverage 89.59% 86.95% -2.64% 
==========================================
Files 24 27 +3 Lines 3854 3995 +141 ==========================================
+ Hits 3453 3474 +21 - Misses 401 521 +120 
Impacted FilesCoverage Δ
spatialdata/_core/data_extent.py0.00% <0.00%> (ø)
spatialdata/_dataloader/transforms.py0.00% <0.00%> (ø)
spatialdata/_dataloader/datasets.py6.84% <6.84%> (ø)
spatialdata/utils.py84.52% <12.50%> (-3.61%)⬇️
spatialdata/__init__.py93.33% <83.33%> (-6.67%)⬇️
spatialdata/_core/_spatialdata.py91.20% <86.36%> (-0.27%)⬇️
spatialdata/_core/_rasterize.py83.00% <100.00%> (+0.34%)⬆️
spatialdata/_core/_spatial_query.py93.82% <100.00%> (-0.42%)⬇️
spatialdata/_core/core_utils.py91.91% <100.00%> (-0.27%)⬇️
spatialdata/_core/models.py86.14% <100.00%> (ø)

@kevinyamauchi

kevinyamauchi commented Feb 20, 2023

Copy link
Copy Markdown
CollaboratorAuthor

I have created an example notebook showing how the Dataset and transforms work for the SpotCropDataset. We can now generate tiles such that they are compatible with monai, torchvision, and pytorch lightning, so we can add tons of augmentations, dataloader cacheing, multiGPU, etc.. Once #132 lands, I can update the spot centroid fetching to use the polygons item.

https://gist.github.com/kevinyamauchi/3a1d1c375b084732c5f60b19afabf461

@kevinyamauchi

Copy link
Copy Markdown
CollaboratorAuthor

I've updated it to now use the Shapes element to get the spot locations. See the example notebook below:

https://gist.github.com/kevinyamauchi/77f986889b7626db4ab3c1075a3a3e5e

@LucaMarconato

Copy link
Copy Markdown
Member

minor features of this PR:

  • overloading of __get_item__() and __set_item__() for SpatialData.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have pushed a code that has still open todos and bugs to fix, but it is usable. An example of usage is in this script from the sandbox (which run like this shows a bug.

But if you use it

  • from the coordinate system global
  • only with visium data (not querying the xenium image with the visium cirlces)
  • not cropping the data first but making the tiles from the full data

it will work. So it should be good enough for the deep learning example.

@LucaMarconato

LucaMarconato commented Mar 8, 2023

Copy link
Copy Markdown
Member

Current todos:

Initial plan, postponed to a new PR (see #184):

  • extend functionality to get tiles from the raw space (not just from the target space)
    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined

@giovpgiovp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinyamauchi@LucaMarconato minor (maybe nitpick) comments.

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

Comment threadspatialdata/_core/_spatialdata.py Outdated
@@ -0,0 +1,35 @@
"""This file contains functions to compute the bounding box describing the extent of a spatial element,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in the bounding box related module? I would put it there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other functions that could populate this file are not used for spatial queries so I would not put them in _spatial_query.py. The complexity of that file increase when implementing non-bounding box queries, so I would keep this code in another place.

Comment threadspatialdata/_dl/datasets.py Outdated
from geopandas import GeoDataFrame
from multiscale_spatial_image import MultiscaleSpatialImage
from spatial_image import SpatialImage
from torch.utils.data import Dataset

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make torch as optional depedency, therefore I think in Init of this module or where the ImageTilesDataset is import, something like this would be needed

try:
fromspatialdata._dl.datasetsimportImageTilesDatasetexceptImportErrorase:
_error: str|None=str(e)
else:
_error=None

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you add torch somewhere in pyproject.toml or it would be responsibility of the user to install it properly? I would go for the second.

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_core/_rasterize.py
Comment threadspatialdata/_core/_rasterize.py Outdated
@giovp

Copy link
Copy Markdown
Member

Current todos:

  • wrong tiling result (wrong queried data and wrong content) when tiling a cropped multiscale image (probably due to this: 2 bugs with spatial cropping (with multiscale rasters and when missing the table) #178)

  • extend functionality to get tiles from the raw space (not just from the target space)

    • when querying tiles from the raw space, allow to specify either units, either pixels. Not both
    • when querying tiles from the target space, allow to specify also only units (and infer pixels), or only pixels. This is possible only when the data is not a multiscale, otherwise the pixels could not be determined
  • make tests

@LucaMarconato I would not extend functionality in this PR. Think priority wise is to add some minimal test and merge right away. We need to do the module conversion of the repo to start testing intersphinx for notebooks and documentation (and also this change will impact io/napari/plot so there will be lot of work to be done there as well.

@LucaMarconato

Copy link
Copy Markdown
Member

Ok, I created an issue to keep track of that. I will make the tests and ask for review (btw I am working on the Xenium + Visium data atm, but I am going to work on this PR right after).

@kevinyamauchi
kevinyamauchi marked this pull request as ready for review March 13, 2023 19:52

@kevinyamauchikevinyamauchi left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I can't approve because I opened the PR. For me, the main things to do before merging:

  • make torch import optional
  • make sure functions have docstrings (at least a description of what the function does)

Comment threadspatialdata/_core/_rasterize.py Outdated
Comment threadspatialdata/_dl/datasets.py Outdated
Comment on lines +27 to +33
self,
sdata: SpatialData,
regions_to_images: dict[str, str],
tile_dim_in_units: float,
tile_dim_in_pixels: int,
target_coordinate_system: str = "global",
transform: Optional[Callable[[SpatialData], dict[str, SpatialImage]]] = None,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add a docstring. I think the input parameters aren't clear (e.g., tile_dim_in_units vs. tile_dim_in_pixels)

@LucaMarconato

Copy link
Copy Markdown
Member

one major one regarding examples. They have to be in spatialdata-notebooks, not here. Everything that is not API should stay there. Ok to have python files and not notebooks (although better notebooks) but would still move.

ok I deleted the folder examples and moved this to the sandbox. I'll made these example not to show things to other users but to debug/visually test the spatial query, rasterization and tiler. I am not using notebooks because I use these for debugging, setting breakpoint etc.

Co-authored-by: Giovanni Palla <25887487+giovp@users.noreply.github.com>
@giovp

Copy link
Copy Markdown
Member

@LucaMarconato could you also quickly re add mypy in CI, seems like it's skipped atm, wasn't aware of that
https://github.com/scverse/spatialdata/blob/main/.pre-commit-config.yaml

@LucaMarconato

Copy link
Copy Markdown
Member

@giovp restored mypy in ci, we have some problems with the installation

Comment thread.pre-commit-config.yaml
@LucaMarconato

Copy link
Copy Markdown
Member

Gonna merge and increase the coverage in a next pr.

@LucaMarconato
LucaMarconato merged commit ff458c8 into scverse:mainMar 14, 2023
@giovpgiovp mentioned this pull request Mar 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kevinyamauchi@LucaMarconato@giovp@timtreis