Skip to content

Commit 29e0c5e

Browse files
authored
[Fix] update code in docs and fix broken urls (#3947)
1 parent 5d07dda commit 29e0c5e

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

docs/getting_started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ python tools/convert_datasets/cityscapes.py ./data/cityscapes --nproc 8 --out-di
4343
Currently the config files in `cityscapes` use COCO pre-trained weights to initialize.
4444
You could download the pre-trained models in advance if network is unavailable or slow, otherwise it would cause errors at the beginning of training.
4545

46-
For using custom datasets, please refer to [Tutorials 2: Adding New Dataset](tutorials/new_dataset.md).
46+
For using custom datasets, please refer to [Tutorials 2: Customize Datasets](tutorials/customize_dataset.md).
4747

4848
## Inference with pretrained models
4949

@@ -461,5 +461,5 @@ If you need a lightweight GUI for visualizing the detection results, you can ref
461461

462462
## Tutorials
463463

464-
Currently, we provide four tutorials for users to [finetune models](tutorials/finetune.md), [add new dataset](tutorials/new_dataset.md), [design data pipeline](tutorials/data_pipeline.md) and [add new modules](tutorials/new_modules.md).
464+
Currently, we provide four tutorials for users to [finetune models](tutorials/finetune.md), [customize datasets](tutorials/customize_dataset.md), [design data pipeline](tutorials/data_pipeline.md), [customize modules](tutorials/customize_models.md), [customize runtime settings](tutorials/customize_runtime.md), and [customize losses](tutorials/customize_losses.md).
465465
We also provide a full description about the [config system](config.md).

docs/tutorials/customize_models.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Create a new file `mmdet/models/backbones/mobilenet.py`.
2121
```python
2222
import torch.nn as nn
2323

24-
from ..registry import BACKBONES
24+
from ..builder import BACKBONES
2525

2626

2727
@BACKBONES.register_module()
@@ -74,7 +74,7 @@ model = dict(
7474
Create a new file `mmdet/models/necks/pafpn.py`.
7575

7676
```python
77-
from ..registry import NECKS
77+
from ..builder import NECKS
7878

7979
@NECKS.register
8080
class PAFPN(nn.Module):
@@ -125,11 +125,14 @@ neck=dict(
125125

126126
Here we show how to develop a new head with the example of [Double Head R-CNN](https://arxiv.org/abs/1904.06493) as the following.
127127

128-
First, add a new bbox head in `mmdet/models/bbox_heads/double_bbox_head.py`.
128+
First, add a new bbox head in `mmdet/models/roi_heads/bbox_heads/double_bbox_head.py`.
129129
Double Head R-CNN implements a new bbox head for object detection.
130130
To implement a bbox head, basically we need to implement three functions of the new module as the following.
131131

132132
```python
133+
from mmdet.models.builder import HEADS
134+
from .bbox_head import BBoxHead
135+
133136
@HEADS.register_module()
134137
class DoubleConvFCBBoxHead(BBoxHead):
135138
r"""Bbox head used in Double-Head R-CNN

docs/tutorials/finetune.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Detectors pre-trained on the COCO dataset can serve as a good pre-trained model
44
This tutorial provides instruction for users to use the models provided in the [Model Zoo](../model_zoo.md) for other datasets to obtain better performance.
55

66
There are two steps to finetune a model on a new dataset.
7-
- Add support for the new dataset following [Tutorial 2: Adding New Dataset](new_dataset.md).
7+
- Add support for the new dataset following [Tutorial 2: Customize Datasets](customize_dataset.md).
88
- Modify the configs as will be discussed in this tutorial.
99

1010

0 commit comments

Comments
 (0)