[Doc] Update train test doc #2061
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MeowZheng
reviewed
Sep 15, 2022
docs/en/user_guides/4_train_test.md
Outdated
| # use the pre-trained model for the whole PSPNet | ||
| load_from = 'https://download.openmmlab.com/mmsegmentation/v0.5/pspnet/pspnet_r50-d8_512x1024_40k_cityscapes/pspnet_r50-d8_512x1024_40k_cityscapes_20200605_003338-2966598c.pth' # model path can be found in model zoo | ||
| ``` | ||
| ## Training and testing on a single machine with a single GPU |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Training and testing on a single machine with a single GPU | |
| ## Training and testing on a single GPU |
MeowZheng
reviewed
Sep 15, 2022
docs/en/user_guides/4_train_test.md
Outdated
Comment on lines
6
to
7
| MMSegmentation also provides out-of-the-box tools for training models. | ||
| This section will show how to train and test models on standard datasets. |
Collaborator
There was a problem hiding this comment.
These lines are a little weird and repeats with the last sentence。
MeowZheng
reviewed
Sep 15, 2022
docs/en/user_guides/4_train_test.md
Outdated
| Difference between `--resume` and `load-from`: | ||
| `--resume` loads both the model weights and optimizer status, and the iteration is also inherited from the specified checkpoint. | ||
| **Note:** Difference between the argument `--resume` and the field `load-from` in the config file: | ||
| `--resume` loads both the model weights and optimizer status and the iteration is also inherited from the specified checkpoint. |
Collaborator
There was a problem hiding this comment.
resume doesn't support load weights
MeowZheng
reviewed
Sep 15, 2022
docs/en/user_guides/4_train_test.md
Outdated
| `--resume` loads both the model weights and optimizer status and the iteration is also inherited from the specified checkpoint. | ||
| It is usually used for resuming the training process that is interrupted accidentally. | ||
|
|
||
| `load-from` only loads the model weights and the training iteration starts from 0. It is usually used for fine-tuning. |
Collaborator
There was a problem hiding this comment.
The Note might not be required as resume doesn't support loading the specific checkpoint, and there might be confusion between resume and load_from.
MeowZheng
reviewed
Sep 15, 2022
docs/en/user_guides/4_train_test.md
Outdated
|
|
||
| - `--work-dir`: If specified, results will be saved in this directory. If not specified, the results will be automatically saved to `work_dirs/{CONFIG_NAME}`. | ||
| - `--show`: Show prediction results at runtime, available when `--show-dir` is not specified. | ||
| - `--show-dir`: If specified, the visualized segmentation mask will be saved in the specified directory. |
MeowZheng
reviewed
Sep 15, 2022
docs/en/user_guides/4_train_test.md
Outdated
| ### Launch multiple jobs on a single machine | ||
|
|
||
| If you launch multiple jobs on a single machine, e.g., 2 jobs of 4-GPU training on a machine with 8 GPUs, you need to specify different ports (29500 by default) for each job to avoid communication conflict. Otherwise, there will be an error message saying `RuntimeError: Address already in use`. | ||
| If you use `dist_train.sh` to launch training jobs, you can set the port in commands with the environment variable \`PORT\`\`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| If you use `dist_train.sh` to launch training jobs, you can set the port in commands with the environment variable \`PORT\`\`. | |
| If you use `dist_train.sh` to launch training jobs, you can set the port in commands with the environment variable `PORT`. |
MeowZheng
reviewed
Sep 16, 2022
docs/en/user_guides/4_train_test.md
Outdated
Comment on lines
29
to
81
| **Note:** Difference between the argument `--resume` and the field `load-from` in the config file: | ||
|
|
||
| `load-from` only loads the model weights and the training iteration starts from 0. It is usually used for fine-tuning. | ||
| `--resume` only determines whether to resume from the latest checkpoint in the work_dir. It is usually used for resuming the training process that is interrupted accidentally. | ||
|
|
||
| ### Training on CPU | ||
| `load-from` will specify the checkpoint to be loaded and the training iteration starts from 0. It is usually used for fine-tuning. | ||
|
|
||
| The process of training on the CPU is consistent with single GPU training if machine does not have GPU. If it has GPUs but not wanting to use it, we just need to disable GPUs before the training process. |
Collaborator
There was a problem hiding this comment.
Note:
If you would like to resume training from a specific checkpoint, you can use --resume with --cfg-options load-from=$CHECKPOINT.
MeowZheng
approved these changes
Sep 16, 2022
MeowZheng
pushed a commit
to MeowZheng/mmsegmentation
that referenced
this pull request
Nov 1, 2022
* draft * refine structure * fix typo * rename single gpu title and redefine --resume * update introduction * add notes to load_from
wjkim81
pushed a commit
to wjkim81/mmsegmentation
that referenced
this pull request
Dec 3, 2023
nahidnazifi87
pushed a commit
to nahidnazifi87/mmsegmentation_playground
that referenced
this pull request
Apr 5, 2024
* draft * refine structure * fix typo * rename single gpu title and redefine --resume * update introduction * add notes to load_from
nahidnazifi87
pushed a commit
to nahidnazifi87/mmsegmentation_playground
that referenced
this pull request
Apr 5, 2024
* draft * refine structure * fix typo * rename single gpu title and redefine --resume * update introduction * add notes to load_from
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
As title.
Modification
Update the structure: