mindspore-mindinsight/mindinsight/explainer/common/enums.py

# Copyright 2020-2021 Huawei Technologies Co., Ltd
#
# 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.
# ============================================================================
"""Enums for explain data."""
import enum

class BaseEnum(enum.Enum):

    @classmethod
    def list_members(cls):
        """List all members."""
        return [member.value for member in cls]


class DataManagerStatus(BaseEnum):
    """Data manager status."""
    INIT = 'INIT'
    LOADING = 'LOADING'
    DONE = 'DONE'
    INVALID = 'INVALID'


class ExplainFieldsEnum(BaseEnum):
    """Plugin Name Enum."""
    EXPLAIN = 'explain'
    SAMPLE_ID = 'sample_id'
    BENCHMARK = 'benchmark'
    METADATA = 'metadata'
    GROUND_TRUTH_LABEL = 'ground_truth_label'
    INFERENCE = 'inference'
    EXPLANATION = 'explanation'
    HIERARCHICAL_OCCLUSION = 'hierarchical_occlusion'
    STATUS = 'status'


@enum.unique
class CacheStatus(enum.Enum):
    """Train job cache status."""
    NOT_IN_CACHE = "NOT_IN_CACHE"
    CACHING = "CACHING"
    CACHED = "CACHED"


class ExplanationKeys(enum.Enum):
    """Query type enums."""
    HOC = "hoc_layers"  # HOC: Hierarchical Occlusion, an explanation method we propose
    SALIENCY = "saliency_maps"


class ImageQueryTypes(enum.Enum):
    """Image query type enums."""
    ORIGINAL = 'original'  # Query for the original image
    OUTCOME = 'outcome'  # Query for outcome of HOC explanation
    OVERLAY = 'overlay'  # Query for saliency maps overlay