[Rename] update mmagic CI (#1772)

* [Rename] update mmagic CI

* fix tests

* fix docs

* fix docs

Author: Z-Fran

.circleci/config.yml

@@ -26,7 +26,7 @@ workflows:
             .github/.* lint_only true
             demo/.* lint_only true
             projects/.* lint_only true
-            mmedit/.* lint_only false
+            mmagic/.* lint_only false
             requirements/.* lint_only false
             tests/.* lint_only false
             .circleci/.* lint_only false

.circleci/test.yml

@@ -25,7 +25,7 @@ jobs:
           name: Check docstring coverage
           command: |
             pip install interrogate
-            interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-magic --ignore-regex "__repr__" --fail-under 90 mmedit
+            interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-magic --ignore-regex "__repr__" --fail-under 90 mmagic
   build_cpu:
     parameters:
       # The python version must match available image tags in
@@ -57,7 +57,7 @@ jobs:
             python -V
             pip install torch==<< parameters.torch >>+cpu torchvision==<< parameters.torchvision >>+cpu -f https://download.pytorch.org/whl/torch_stable.html
       - run:
-          name: Install mmediting dependencies
+          name: Install mmagic dependencies
           command: |
             pip install git+https://github.com/open-mmlab/mmengine.git@main
             pip install -U openmim
@@ -70,7 +70,7 @@ jobs:
       - run:
           name: Run unittests
           command: |
-            coverage run --branch --source mmedit -m pytest tests/
+            coverage run --branch --source mmagic -m pytest tests/
             coverage xml
             coverage report -m
   build_cuda:
@@ -97,23 +97,23 @@ jobs:
       - run:
           name: Build Docker image
           command: |
-            docker build .circleci/docker -t mmedit:gpu --build-arg PYTORCH=<< parameters.torch >> --build-arg CUDA=<< parameters.cuda >> --build-arg CUDNN=<< parameters.cudnn >>
-            docker run --gpus all -t -d -v /home/circleci/project:/mmedit -v /home/circleci/mmengine:/mmengine -v /home/circleci/mmdetection:/mmdetection -w /mmedit --name mmedit mmedit:gpu
+            docker build .circleci/docker -t mmagic:gpu --build-arg PYTORCH=<< parameters.torch >> --build-arg CUDA=<< parameters.cuda >> --build-arg CUDNN=<< parameters.cudnn >>
+            docker run --gpus all -t -d -v /home/circleci/project:/mmagic -v /home/circleci/mmengine:/mmengine -v /home/circleci/mmdetection:/mmdetection -w /mmagic --name mmagic mmagic:gpu
       - run:
-          name: Install mmedit dependencies
+          name: Install mmagic dependencies
           command: |
-            docker exec mmedit pip install -e /mmengine
-            docker exec mmedit pip install -U openmim
-            docker exec mmedit mim install 'mmcv >= 2.0.0'
-            docker exec mmedit pip install -r requirements/tests.txt
+            docker exec mmagic pip install -e /mmengine
+            docker exec mmagic pip install -U openmim
+            docker exec mmagic mim install 'mmcv >= 2.0.0'
+            docker exec mmagic pip install -r requirements/tests.txt
       - run:
           name: Build and install
           command: |
-            docker exec mmedit pip install -e .
+            docker exec mmagic pip install -e .
       - run:
           name: Run unittests
           command: |
-            docker exec mmedit pytest tests/
+            docker exec mmagic pytest tests/
 
 workflows:
   pr_stage_lint:

.github/workflows/lint.yml

@@ -24,4 +24,4 @@ jobs:
       - name: Check docstring coverage
         run: |
           pip install interrogate
-          interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-regex "__repr__" --fail-under 90 mmedit
+          interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-regex "__repr__" --fail-under 90 mmagic

.github/workflows/merge_stage_test.yml

@@ -54,7 +54,7 @@ jobs:
         run: rm -rf .eggs && pip install -e .
       - name: Run unittests and generate coverage report
         run: |
-          coverage run --branch --source mmedit -m pytest tests/
+          coverage run --branch --source mmagic -m pytest tests/
           coverage xml
           coverage report -m
 
@@ -100,7 +100,7 @@ jobs:
         run: rm -rf .eggs && pip install -e .
       - name: Run unittests and generate coverage report
         run: |
-          coverage run --branch --source mmedit -m pytest tests/
+          coverage run --branch --source mmagic -m pytest tests/
           coverage xml --omit="**/stylegan3_ops/*,**/conv2d_gradfix.py,**/grid_sample_gradfix.py,**/misc.py,**/upfirdn2d.py,**all_gather_layer.py"
           coverage report -m
       # Only upload coverage report for python3.7 && pytorch1.8.1 cpu
@@ -141,7 +141,7 @@ jobs:
           apt-get update && apt-get install -y ffmpeg libsm6 libxext6 git ninja-build libglib2.0-0 libsm6 libxrender-dev libxext6
       - name: Install PyTorch
         run: pip install torch==1.8.1+cpu torchvision==0.9.1+cpu -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
-      - name: Install mmediting dependencies
+      - name: Install mmagic dependencies
         run: |
           pip install -U openmim
           mim install 'mmcv >= 2.0.0'
@@ -177,7 +177,7 @@ jobs:
           apt-get update && apt-get install -y ffmpeg libsm6 libxext6 git ninja-build libglib2.0-0 libsm6 libxrender-dev libxext6
       - name: Install PyTorch
         run: pip install torch torchvision --extra-index-url https://download.pytorch.org/whl/cpu
-      - name: Install mmediting dependencies
+      - name: Install mmagic dependencies
         run: |
           pip install git+https://github.com/open-mmlab/mmengine.git@main
           pip install -U openmim
@@ -188,7 +188,7 @@ jobs:
           pip install -e .
       - name: Run unittests and generate coverage report
         run: |
-          coverage run --branch --source mmedit -m pytest tests/
+          coverage run --branch --source mmagic -m pytest tests/
           coverage xml --omit="**/stylegan3_ops/*,**/conv2d_gradfix.py,**/grid_sample_gradfix.py,**/misc.py,**/upfirdn2d.py,**all_gather_layer.py"
           coverage report -m
 
@@ -210,7 +210,7 @@ jobs:
         run: python -m pip install lmdb
       - name: Install PyTorch
         run: python -m pip install torch==1.8.1+${{matrix.platform}} torchvision==0.9.1+${{matrix.platform}} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
-      - name: Install mmediting dependencies
+      - name: Install mmagic dependencies
         run: |
           python -m pip install git+https://github.com/open-mmlab/mmengine.git@main
           python -m pip install -U openmim

.github/workflows/pr_stage_test.yml

@@ -47,7 +47,7 @@ jobs:
         run: rm -rf .eggs && pip install -e .
       - name: Run unittests and generate coverage report
         run: |
-          coverage run --branch --source mmedit -m pytest tests/
+          coverage run --branch --source mmagic -m pytest tests/
           coverage xml --omit="**/stylegan3_ops/*,**/conv2d_gradfix.py,**/grid_sample_gradfix.py,**/misc.py,**/upfirdn2d.py,**all_gather_layer.py"
           coverage report -m
       # Upload coverage report for python3.7 && pytorch1.8.1 cpu
@@ -88,7 +88,7 @@ jobs:
           apt-get install -y ffmpeg libsm6 libxext6 git ninja-build libglib2.0-0 libxrender-dev
       - name: Install PyTorch
         run: pip install torch==1.8.1+cpu torchvision==0.9.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
-      - name: Install mmedit dependencies
+      - name: Install mmagic dependencies
         run: |
           pip install git+https://github.com/open-mmlab/mmengine.git@main
           pip install -U openmim
@@ -119,7 +119,7 @@ jobs:
         run: python -m pip install lmdb
       - name: Install PyTorch
         run: python -m pip install torch==1.8.1+${{matrix.platform}} torchvision==0.9.1+${{matrix.platform}} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
-      - name: Install mmedit dependencies
+      - name: Install mmagic dependencies
         run: |
           python -m pip install git+https://github.com/open-mmlab/mmengine.git@main
           python -m pip install -U openmim

.github/workflows/publish-to-pypi.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: 3.7
-      - name: Build MMEditing
+      - name: Build MMagic
         run: |
           pip install torch==1.8.1+cpu torchvision==0.9.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
           pip install wheel

.github/workflows/test_mim.yml

@@ -41,4 +41,4 @@ jobs:
       - name: Build and install
         run: rm -rf .eggs && mim install -e .
       - name: test commands of mim
-        run: mim search mmedit
+        run: mim search mmagic

.gitignore

@@ -121,7 +121,7 @@ configs_ceph/
 configs_ceph_*/
 /data/
 /data
-mmedit/.mim
+mmagic/.mim
 demo/*.png
 *.csv
 out/*.png

MANIFEST.in

@@ -1,7 +1,7 @@
 include requirements/*.txt
-include mmedit/.mim/VERSION
-include mmedit/.mim/model-index.yml
-include mmedit/evaluation/metrics/niqe_pris_params.npz
-recursive-include mmedit/.mim/configs *.py *.yml
-recursive-include mmedit/.mim/tools *.sh *.py
-recursive-include mmedit/.mim/demo *.py
+include mmagic/.mim/VERSION
+include mmagic/.mim/model-index.yml
+include mmagic/evaluation/metrics/niqe_pris_params.npz
+recursive-include mmagic/.mim/configs *.py *.yml
+recursive-include mmagic/.mim/tools *.sh *.py
+recursive-include mmagic/.mim/demo *.py

docs/en/conf.py

@@ -45,7 +45,7 @@
 
 extensions.append('autoapi.extension')
 autoapi_type = 'python'
-autoapi_dirs = ['../../mmedit']
+autoapi_dirs = ['../../mmagic']
 autoapi_add_toctree_entry = False
 autoapi_template_dir = '_templates'
 # autoapi_options = ['members', 'undoc-members', 'show-module-summary']
@@ -67,7 +67,7 @@
 # autodoc_inherit_docstrings = True
 
 autodoc_mock_imports = [
-    'mmedit.version', 'mmcv._ext', 'mmcv.ops.ModulatedDeformConv2d',
+    'mmagic.version', 'mmcv._ext', 'mmcv.ops.ModulatedDeformConv2d',
     'mmcv.ops.modulated_deform_conv2d', 'clip', 'resize_right', 'pandas'
 ]
 

docs/en/index.rst

@@ -117,24 +117,24 @@ Documentation
    :maxdepth: 2
    :caption: API Reference
 
-   mmedit.apis.inferencers <autoapi/mmedit/apis/inferencers/index.rst>
-   mmedit.structures <autoapi/mmedit/structures/index.rst>
-   mmedit.datasets <autoapi/mmedit/datasets/index.rst>
-   mmedit.datasets.transforms <autoapi/mmedit/datasets/transforms/index.rst>
-   mmedit.evaluation <autoapi/mmedit/evaluation/index.rst>
-   mmedit.visualization <autoapi/mmedit/visualization/index.rst>
-   mmedit.engine.hooks <autoapi/mmedit/engine/hooks/index.rst>
-   mmedit.engine.logging <autoapi/mmedit/engine/logging/index.rst>
-   mmedit.engine.optimizers <autoapi/mmedit/engine/optimizers/index.rst>
-   mmedit.engine.runner <autoapi/mmedit/engine/runner/index.rst>
-   mmedit.engine.schedulers <autoapi/mmedit/engine/schedulers/index.rst>
-   mmedit.models.base_archs <autoapi/mmedit/models/base_archs/index.rst>
-   mmedit.models.base_models <autoapi/mmedit/models/base_models/index.rst>
-   mmedit.models.losses <autoapi/mmedit/models/losses/index.rst>
-   mmedit.models.data_preprocessors <autoapi/mmedit/models/data_preprocessors/index.rst>
-   mmedit.models.utils <autoapi/mmedit/models/losses/utils.rst>
-   mmedit.models.editors <autoapi/mmedit/models/editors/index.rst>
-   mmedit.utils <autoapi/mmedit/utils/index.rst>
+   mmagic.apis.inferencers <autoapi/mmagic/apis/inferencers/index.rst>
+   mmagic.structures <autoapi/mmagic/structures/index.rst>
+   mmagic.datasets <autoapi/mmagic/datasets/index.rst>
+   mmagic.datasets.transforms <autoapi/mmagic/datasets/transforms/index.rst>
+   mmagic.evaluation <autoapi/mmagic/evaluation/index.rst>
+   mmagic.visualization <autoapi/mmagic/visualization/index.rst>
+   mmagic.engine.hooks <autoapi/mmagic/engine/hooks/index.rst>
+   mmagic.engine.logging <autoapi/mmagic/engine/logging/index.rst>
+   mmagic.engine.optimizers <autoapi/mmagic/engine/optimizers/index.rst>
+   mmagic.engine.runner <autoapi/mmagic/engine/runner/index.rst>
+   mmagic.engine.schedulers <autoapi/mmagic/engine/schedulers/index.rst>
+   mmagic.models.base_archs <autoapi/mmagic/models/base_archs/index.rst>
+   mmagic.models.base_models <autoapi/mmagic/models/base_models/index.rst>
+   mmagic.models.losses <autoapi/mmagic/models/losses/index.rst>
+   mmagic.models.data_preprocessors <autoapi/mmagic/models/data_preprocessors/index.rst>
+   mmagic.models.utils <autoapi/mmagic/models/losses/utils.rst>
+   mmagic.models.editors <autoapi/mmagic/models/editors/index.rst>
+   mmagic.utils <autoapi/mmagic/utils/index.rst>
 
 
 .. toctree::

docs/zh_cn/conf.py

@@ -45,7 +45,7 @@
 
 extensions.append('autoapi.extension')
 autoapi_type = 'python'
-autoapi_dirs = ['../../mmedit']
+autoapi_dirs = ['../../mmagic']
 autoapi_add_toctree_entry = False
 autoapi_template_dir = '_templates'
 # autoapi_options = ['members', 'undoc-members', 'show-module-summary']
@@ -67,7 +67,7 @@
 # autodoc_inherit_docstrings = True
 
 autodoc_mock_imports = [
-    'mmedit.version', 'mmcv._ext', 'mmcv.ops.ModulatedDeformConv2d',
+    'mmagic.version', 'mmcv._ext', 'mmcv.ops.ModulatedDeformConv2d',
     'mmcv.ops.modulated_deform_conv2d', 'clip', 'resize_right', 'pandas'
 ]
 

docs/zh_cn/index.rst

@@ -88,24 +88,24 @@
    :maxdepth: 2
    :caption: 接口文档（英文）
 
-   mmedit.apis.inferencers <autoapi/mmedit/apis/inferencers/index.rst>
-   mmedit.structures <autoapi/mmedit/structures/index.rst>
-   mmedit.datasets <autoapi/mmedit/datasets/index.rst>
-   mmedit.datasets.transforms <autoapi/mmedit/datasets/transforms/index.rst>
-   mmedit.evaluation <autoapi/mmedit/evaluation/index.rst>
-   mmedit.visualization <autoapi/mmedit/visualization/index.rst>
-   mmedit.engine.hooks <autoapi/mmedit/engine/hooks/index.rst>
-   mmedit.engine.logging <autoapi/mmedit/engine/logging/index.rst>
-   mmedit.engine.optimizers <autoapi/mmedit/engine/optimizers/index.rst>
-   mmedit.engine.runner <autoapi/mmedit/engine/runner/index.rst>
-   mmedit.engine.schedulers <autoapi/mmedit/engine/schedulers/index.rst>
-   mmedit.models.base_archs <autoapi/mmedit/models/base_archs/index.rst>
-   mmedit.models.base_models <autoapi/mmedit/models/base_models/index.rst>
-   mmedit.models.losses <autoapi/mmedit/models/losses/index.rst>
-   mmedit.models.data_preprocessors <autoapi/mmedit/models/data_preprocessors/index.rst>
-   mmedit.models.utils <autoapi/mmedit/models/losses/utils.rst>
-   mmedit.models.editors <autoapi/mmedit/models/editors/index.rst>
-   mmedit.utils <autoapi/mmedit/utils/index.rst>
+   mmagic/apis.inferencers <autoapi/mmagic/apis/inferencers/index.rst>
+   mmagic/structures <autoapi/mmagic/structures/index.rst>
+   mmagic/datasets <autoapi/mmagic/datasets/index.rst>
+   mmagic/datasets.transforms <autoapi/mmagic/datasets/transforms/index.rst>
+   mmagic/evaluation <autoapi/mmagic/evaluation/index.rst>
+   mmagic/visualization <autoapi/mmagic/visualization/index.rst>
+   mmagic/engine.hooks <autoapi/mmagic/engine/hooks/index.rst>
+   mmagic/engine.logging <autoapi/mmagic/engine/logging/index.rst>
+   mmagic/engine.optimizers <autoapi/mmagic/engine/optimizers/index.rst>
+   mmagic/engine.runner <autoapi/mmagic/engine/runner/index.rst>
+   mmagic/engine.schedulers <autoapi/mmagic/engine/schedulers/index.rst>
+   mmagic/models.base_archs <autoapi/mmagic/models/base_archs/index.rst>
+   mmagic/models.base_models <autoapi/mmagic/models/base_models/index.rst>
+   mmagic/models.losses <autoapi/mmagic/models/losses/index.rst>
+   mmagic/models.data_preprocessors <autoapi/mmagic/models/data_preprocessors/index.rst>
+   mmagic/models.utils <autoapi/mmagic/models/losses/utils.rst>
+   mmagic/models.editors <autoapi/mmagic/models/editors/index.rst>
+   mmagic/utils <autoapi/mmagic/utils/index.rst>
 
 .. toctree::
    :maxdepth: 1

setup.cfg

@@ -18,7 +18,7 @@ SPLIT_PENALTY_AFTER_OPENING_BRACKET=888
 line_length = 79
 multi_line_output = 0
 extra_standard_library = setuptools
-known_first_party = mmedit
+known_first_party = mmagic
 known_third_party = PIL,cv2,lmdb,mmcv,numpy,onnx,onnxruntime,packaging,pymatting,pytest,pytorch_sphinx_theme,requests,scipy,titlecase,torch,torchvision,ts
 no_lines_before = STDLIB,LOCALFOLDER
 default_section = THIRDPARTY

setup.py

@@ -17,7 +17,7 @@ def readme():
     return content
 
 
-version_file = 'mmedit/version.py'
+version_file = 'mmagic/version.py'
 
 
 def get_git_hash():
@@ -51,7 +51,7 @@ def get_hash():
         sha = get_git_hash()[:7]
     elif os.path.exists(version_file):
         try:
-            from mmedit.version import __version__
+            from mmagic.version import __version__
             sha = __version__.split('+')[-1]
         except ImportError:
             raise ImportError('Unable to get git version')
@@ -191,7 +191,7 @@ def add_mim_extention():
 
     filenames = ['tools', 'configs', 'demo', 'model-index.yml']
     repo_path = osp.dirname(__file__)
-    mim_path = osp.join(repo_path, 'mmedit', '.mim')
+    mim_path = osp.join(repo_path, 'mmagic', '.mim')
     os.makedirs(mim_path, exist_ok=True)
 
     for filename in filenames:
@@ -232,16 +232,16 @@ def add_mim_extention():
 if __name__ == '__main__':
     add_mim_extention()
     setup(
-        name='mmedit',
+        name='mmagic',
         version=get_version(),
         description='OpenMMLab Image and Video Editing Toolbox and Benchmark',
         long_description=readme(),
         long_description_content_type='text/markdown',
-        maintainer='MMEditing Contributors',
+        maintainer='MMagic Contributors',
         maintainer_email='[email protected]',
         keywords='computer vision, super resolution, video interpolation, '
         'inpainting, matting, SISR, RefSR, VSR, GAN, VFI',
-        url='https://github.com/open-mmlab/mmediting',
+        url='https://github.com/open-mmlab/mmagic',
         packages=find_packages(exclude=('configs', 'tools', 'demo')),
         include_package_data=True,
         classifiers=[

tests/test_models/test_losses/test_clip_loss.py

@@ -1,12 +1,12 @@
 # Copyright (c) OpenMMLab. All rights reserved.
 import platform
 
+import clip
 import pytest
 import torch
 from mmengine.utils import digit_version
 from mmengine.utils.dl_utils import TORCH_VERSION
 
-import clip
 from mmagic.models.losses import CLIPLoss
 
 

tests/test_models/test_losses/test_loss_comps/test_clip_loss_comps.py

@@ -1,12 +1,12 @@
 # Copyright (c) OpenMMLab. All rights reserved.
 import platform
 
+import clip
 import pytest
 import torch
 from mmengine.utils import digit_version
 from mmengine.utils.dl_utils import TORCH_VERSION
 
-import clip
 from mmagic.models.losses import CLIPLossComps