check.py 4.0 KB
Newer Older
W
WuHaobo 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
#
# 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.

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

W
WuHaobo 已提交
19
import os
W
WuHaobo 已提交
20 21
import sys

22 23 24
import paddle
# TODO: need to be fixed in the future.
from paddle.fluid import is_compiled_with_cuda
W
WuHaobo 已提交
25

W
WuHaobo 已提交
26
from ppcls.modeling import get_architectures
W
WuHaobo 已提交
27 28 29 30 31 32 33 34 35
from ppcls.modeling import similar_architectures
from ppcls.utils import logger


def check_version():
    """
    Log error and exit when the installed version of paddlepaddle is
    not satisfied.
    """
littletomatodonkey's avatar
littletomatodonkey 已提交
36
    err = "PaddlePaddle version 1.8.0 or higher is required, " \
W
WuHaobo 已提交
37
          "or a suitable develop version is satisfied as well. \n" \
38
          "Please make sure the version is good with your code."
W
WuHaobo 已提交
39
    try:
40
        paddle.utils.require_version('0.0.0')
W
WuHaobo 已提交
41
    except Exception:
W
WuHaobo 已提交
42 43 44 45 46 47 48 49 50 51 52 53
        logger.error(err)
        sys.exit(1)


def check_gpu():
    """
    Log error and exit when using paddlepaddle cpu version.
    """
    err = "You are using paddlepaddle cpu version! Please try to " \
          "install paddlepaddle-gpu to run model on GPU."

    try:
54
        assert is_compiled_with_cuda()
W
WuHaobo 已提交
55 56 57 58 59 60 61 62 63
    except AssertionError:
        logger.error(err)
        sys.exit(1)


def check_architecture(architecture):
    """
    check architecture and recommend similar architectures
    """
littletomatodonkey's avatar
littletomatodonkey 已提交
64
    assert isinstance(architecture, dict), \
W
WuHaobo 已提交
65
        ("the type of architecture({}) should be dict". format(architecture))
littletomatodonkey's avatar
littletomatodonkey 已提交
66
    assert "name" in architecture, \
W
WuHaobo 已提交
67 68
        ("name must be in the architecture keys, just contains: {}". format(
            architecture.keys()))
littletomatodonkey's avatar
littletomatodonkey 已提交
69 70 71

    similar_names = similar_architectures(architecture["name"],
                                          get_architectures())
W
WuHaobo 已提交
72
    model_list = ', '.join(similar_names)
S
shippingwang 已提交
73
    err = "Architecture [{}] is not exist! Maybe you want: [{}]" \
littletomatodonkey's avatar
littletomatodonkey 已提交
74
          "".format(architecture["name"], model_list)
W
WuHaobo 已提交
75
    try:
littletomatodonkey's avatar
littletomatodonkey 已提交
76
        assert architecture["name"] in similar_names
W
WuHaobo 已提交
77 78 79 80 81 82 83 84 85 86 87 88
    except AssertionError:
        logger.error(err)
        sys.exit(1)


def check_mix(architecture, use_mix=False):
    """
    check mix parameter
    """
    err = "Cannot use mix processing in GoogLeNet, " \
          "please set use_mix = False."
    try:
W
WuHaobo 已提交
89 90
        if architecture["name"] == "GoogLeNet":
            assert use_mix is not True
W
WuHaobo 已提交
91 92 93 94 95 96 97 98 99 100
    except AssertionError:
        logger.error(err)
        sys.exit(1)


def check_classes_num(classes_num):
    """
    check classes_num
    """
    err = "classes_num({}) should be a positive integer" \
W
WuHaobo 已提交
101
        "and larger than 1".format(classes_num)
W
WuHaobo 已提交
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    try:
        assert isinstance(classes_num, int)
        assert classes_num > 1
    except AssertionError:
        logger.error(err)
        sys.exit(1)


def check_data_dir(path):
    """
    check cata_dir
    """
    err = "Data path is not exist, please given a right path" \
          "".format(path)
    try:
        assert os.isdir(path)
    except AssertionError:
        logger.error(err)
        sys.exit(1)


def check_function_params(config, key):
    """
    check specify config
    """
    k_config = config.get(key)
    assert k_config is not None, \
W
WuHaobo 已提交
129
        ('{} is required in config'.format(key))
W
WuHaobo 已提交
130 131

    assert k_config.get('function'), \
W
WuHaobo 已提交
132
        ('function is required {} config'.format(key))
W
WuHaobo 已提交
133 134
    params = k_config.get('params')
    assert params is not None, \
W
WuHaobo 已提交
135
        ('params is required in {} config'.format(key))
W
WuHaobo 已提交
136
    assert isinstance(params, dict), \
W
WuHaobo 已提交
137
        ('the params in {} config should be a dict'.format(key))