Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Refine error message to tell the user how to install mmengine.

Modification

Modifies the error message in mim with:

Please install mmengine to use the download command: mim install mmengine.'

BC-breaking (Optional)

Does the modification introduce changes that break the back-compatibility of the downstream repos? If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

1. Pre-commit or other linting tools are used to fix the potential lint issues.
2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
4. The documentation has been modified accordingly, like docstring or example tutorials.

1. I've followed the installation steps from https://mmdetection.readthedocs.io/en/v2.25.0/get_started.html
2. Then I try to execute the following command from the manual mim download mmdet --config yolov3_mobilenetv2_320_300e_coco --dest .

$ mim download mmdet --config yolov3_mobilenetv2_320_300e_coco --dest .
~/miniconda3/envs/openmmlab/lib/python3.8/site-packages/_distutils_hack/__init__.py:30: UserWarning: Setuptools is replacing distutils.
  warnings.warn("Setuptools is replacing distutils.")
Traceback (most recent call last):
  File "~/miniconda3/envs/openmmlab/bin/mim", line 33, in <module>
    sys.exit(load_entry_point('openmim', 'console_scripts', 'mim')())
  File "~/miniconda3/envs/openmmlab/lib/python3.8/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "~/miniconda3/envs/openmmlab/lib/python3.8/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "~/miniconda3/envs/openmmlab/lib/python3.8/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "~/miniconda3/envs/openmmlab/lib/python3.8/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "~/miniconda3/envs/openmmlab/lib/python3.8/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "~/repositories/mim/mim/commands/download.py", line 44, in cli
    download(package, configs, dest_root)
  File "~/repositories/mim/mim/commands/download.py", line 75, in download
    model_info = get_model_info(
  File "~/repositories/mim/mim/commands/search.py", line 170, in get_model_info
    dataframe = convert2df(metadata)
  File "~/repositories/mim/mim/commands/search.py", line 396, in convert2df
    for key, value in name2collection[collection_name].items():
KeyError: 'Cascade Mask R-CNN'

I've also tried to install mim directly from master, but the same error appears.

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

1.Fix the punctuation display problem on Windows, when running the command mim run mmdet -h.

2.Fix the path separator problem on Windows, when running the command mim run mmdet -h.

Modification

Replace all Don’t -> Don\'t for problem 1. In mim/click/customcommand.py, '/' -> os.sep for problem 2.

I'm working in an environment with a strict custom proxy enforcement which blocks ssl verification to many sites including package hosts. Is there a way to bypass this verification similar to how pip allows the following?

--trusted-host {host}

Describe the feature I would like to specify the gpu-ids when I run mim train.

mim train mmcls config.py --gpu-ids 1

Currently, I think I can only specify the gpus as shown below.

mim train mmcls config.py --gpus 1

Motivation It is inconvenient when to specify the gpu-ids.

Related resources https://github.com/open-mmlab/mmclassification/blob/master/tools/train.py#L38-L43

Describe the feature I would like to be able to specify the config under .mim as the base config and run it as shown below.

_base_ = [
    'site-packages/mmcls/.mim/config/_base_/models/resnet18_cifar.py',
    'site-packages/mmcls/.mim/config/_base_/datasets/cifar10_bs16.py',
    'site-packages/mmcls/.mim/config/_base_/schedules/cifar10_bs128.py',
    'site-packages/mmcls/.mim/config/_base_/default_runtime.py'
]

Motivation When specifying the config in the repo as the base config, I find it inconvenient that I need to either download it locally by git clone or copy the config to be used itself under .mim.

Additional context The following part of mmcv is the load part of the base config. I think it is possible to load the config from .mim by changing this part, is this the proper way? https://github.com/open-mmlab/mmcv/blob/76cfd77b3a88ce17508471bf335829eb0628abcf/mmcv/utils/config.py#L239-L269

Is this the proper way to do it, or is there a way to complete it with a .mim repo?

Description If I run this in the command line: pip install openmim mim install mmdet>=3.0.0rc0 mim list prints

Package    Version    Source
---------  ---------  -----------------------------------------
mmdet      2.25.3     https://github.com/open-mmlab/mmdetection

Expected behaviour mim install mmdet>=3.0.0rc0 should install mmdet v3.0.0rc2 (the latest rc at the time of writing).

Probable cause Maybe mim installs the newest package newer than 3.0.0rc0 by date. This can lead to the above behaviour.

Perhaps the version numbers need to be parsed instead of just installing by date of release?

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Fix the issue that the click version is locked at 7.x, fixes #123 In addition, add .vscode into .gitignore make vscode user happy.

Modification

• .gitignore
• setup.py
• requirements/install.txt
• mim/click/__init__.py
• mim/click/compat.py
• mim/click/option.py
• mim/commands/download.py
• mim/commands/install.py
• mim/commands/search.py
• mim/commands/uninstall.py

BC-breaking (Optional)

No

Use cases (Optional)

No

Checklist

1. Pre-commit or other linting tools are used to fix the potential lint issues.
2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
4. The documentation has been modified accordingly, like docstring or example tutorials.

I tried to use 2 GPU for training, but it raised a error:

PYTHONPATH=$PWD:$PYTHONPATH mim train mmaction configs/localization/apn_coralrandom_r3dsony_32x4_10e_thumos14_flow.py --gpus 2 --validate

2021-06-13 16:38:48,309 - mmaction - INFO - workflow: [('train', 1)], max: 10 epochs
Traceback (most recent call last):
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmaction/tools/train.py", line 199, in <module>
    main()
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmaction/tools/train.py", line 195, in main
    meta=meta)
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmaction/apis/train.py", line 163, in train_model
    runner.run(data_loaders, cfg.workflow, cfg.total_epochs, **runner_kwargs)
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmcv/runner/epoch_based_runner.py", line 125, in run
    epoch_runner(data_loaders[i], **kwargs)
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmcv/runner/epoch_based_runner.py", line 50, in train
    self.run_iter(data_batch, train_mode=True, **kwargs)
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmcv/runner/epoch_based_runner.py", line 30, in run_iter
    **kwargs)
  File "/home/louis/miniconda3/envs/open-mmlab/lib/python3.7/site-packages/mmcv/parallel/data_parallel.py", line 55, in train_step
    ('MMDataParallel only supports single GPU training, if you need to'
AssertionError: MMDataParallel only supports single GPU training, if you need to train with multiple GPUs, please use MMDistributedDataParallelinstead.

However, I did's manually set the distributed method in my own code. It seems that mim uses the train.py instead of dist_train.sh . How to fix this?

when i run "mim run mmcls get_flops resnet101_b16x8_cifar10.py" OR "mim run mmcls publish_model", it report the error "subprocess.CalledProcessError: ... returned non-zero exit status 1 ". How to solve this?

Please help me, trying to test download mmyolo config via python:

env:

openmim==0.3.2
mmyolo=0.1.1
mmengine==0.1.0
mmcv==2.0.0rc2
mmdet==3.0.0rc2

command:

from mim import download

filepath = download("mmyolo", ["yolov5_n-v61_syncbn_fast_8xb16-300e_coco"], dest_root=".")

error:

[.../lib/python3.8/site-packages/mmyolo/model-index.yml or .../lib/python3.8/site-packages/mmyolo/model_zoo.yml is not found, please upgrade your mmyolo to support search command

Motivation

Some packages has config paths which is url encoded (e.g. %2B for +) https://github.com/open-mmlab/mmdetection/blob/db85fd12afce2fe89d1c7b870874c02a90018a16/configs/gn%2Bws/metafile.yml#L17

Currently downloading those models trrigers "is not found" error because mim does not support url encoded path.

Modification

While I am not sure if this should be fixed in mim or in metafile.yml in the package, I firstly attempt to fix in mim package.

BC-breaking (Optional)

Use cases (Optional)

Checklist

1. Pre-commit or other linting tools are used to fix the potential lint issues.
2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
4. The documentation has been modified accordingly, like docstring or example tutorials.

Motivation

Support CPU-only train and test in slurm cluster. (#189)

Modification

Modify slurm check conditions to "flag = partition is not None"

Checklist

1. Pre-commit or other linting tools are used to fix the potential lint issues.
2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
4. The documentation has been modified accordingly, like docstring or example tutorials.

Could mim support asynchronous commits ”--async“ - or, alternatively, log output redirection “--output” to redirect the generated logs to another file? mim是否可以支持异步提交--async，或者换种方式，支持日志输出重定向--output，把生成的日志重定向之别的文件。

I tried to use mim to start a task on a slurm cluster and not use gpu, but it seems that the mim command is not supported. 我尝试使用mim在slurm集群上启动任务--launcher slurm，并且不使用gpu，我设置了--gpus-per-node 0,但是似乎不可行。

您好，我想问下，这个mim包管理工具，是否支持像pip那样的download-only名命，将要安装的包，通过mim命令下载下来（包括把依赖也下载下来），而不是安装；用途就是通过这种仅下载的命令，把安装包下载下来后，往内网环境的生产环境部署的需求；应该很多工业界的安装需求，都是这样的gpu在内网环境上，不能访问公网。

Describe the feature Support returning the main function of 'train', and 'test' scripts like mim.train(return_function=True)(args).

Motivation Currently, mim.train and mim.test works as running the script as a subprocess. In addition to this, if it can work as returning the main function of these scripts, it would be nice for third-party frameworks to utilize these scripts in runtime. For example, our work had to copy-and-paste train scripts to utilize these as function.

One of the possible ways to support this feature is described in https://stackoverflow.com/a/67692.

import importlib.util
import sys

pkg_root = get_installed_path(package)
train_script = osp.join(pkg_root, '.mim', 'tools', 'train.py')

spec = importlib.util.spec_from_file_location("mm.train", train_script)
foo = importlib.util.module_from_spec(spec)
sys.modules["mm.train"] = foo
spec.loader.exec_module(foo)
foo.main()

Although it can be done in other libraries, it seems safer to be supported by mim.

In addition to this, like our example in the above link, it would be helpful to be able to give custom args in parse_args(args) in the scripts to customize its functionality.

Although it affects many other frameworks and packages, I think it would benefit other frameworks in the future! :)