Skip to content
New issue

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

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

44 panoptic docs #94

Merged
merged 19 commits into from
Oct 13, 2021
Merged

44 panoptic docs #94

merged 19 commits into from
Oct 13, 2021

Conversation

Johansmm
Copy link
Contributor

@Johansmm Johansmm commented Sep 30, 2021

New documentations:

  • Detr_panoptic
  • Panoptic callbacks
  • LitPanopticDetr
  • Panoptic train tutorial
  • PanopticDetrR50 API

Update documentation of:

  • Detr modules (detr, detr-r50 , detrfinetune, train, data_modules, ..)
  • Callbacks
  • Metrics
  • Criterion

And fix link by new DataConnectors modules (explained in #89 )

**Important note: Not merge until merge first #89 **

Closes #2 - #44 - #104

@Johansmm Johansmm added documentation Improvements or additions to documentation alonet labels Sep 30, 2021
@Johansmm Johansmm self-assigned this Sep 30, 2021
@Johansmm Johansmm linked an issue Sep 30, 2021 that may be closed by this pull request
@@ -44,6 +45,9 @@ class CocoPanopticDataset(BaseDataset, SplitMixin):
Include masks labels in the output, by default True
classes : list, optional
List of classes to be filtered in the annotation reading process, by default None
fix_classes_len : int, optional
Fix to a specific number the number of classes, filling the rest with "N/A" value.
Use when the number of model outputs does not match with the number of classes in the dataset, by default 250
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is the default value 250 ? To match the model ? If so, I guess the default value should be None.

Copy link
Contributor Author

@Johansmm Johansmm Oct 6, 2021

Choose a reason for hiding this comment

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

@thibo73800 Ok, I will change in #89

@@ -101,6 +111,23 @@ def __init__(
items.append(self.items[i])
self.items = items

# Fix label_types
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you give more details about what the following is doing ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

alodataset/utils/panoptic_utils.py Outdated Show resolved Hide resolved
# import wandb


class BaseMetricsCallback(pl.Callback):
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure BaseMetricsCallback is descriptive enough about the kind of data handle by this class. Currently BaseMetricsCallback is used for Panoptic & mAp right ? But not for ANY type of metrics. Just Objects/instance based metrics. So i'm not sure which name could be the most appropriate but, probably not this one.

Copy link
Contributor Author

@Johansmm Johansmm Oct 6, 2021

Choose a reason for hiding this comment

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

@thibo73800 fix in #89

alonet/detr/data_modules/coco_panoptic2detr.py Outdated Show resolved Hide resolved
alonet/metrics/compute_map.py Outdated Show resolved Hide resolved
alonet/metrics/compute_pq.py Outdated Show resolved Hide resolved
@Johansmm
Copy link
Contributor Author

Johansmm commented Oct 6, 2021

@thibo73800: For this branch, is required merge first #89 to see the docs changes only

Copy link
Contributor

@thibo73800 thibo73800 left a comment

Choose a reason for hiding this comment

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

Thanks for all the documentation, can you add detr_panoptic to the main readme along with a specific readme in the detr_panoptic folder ? (Following other models example)

@Johansmm
Copy link
Contributor Author

Johansmm commented Oct 12, 2021

@thibo73800 : I updated the DetrR50PanopticFinetune, PanopticModels and training_panoptic docs / tutorials. Also I fix a problem in compute_pq (print_map function). Finally, README.md was updated and README.md for panoptic was created, developing the train_on_coco.py and eval_on_coco.py programs.

Ready to merge

@Johansmm Johansmm linked an issue Oct 12, 2021 that may be closed by this pull request
@thibo73800 thibo73800 merged commit e1593a3 into master Oct 13, 2021
@thibo73800 thibo73800 deleted the 44-panoptic-docs branch October 13, 2021 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alonet documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DETR-panoptic finetune docs Panoptic tutoral-docs Doc: Alonet - Detr API
2 participants