PaddleX/paddlex/repo_apis/PaddleSeg_api/seg/register.py

# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import os.path as osp
from pathlib import Path

from ...base.register import register_model_info, register_suite_info
from .model import SegModel
from .runner import SegRunner
from .config import SegConfig

REPO_ROOT_PATH = os.environ.get("PADDLE_PDX_PADDLESEG_PATH")
PDX_CONFIG_DIR = osp.abspath(osp.join(osp.dirname(__file__), "..", "configs"))
HPI_CONFIG_DIR = Path(__file__).parent.parent.parent.parent / "utils" / "hpi_configs"

register_suite_info(
    {
        "suite_name": "Seg",
        "model": SegModel,
        "runner": SegRunner,
        "config": SegConfig,
        "runner_root_path": REPO_ROOT_PATH,
    }
)

################ Models Using Universal Config ################
# OCRNet
register_model_info(
    {
        "model_name": "OCRNet_HRNet-W48",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "OCRNet_HRNet-W48.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "OCRNet_HRNet-W48.yaml",
    }
)

register_model_info(
    {
        "model_name": "OCRNet_HRNet-W18",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "OCRNet_HRNet-W18.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "OCRNet_HRNet-W18.yaml",
    }
)

# PP-LiteSeg
register_model_info(
    {
        "model_name": "PP-LiteSeg-T",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "PP-LiteSeg-T.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "supported_train_opts": {
            "device": ["cpu", "gpu_nxcx", "xpu", "npu", "mlu"],
            "dy2st": True,
            "amp": ["O1", "O2"],
        },
        "supported_evaluate_opts": {
            "device": ["cpu", "gpu_nxcx", "xpu", "npu", "mlu"],
            "amp": [],
        },
        "supported_predict_opts": {"device": ["cpu", "gpu", "xpu", "npu", "mlu"]},
        "supported_infer_opts": {"device": ["cpu", "gpu", "xpu", "npu", "mlu"]},
        "supported_dataset_types": [],
        "hpi_config_path": HPI_CONFIG_DIR / "PP-LiteSeg-T.yaml",
    }
)

# PP-LiteSeg
register_model_info(
    {
        "model_name": "PP-LiteSeg-B",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "PP-LiteSeg-B.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "supported_train_opts": {
            "device": ["cpu", "gpu_nxcx", "xpu", "npu", "mlu"],
            "dy2st": True,
            "amp": ["O1", "O2"],
        },
        "supported_evaluate_opts": {
            "device": ["cpu", "gpu_nxcx", "xpu", "npu", "mlu"],
            "amp": [],
        },
        "supported_predict_opts": {"device": ["cpu", "gpu", "xpu", "npu", "mlu"]},
        "supported_infer_opts": {"device": ["cpu", "gpu", "xpu", "npu", "mlu"]},
        "supported_dataset_types": [],
        "hpi_config_path": HPI_CONFIG_DIR / "PP-LiteSeg-B.yaml",
    }
)

# seaformer
register_model_info(
    {
        "model_name": "SeaFormer_base",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SeaFormer_base.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SeaFormer_base.yaml",
    }
)

register_model_info(
    {
        "model_name": "SeaFormer_tiny",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SeaFormer_tiny.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SeaFormer_tiny.yaml",
    }
)

register_model_info(
    {
        "model_name": "SeaFormer_small",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SeaFormer_small.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SeaFormer_small.yaml",
    }
)

register_model_info(
    {
        "model_name": "SeaFormer_large",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SeaFormer_large.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SeaFormer_large.yaml",
    }
)

# SegFormer
register_model_info(
    {
        "model_name": "SegFormer-B0",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SegFormer-B0.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SegFormer-B0.yaml",
    }
)

register_model_info(
    {
        "model_name": "SegFormer-B1",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SegFormer-B1.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SegFormer-B1.yaml",
    }
)

register_model_info(
    {
        "model_name": "SegFormer-B2",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SegFormer-B2.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SegFormer-B2.yaml",
    }
)

register_model_info(
    {
        "model_name": "SegFormer-B3",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SegFormer-B3.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SegFormer-B3.yaml",
    }
)

register_model_info(
    {
        "model_name": "SegFormer-B4",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SegFormer-B4.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SegFormer-B4.yaml",
    }
)

register_model_info(
    {
        "model_name": "SegFormer-B5",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "SegFormer-B5.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "SegFormer-B5.yaml",
    }
)

# deeplab
register_model_info(
    {
        "model_name": "Deeplabv3-R50",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "Deeplabv3-R50.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "Deeplabv3-R50.yaml",
    }
)

register_model_info(
    {
        "model_name": "Deeplabv3-R101",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "Deeplabv3-R101.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "Deeplabv3-R101.yaml",
    }
)

register_model_info(
    {
        "model_name": "Deeplabv3_Plus-R50",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "Deeplabv3_Plus-R50.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "Deeplabv3_Plus-R50.yaml",
    }
)

register_model_info(
    {
        "model_name": "Deeplabv3_Plus-R101",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "Deeplabv3_Plus-R101.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
        "hpi_config_path": HPI_CONFIG_DIR / "Deeplabv3_Plus-R101.yaml",
    }
)


register_model_info(
    {
        "model_name": "STFPM",
        "suite": "Seg",
        "config_path": osp.join(PDX_CONFIG_DIR, "STFPM.yaml"),
        "supported_apis": ["train", "evaluate", "predict", "export"],
    }
)


# For compatibility
def _set_alias(model_name, alias):
    from ...base.register import get_registered_model_info

    record = get_registered_model_info(model_name)
    record = dict(**record)
    record["model_name"] = alias
    register_model_info(record)


_set_alias("OCRNet_HRNet-W48", "ocrnet_hrnetw48")
_set_alias("OCRNet_HRNet-W18", "ocrnet_hrnetw18")
_set_alias("PP-LiteSeg-T", "pp_liteseg_stdc1")