Skip to content

[Doc] Update add module doc #2067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 29, 2022

Conversation

xiexinch
Copy link
Collaborator

Motivation

As title.

Modification

  • fix type
  • remove customize optimizer and customize optimizer constructor
  • add develop new segmentor

Comment on lines 192 to 203
def train_step(self,
data: Union[dict, tuple, list],
optim_wrapper: OptimWrapper) -> Dict[str, torch.Tensor]:
pass

def val_step(self,
data: Union[tuple, dict, list]) -> list:
pass

def test_step(self,
data: Union[tuple, dict, list]) -> list:
pass
Copy link
Collaborator

Choose a reason for hiding this comment

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

BaseModel in MMEngine implements xx_step, and mmseg didn't rewrite them.

I suggest that we should tell users what they should inherit from or rewrite, if they would like to add a segmentor

https://github.com/open-mmlab/mmengine/blob/ca0364bbc3a6ac9132f5d499de190f7e733383ca/mmengine/model/base_model/base_model.py#L84

Copy link
Collaborator

@MeowZheng MeowZheng left a comment

Choose a reason for hiding this comment

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

please rebase the laster dev-1.x

Comment on lines 213 to 215
def aug_test(self, batch_inputs, batch_img_metas):
"""Placeholder for augmentation test."""
pass
Copy link
Collaborator

Choose a reason for hiding this comment

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

aug_test isn't supported in openmmlab2.0, please remove it

type='MySegmentor'
...
)
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it would be better to add how add a new data preprocessor in mmseg

@xiexinch xiexinch force-pushed the update_add_model_doc branch from 7adfb8d to fd09554 Compare September 19, 2022 07:38
@MeowZheng MeowZheng merged commit 5d1faea into open-mmlab:dev-1.x Sep 29, 2022
MeowZheng pushed a commit to MeowZheng/mmsegmentation that referenced this pull request Nov 1, 2022
* develop segmentor and remove custom optim

* update segmentor example

* add data preprocessor

* refine intro
@MeowZheng MeowZheng added the Doc label Nov 2, 2022
wjkim81 pushed a commit to wjkim81/mmsegmentation that referenced this pull request Dec 3, 2023
nahidnazifi87 pushed a commit to nahidnazifi87/mmsegmentation_playground that referenced this pull request Apr 5, 2024
* develop segmentor and remove custom optim

* update segmentor example

* add data preprocessor

* refine intro
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants