mirror of
https://github.com/open-mmlab/mmclassification.git
synced 2025-06-03 21:53:55 +08:00
85b1eae7f1
* Update docs. * Update requirements. * Update config readme and docstring. * Update CONTRIBUTING.md * Update README * Update requirements/mminstall.txt Co-authored-by: Yifei Yang <2744335995@qq.com> * Update MMEngine docs link and add to readthedocs requirement. Co-authored-by: Yifei Yang <2744335995@qq.com>
60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
# Useful Tools (TODO)
|
|
|
|
<!-- TOC -->
|
|
|
|
- [Print the entire config](#print-the-entire-config)
|
|
- [Verify Dataset](#verify-dataset)
|
|
- [FAQs](#faqs)
|
|
|
|
<!-- TOC -->
|
|
|
|
## Print the entire config
|
|
|
|
`tools/misc/print_config.py` prints the whole config verbatim, expanding all its imports.
|
|
|
|
```shell
|
|
python tools/misc/print_config.py ${CONFIG} [--cfg-options ${CFG_OPTIONS}]
|
|
```
|
|
|
|
Description of all arguments:
|
|
|
|
- `config` : The path of the model config file.
|
|
- `--cfg-options`: If specified, the key-value pair config will be merged into the config file, for more details please refer to [Learn about Configs](./config.md)
|
|
|
|
**Examples**:
|
|
|
|
```shell
|
|
python tools/misc/print_config.py configs/t2t_vit/t2t-vit-t-14_8xb64_in1k.py
|
|
```
|
|
|
|
## Verify Dataset
|
|
|
|
`tools/misc/verify_dataset.py` can verify dataset, check whether there are broken pictures in the given dataset.
|
|
|
|
```shell
|
|
python tools/print_config.py \
|
|
${CONFIG} \
|
|
[--out-path ${OUT-PATH}] \
|
|
[--phase ${PHASE}] \
|
|
[--num-process ${NUM-PROCESS}]
|
|
[--cfg-options ${CFG_OPTIONS}]
|
|
```
|
|
|
|
**Description of all arguments**:
|
|
|
|
- `config` : The path of the model config file.
|
|
- `--out-path` : The path to save the verification result, if not set, defaults to 'brokenfiles.log'.
|
|
- `--phase` : Phase of dataset to verify, accept "train" "test" and "val", if not set, defaults to "train".
|
|
- `--num-process` : number of process to use, if not set, defaults to 1.
|
|
- `--cfg-options`: If specified, the key-value pair config will be merged into the config file, for more details please refer to [Learn about Configs](./config.md)
|
|
|
|
**Examples**:
|
|
|
|
```shell
|
|
python tools/misc/verify_dataset.py configs/t2t_vit/t2t-vit-t-14_8xb64_in1k.py --out-path broken_imgs.log --phase val --num-process 8
|
|
```
|
|
|
|
## FAQs
|
|
|
|
- None
|