Repository navigation
🧑💻 Modify pretrained_models.yaml to Contain Catalog Information with description and tissue type - #1106
🧑💻 Modify pretrained_models.yaml to Contain Catalog Information with description and tissue type#1106mraoaakash wants to merge 28 commits into
pretrained_models.yaml to Contain Catalog Information with description and tissue type#1106Conversation
pretrained_models.yaml to contain model catalog information with description, primary site, and supported sites.
for more information, see https://pre-commit.ci
…atoolbox into pretrainedmodels
for more information, see https://pre-commit.ci
| @@ -1,5 +1,11 @@ | |||
| alexnet-kather100k: | |||
| hf_repo_id: TIACentre/TIAToolbox_pretrained_weights | |||
There was a problem hiding this comment.
@gozdeg Please can you add information from https://github.com/TissueImageAnalytics/tiatoolbox-qupath-extension/blob/8d6e65085d84beb1f4e2f21adaeecc45f7447890/src/main/resources/qupath/ext/tiatoolbox/ui/models.json in this file.
There was a problem hiding this comment.
@gozdeg please can you add any missing information in this PR from the models.json file?
| @@ -1,5 +1,11 @@ | |||
| alexnet-kather100k: | |||
| hf_repo_id: TIACentre/TIAToolbox_pretrained_weights | |||
| catalog: | |||
| num_output_channels: 5 | ||
| encoder: "resnet50" | ||
| decoder_block: [3, 3] | ||
| class_dict: {0: "Tumour", 1: "Stroma", 2: "Inflamatory", 3: "Necrosis", 4: "Others"} |
There was a problem hiding this comment.
We do not need to remove class_dict. Instead we should add these for the missing ones.
| @@ -0,0 +1,3 @@ | |||
| version = 1 | |||
| hf_repo_id: TIACentre/TIAToolbox_pretrained_weights | ||
| catalog: | ||
| description: > | ||
| Predict Normal, Debri, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. |
There was a problem hiding this comment.
| Predict Normal, Debri, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. | |
| Predict Normal, Debris, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. |
| hf_repo_id: TIACentre/TIAToolbox_pretrained_weights | ||
| catalog: | ||
| description: > | ||
| Predict Normal, Debri, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. |
There was a problem hiding this comment.
| Predict Normal, Debri, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. | |
| Predict Normal, Debris, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. |
| description: > | ||
| Predict Normal, Debri, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. | ||
| primary_site: colon | ||
| supported_sites: |
| catalog: | ||
| description: > | ||
| Predict Normal, Debri, Tumor, Adipose, Mucus, Smooth, Stroma, Lymphocytes regions at a patch level in colon images. | ||
| primary_site: colon |
There was a problem hiding this comment.
| primary_site: colon | |
| tissue_types: colon |
| @@ -1,5 +1,11 @@ | |||
| alexnet-kather100k: | |||
There was a problem hiding this comment.
At the top of the file, explain in comments what different fields mean in this file.
There was a problem hiding this comment.
Only for the catalog field or all possible fields for a given model entry in the yaml?
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1106 +/- ##
========================================
Coverage 99.91% 99.91%
========================================
Files 117 117
Lines 13587 13587
Branches 1624 1624
========================================
Hits 13576 13576
Misses 5 5
Partials 6 6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…e as a replacement for primary_site and supported_sites
|
Have added the major components and changes. Will be visiting the remaining models on idars and crchisto soon. |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Added in all required descriptions except for Nuclick - will clarify and update. |
pretrained_models.yaml to contain model catalog information with description, primary site, and supported sites.pretrained_models.yaml to Contain Catalog Information with description, primary site, and supported sites.
pretrained_models.yaml to Contain Catalog Information with description, primary site, and supported sites.pretrained_models.yaml to Contain Catalog Information with description and tissue type
Partial PR for addition of pre-trained model documentation to the pretrained_model.yaml file. Includes the addition of a new filed called
catalogto each model yaml entry. The entry is structured in the following manner:catalog: description: > multi-line model description primary_site: primary site that model is supported for (agnostic for site-agnostic or multi-site models) supported_sites: - other - supported - sitesFields can be read nested and used for downstream filtering tasks as necessary.
NOTE: This is a partial PR and does not contain the complete set of catalog entries as it proved difficult to ascertain the required catalog entries for some models. Someone with more complete knowledge of some models would have to take up the completion of the remaining catalog entries.
Description, primary site, and supported sites:
Description only: