Skip to content

Commit

Permalink
Fix mmdetection links
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinMusgrave committed Dec 19, 2023
1 parent 9108544 commit 3cc8b52
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions model_hub/mmdetection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
We have provided a default [Determined experiment configuration for Mask-RCNN on COCO 2017](./maskrcnn.yaml) as the starting point.

## Configuring MMDetection
MMDetection has [its own configuration system](https://mmdetection.readthedocs.io/en/latest/tutorials/config.html) for specifying the dataset, model, optimizer, and other objects used during training. Customizing MMDetection primarily amounts to specifying
MMDetection has [its own configuration system](https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/config.html) for specifying the dataset, model, optimizer, and other objects used during training. Customizing MMDetection primarily amounts to specifying
your own MMDetection configs and we preserve this when using MMDetection with Determined. Hence, similar to directly using MMDetection, you will need to be familiar with MMDetection's configurable objects in order to get more custom behavior.

We will cover how to specify and manipulate a *MMDetection config* in the experiment configuration below.
Expand Down Expand Up @@ -56,7 +56,7 @@ field to turn on gradient clipping and mixed precision.

### Other experiment config fields
#### Data backends
We support `s3`, and `gcs` backends in addition to the [file client backends supported by MMCV](https://mmcv.readthedocs.io/en/latest/_modules/mmcv/fileio/file_client.html#FileClient) so you can easily access data in cloud storage buckets. Note that MMDetection expects the data to follow [a particular structure for standard datasets](https://mmdetection.readthedocs.io/en/latest/1_exist_data_model.html#test-existing-models-on-standard-datasets) like COCO, Pascal, Cityscapes.
We support `s3`, and `gcs` backends in addition to the [file client backends supported by MMCV](https://mmcv.readthedocs.io/en/v1.7.0/_modules/mmcv/fileio/file_client.html#FileClient) so you can easily access data in cloud storage buckets. Note that MMDetection expects the data to follow [a particular structure for standard datasets](https://mmdetection.readthedocs.io/en/v2.27.0/1_exist_data_model.html#test-existing-models-on-standard-datasets) like COCO, Pascal, Cityscapes.

You can change the backend by modifying the `data.file_client_args` section of the experiment config.

Expand All @@ -67,10 +67,10 @@ The `hyperparameters.global_batch_size` field of the Determined experiment confi
MMDetection provides pretrained checkpoints corresponding to some of the configurations as listed in the `README` files for each model type. If a pretrained weight is available for the specified `config_file`, you can warmstart the model with these weights by setting `hyperparameters.use_pretrained` to `true`.

## Using custom dataset
Training MMDetection on custom datasets in Determined is largely the same process as doing so directly with MMDetection. Please follow [this guide](https://mmdetection.readthedocs.io/en/latest/tutorials/customize_dataset.html) from MMDetection to register your own datasets.
Training MMDetection on custom datasets in Determined is largely the same process as doing so directly with MMDetection. Please follow [this guide](https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/customize_dataset.html) from MMDetection to register your own datasets.

## Adding classes
Creating custom classes for models, otpimizers, losses, and other MMDetection objects also requires following the same process as you would normally. Please see the [MMDetection tutorials](https://mmdetection.readthedocs.io/en/latest/tutorials/customize_models.html) for more info.
Creating custom classes for models, otpimizers, losses, and other MMDetection objects also requires following the same process as you would normally. Please see the [MMDetection tutorials](https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/customize_models.html) for more info.

## Results
The validation bounding box mAP for Faster-RCNN is shown in the image below.
Expand Down
2 changes: 1 addition & 1 deletion model_hub/mmdetection/fasterrcnn.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ hyperparameters:
merge_config: null # You can specify a config you want to merge into the config_file above.
use_pretrained: false # Whether to load pretrained weights for config if available.
override_mmdet_config:
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/latest/tutorials/config.html #####
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/config.html #####
##### You can specify gradient clipping with below #####
optimizer_config._delete_: true
optimizer_config.grad_clip.max_norm: 100
Expand Down
2 changes: 1 addition & 1 deletion model_hub/mmdetection/maskrcnn.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ hyperparameters:
merge_config: null # You can specify a config you want to merge into the config_file above.
use_pretrained: false # Whether to load pretrained weights for config if available.
override_mmdet_config:
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/latest/tutorials/config.html #####
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/config.html #####
##### You can specify gradient clipping with below #####
optimizer_config._delete_: true
optimizer_config.grad_clip.max_norm: 100
Expand Down
2 changes: 1 addition & 1 deletion model_hub/mmdetection/panoptic_fpn.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ hyperparameters:
merge_config: null # You can specify a config you want to merge into the config_file above.
use_pretrained: false # Whether to load pretrained weights for config if available.
#override_mmdet_config:
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/latest/tutorials/config.html #####
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/config.html #####
##### You can specify gradient clipping with below #####
#optimizer_config._delete_: true
#optimizer_config.grad_clip.max_norm: 100
Expand Down
2 changes: 1 addition & 1 deletion model_hub/mmdetection/yolov3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ hyperparameters:
merge_config: null # You can specify a config you want to merge into the config_file above.
use_pretrained: false # Whether to load pretrained weights for config if available.
#override_mmdet_config:
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/latest/tutorials/config.html #####
##### Learn more about mmdet configs: https://mmdetection.readthedocs.io/en/v2.27.0/tutorials/config.html #####
##### You can specify gradient clipping with below #####
#optimizer_config._delete_: true
#optimizer_config.grad_clip.max_norm: 100
Expand Down

0 comments on commit 3cc8b52

Please sign in to comment.