RecTools/rectools/compat.py at 78a384c59fb83bf3e14c6c478c1c1015a3dd3169 · MTSWebServices/RecTools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#  Copyright 2022-2026 MTS (Mobile Telesystems)
#
#  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 typing as tp


class RequirementUnavailable:
    """Base class for dummy classes, which are returned if there are no dependencies required for the original class"""

    requirement: str = NotImplemented

    def __new__(cls, *args: tp.Any, **kwargs: tp.Any) -> tp.Any:
        """Raise ImportError when an attempt to instantiate an unavailable model is made"""
        raise ImportError(
            f"Requirement `{cls.requirement}` is not satisfied. Run `pip install rectools[{cls.requirement}]` "
            f"to install extra requirements before accessing {cls.__name__}."
        )


class LightFMWrapperModel(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "lightfm"


class HSTUModel(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "torch"


class DSSMModel(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "torch"


class SASRecModel(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "torch"


class BERT4RecModel(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "torch"


class CatBoostReranker(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "catboost"


class ItemToItemAnnRecommender(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "nmslib"


class UserToItemAnnRecommender(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "nmslib"


class VisualApp(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "visuals"


class ItemToItemVisualApp(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "visuals"


class MetricsApp(RequirementUnavailable):
    """Dummy class, which is returned if there are no dependencies required for the model"""

    requirement = "visuals"