PaddleX/paddlex/repo_manager/meta.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.

__all__ = ['get_all_repo_names']

REPO_DOWNLOAD_BASE = "https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/repos/"

REPO_NAMES = [
    'PaddleClas', 'PaddleOCR', 'PaddleDetection', 'PaddleSeg', 'PaddleNLP',
    'PaddleTS'
]

REPO_META = {
    'PaddleSeg': {
        'git_url': '/PaddlePaddle/PaddleSeg.git',
        'platform': 'github',
        'branch': 'develop',
        'pkg_name': 'paddleseg',
        'lib_name': 'paddleseg',
        'pdx_pkg_name': 'PaddleSeg_api',
        'editable': False,
        'extra_req_files': ['Matting/requirements.txt'],
        'path_env': 'PADDLE_PDX_PADDLESEG_PATH',
    },
    'PaddleClas': {
        'git_url': '/PaddlePaddle/PaddleClas.git',
        'platform': 'github',
        'branch': 'develop',
        'pkg_name': 'paddleclas',
        'lib_name': 'paddleclas',
        'pdx_pkg_name': 'PaddleClas_api',
        # PaddleClas must be installed in non-editable mode, otherwise it throws
        # an Import error.
        'editable': False,
        'path_env': 'PADDLE_PDX_PADDLECLAS_PATH',
    },
    'PaddleDetection': {
        'git_url': '/PaddlePaddle/PaddleDetection.git',
        'platform': 'github',
        'branch': 'develop',
        'pkg_name': 'paddledet',
        'lib_name': 'ppdet',
        'pdx_pkg_name': 'PaddleDetection_api',
        'editable': False,
        'path_env': 'PADDLE_PDX_PADDLEDETECTION_PATH',
    },
    'PaddleOCR': {
        'git_url': '/PaddlePaddle/PaddleOCR.git',
        'platform': 'github',
        'branch': 'main',
        'pkg_name': 'paddleocr',
        'lib_name': 'paddleocr',
        'pdx_pkg_name': 'PaddleOCR_api',
        'editable': False,
        'extra_req_files': ['ppstructure/kie/requirements.txt'],
        'path_env': 'PADDLE_PDX_PADDLEOCR_PATH',
        'requires': ['PaddleNLP'],
    },
    'PaddleTS': {
        'git_url': '/PaddlePaddle/PaddleTS.git',
        'platform': 'github',
        'branch': 'release_v1.1',
        'pkg_name': 'paddlets',
        'lib_name': 'paddlets',
        'pdx_pkg_name': 'PaddleTS_api',
        'editable': False,
        'path_env': 'PADDLE_PDX_PADDLETS_PATH',
        'pdx_pkg_deps': ['pandas', 'ruamel.yaml'],
    },
    'PaddleNLP': {
        'git_url': '/PaddlePaddle/PaddleNLP.git',
        'platform': 'github',
        'branch': 'release/2.9',
        'pkg_name': 'paddlenlp',
        'lib_name': 'paddlenlp',
        'pdx_pkg_name': 'PaddleNLP_api',
        'editable': False,
        'path_env': 'PADDLE_PDX_PADDLENLP_PATH',
    },
    'PaddleSpeech': {
        'git_url': '/PaddlePaddle/PaddleSpeech.git',
        'platform': 'github',
        'branch': 'develop',
        'pkg_name': 'paddlespeech',
        'lib_name': 'paddlespeech',
        'pdx_pkg_name': 'PaddleSpeech_api',
        'editable': False,
        'path_env': 'PADDLE_PDX_PADDLESPEECH_PATH',
        'requires': ['PaddleNLP'],
    },
    'PARL': {
        'git_url': '/PaddlePaddle/PARL.git',
        'platform': 'github',
        'branch': 'develop',
        'pkg_name': 'parl',
        'lib_name': 'parl',
        'pdx_pkg_name': 'PARL_api',
        'editable': False,
        'path_env': 'PADDLE_PDX_PARL_PATH',
    },
    'PaddleMIX': {
        'git_url': '/PaddlePaddle/PaddleMIX.git',
        'platform': 'github',
        'branch': 'develop',
        'pkg_name': 'paddlemix',
        'lib_name': 'paddlemix',
        'pdx_pkg_name': 'PaddleMIX_api',
        'editable': True,
        'extra_editable': 'ppdiffusers',
        'path_env': 'PADDLE_PDX_PADDLEMIX_PATH',
        'requires': ['PaddleNLP'],
    },
}


def get_repo_meta(repo_name):
    """ get_repo_meta """
    return REPO_META[repo_name]


def get_all_repo_names():
    """ get_all_repo_names """
    return REPO_NAMES