Trainers: add Instance Segmentation Task #2513

ariannasole23 · 2025-01-13T08:58:06Z

No description provided.

microsoft-github-policy-service · 2025-01-13T11:03:30Z

@ariannasole23 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

adamjstewart

Looks good, just need to make the code and tests match our existing trainers and run ruff: https://torchgeo.readthedocs.io/en/latest/user/contributing.html#linters

tests/trainers/test_instancesegmentation.py

torchgeo/trainers/instancesegmentation.py

adamjstewart · 2025-01-20T12:12:58Z

To solve the import issue, you also need to add 2 lines to torchgeo/trainers/__init__.py, just copy the style used by other classes.

torchgeo/trainers/instance_segmentation.py

…cesegmentation.py

adamjstewart

Can you run ruff on the code to make it more uniform? This will make it easier to review.

adamjstewart · 2025-01-28T12:39:05Z

test_trainer_instancesegmentation.py

This file can be deleted

adamjstewart · 2025-01-28T12:39:30Z

tests/trainers/test_instancesegmentation.py

Let's rename to test_instance_segmentation.py to match the other filename

adamjstewart · 2025-01-28T12:40:44Z

tests/trainers/test_instancesegmentation.py

+    @pytest.mark.parametrize(
+        'name',
+        [
+            'agrifieldnet',


This is a list of files whose configuration is present in tests/conf. This current list is from the semantic segmentation tests. We need to create a new list (and new tests/conf/*.yaml files) for instance segmentation datasets. We can start with something like VHR-10 and work from there.

adamjstewart · 2025-01-28T12:41:03Z

tests/trainers/test_instancesegmentation.py

+        match name:
+            case 'chabud' | 'cabuar':
+                pytest.importorskip('h5py', minversion='3.6')
+            case 'ftw':
+                pytest.importorskip('pyarrow')
+            case 'landcoverai':
+                sha256 = (
+                    'ecec8e871faf1bbd8ca525ca95ddc1c1f5213f40afb94599884bd85f990ebd6b'
+                )
+                monkeypatch.setattr(LandCoverAI, 'sha256', sha256)


Can be removed if you aren't using any of these datasets.

adamjstewart · 2025-01-28T12:41:31Z

tests/trainers/test_instancesegmentation.py

+        monkeypatch.setattr(smp, 'Unet', create_model)
+        monkeypatch.setattr(smp, 'DeepLabV3Plus', create_model)


We aren't using these models (or even smp) for this task, this can be removed

adamjstewart · 2025-01-28T12:43:04Z

torchgeo/trainers/instance_segmentation.py

+            freeze_backbone: Freeze the backbone network to fine-tune the
+                decoder and segmentation head.
+
+        .. versionadded:: 0.7


Can you move this versionadded to the class docstring?

adamjstewart · 2025-01-28T12:43:37Z

torchgeo/trainers/instance_segmentation.py

+        self.save_hyperparameters()     
+        self.model = None               
+        self.validation_outputs = []    
+        self.test_outputs = []          
+        self.configure_models()         
+        self.configure_metrics()        


None of these are needed, they are added by the base class

adamjstewart · 2025-01-28T12:44:03Z

torchgeo/trainers/instance_segmentation.py

+
+        if model == 'mask_rcnn':
+            # Load the Mask R-CNN model with a ResNet50 backbone
+            self.model = maskrcnn_resnet50_fpn(weights=MaskRCNN_ResNet50_FPN_Weights.DEFAULT)  


Weights will be chosen by the user, we can't assume ImageNet weights

adamjstewart · 2025-01-28T12:44:59Z

torchgeo/trainers/instance_segmentation.py

+
+        - Uses Mean Average Precision (mAP) for masks (IOU-based metric).
+        """
+        self.metrics = MetricCollection([MeanAveragePrecision(iou_type="segm")])


No need to use MetricCollection if you only have a single metric

adamjstewart · 2025-01-28T12:45:28Z

torchgeo/trainers/instance_segmentation.py

+        print('\nTRAINING LOSS\n')
+        print(loss_dict, '\n\n')
+        print(loss)


Can remove print statements, PyTorch Lightning has builtin loggers.

ariannasole23 added 3 commits January 9, 2025 19:34

Add files via upload

d00c087

Add files via upload

52daa1c

Update instancesegmentation.py

68756a7

github-actions bot added testing Continuous integration testing trainers PyTorch Lightning trainers labels Jan 13, 2025

adamjstewart changed the title PR Trainers: add Instance Segmentation Task Jan 13, 2025

adamjstewart added this to the 0.7.0 milestone Jan 13, 2025

adamjstewart requested changes Jan 13, 2025

View reviewed changes

ariannasole23 added 2 commits January 20, 2025 12:29

Merge branch 'microsoft:main' into main

e249883

Update and rename instancesegmentation.py to instance_segmentation.py

7676ac3

ariannasole23 added 3 commits January 21, 2025 14:44

Update test_instancesegmentation.py

0fa7b07

Update instance_segmentation.py

b4334f0

Update __init__.py

a160baa

adamjstewart reviewed Jan 21, 2025

View reviewed changes

torchgeo/trainers/instance_segmentation.py Outdated Show resolved Hide resolved

ariannasole23 added 6 commits January 21, 2025 19:13

Update instance_segmentation.py

fa8697b

Update instance_segmentation.py

f6ceed1

Add files via upload

619760b

Update test_instancesegmentation.py

d9158a0

Update and rename test_instancesegmentation.py to test_trainer_instan…

9f48f50

…cesegmentation.py

Update instance_segmentation.py

63aefc8

adamjstewart requested changes Jan 28, 2025

View reviewed changes

ariannasole23 added 4 commits January 28, 2025 19:12

Add files via upload

70074e7

Creato con Colab

b3de001

Creato con Colab

d70f1e3

Creato con Colab

1e68d2d

ariannasole23 force-pushed the main branch from 16ba69f to 1e68d2d Compare January 28, 2025 20:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Trainers: add Instance Segmentation Task #2513

Trainers: add Instance Segmentation Task #2513

ariannasole23 commented Jan 13, 2025

microsoft-github-policy-service bot commented Jan 13, 2025

Contribution License Agreement

adamjstewart left a comment

adamjstewart commented Jan 20, 2025

adamjstewart left a comment

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

adamjstewart Jan 28, 2025

		monkeypatch.setattr(smp, 'Unet', create_model)
		monkeypatch.setattr(smp, 'DeepLabV3Plus', create_model)

Trainers: add Instance Segmentation Task #2513

Are you sure you want to change the base?

Trainers: add Instance Segmentation Task #2513

Conversation

ariannasole23 commented Jan 13, 2025

microsoft-github-policy-service bot commented Jan 13, 2025

Contribution License Agreement

adamjstewart left a comment

Choose a reason for hiding this comment

adamjstewart commented Jan 20, 2025

adamjstewart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment