Improve models documentation

[luxedo]

As I understand, you can point to both Mask RCNN and DEXTR models using environment variables.

I managed to make DEXTR work, but not Mask RCNN. I'm getting the following warning:

[WARNING] MaskRCNN model is disabled

Even though I'm pointing to the model file with an MASK_RCNN_FILE variable. I'd love to run my RCNN models in new images.

Can you provide extra documentation for the topic?

[jsbroks]

The environment values need to changed within the docker-compose.yml file. An example can be seen in the docker-compose.dev.yml, where I have it configured to us the pre-trained maskrcnn coco model.

In a general use case:

1. Set MASK_RCNN_FILE to point to your h5 file (e.g /models/your-h5-file.h5).
2. Set MASK_RCNN_CLASSES to your classes which should be in the order in which your models index's as output

Theses environment variables should be set in the docker-compose.yml

The model should now load on boot. Next we need to set the datasets url to point to this model.

1. Inside the annotator click the settings icon on the right panel.
2. type the url of the model, if using the built in mask rcnn its /api/model/maskrcnn

[luxedo]

It worked flawlessly! Thank you very much.

I was setting the default value in config.py not in the compose file.

[NicksonYap]

@jsbroks

I was looking for the wiki guide to run Mask RCNN model and can't find it
I suppose I'll use this as the guide? 😅

[NicksonYap]

In response to: #204 (comment) (Looking for the MaskRCNN interface)

I wasn't able to find any interface related to MaskRCNN I'm at v0.10.5, master branch

My steps:

In a general use case:

1. Set MASK_RCNN_FILE to point to your h5 file (e.g /models/your-h5-file.h5).
2. Set MASK_RCNN_CLASSES to your classes which should be in the order in which your models index's as output

docker-compose.dev.yml:

docker-compose.yml:

I ran:

docker-compose -f docker-compose.dev.yml up --build

In console, it shows the model is loaded

[2019-05-21 06:21:02 +0000] [10] [INFO] Loaded MaskRCNN model: /models/mask_rcnn_zuppa_0149.h5

The webpage also loads successfully, after increasing gunicorn timeout #199 (comment)

The model should now load on boot. Next we need to set the datasets url to point to this model.

1. Inside the annotator click the settings icon on the right panel.
2. type the url of the model, if using the built in mask rcnn its /api/model/maskrcnn

The settings icon on the right doesn't seem relevant at all

So I tried the one on the left, and doesn't seem to have any effect

I have dug the source code, and no Vue files are using the /api/model/maskrcnn endpoint

What was I missing?

Edit: Turns out you need to click this button after adding the Annotate URL :)

PS:

Remember to add your Categories, they must be the same name as the Classes of the model