pipeline_utils.py 5.73 KB
Newer Older
Patrick von Platen's avatar
Patrick von Platen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# coding=utf-8
# Copyright 2022 The HuggingFace Inc. team.
# Copyright (c) 2022, NVIDIA CORPORATION.  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.

Patrick von Platen's avatar
improve  
Patrick von Platen committed
17
import importlib
Patrick von Platen's avatar
Patrick von Platen committed
18
19
import os
from typing import Optional, Union
Patrick von Platen's avatar
up  
Patrick von Platen committed
20
from huggingface_hub import snapshot_download
Patrick von Platen's avatar
Patrick von Platen committed
21

22
from .utils import logging, DIFFUSERS_CACHE
Patrick von Platen's avatar
Patrick von Platen committed
23

Patrick von Platen's avatar
Patrick von Platen committed
24
from .configuration_utils import ConfigMixin
patil-suraj's avatar
patil-suraj committed
25
from .dynamic_modules_utils import get_class_from_dynamic_module
Patrick von Platen's avatar
improve  
Patrick von Platen committed
26

Patrick von Platen's avatar
Patrick von Platen committed
27
28
29
30
31
32
33
34
35

INDEX_FILE = "diffusion_model.pt"


logger = logging.get_logger(__name__)


LOADABLE_CLASSES = {
    "diffusers": {
Patrick von Platen's avatar
Patrick von Platen committed
36
        "ModelMixin": ["save_pretrained", "from_pretrained"],
Patrick von Platen's avatar
improve  
Patrick von Platen committed
37
        "GaussianDDPMScheduler": ["save_config", "from_config"],
Patrick von Platen's avatar
Patrick von Platen committed
38
39
    },
    "transformers": {
Patrick von Platen's avatar
Patrick von Platen committed
40
        "ModelMixin": ["save_pretrained", "from_pretrained"],
Patrick von Platen's avatar
Patrick von Platen committed
41
42
43
44
    },
}


Patrick von Platen's avatar
Patrick von Platen committed
45
class DiffusionPipeline(ConfigMixin):
Patrick von Platen's avatar
Patrick von Platen committed
46
47
48

    config_name = "model_index.json"

Patrick von Platen's avatar
up  
Patrick von Platen committed
49
    def register_modules(self, **kwargs):
Patrick von Platen's avatar
Patrick von Platen committed
50
51
52
53
54
55
        for name, module in kwargs.items():
            # retrive library
            library = module.__module__.split(".")[0]
            # retrive class_name
            class_name = module.__class__.__name__

56
57
            register_dict = {name: (library, class_name)}

Patrick von Platen's avatar
Patrick von Platen committed
58
            # save model index config
59
            self.register(**register_dict)
Patrick von Platen's avatar
Patrick von Platen committed
60
61
62

            # set models
            setattr(self, name, module)
63

64
65
        register_dict = {"_module" : self.__module__.split(".")[-1] + ".py"}
        self.register(**register_dict)
Patrick von Platen's avatar
Patrick von Platen committed
66
67
68
69

    def save_pretrained(self, save_directory: Union[str, os.PathLike]):
        self.save_config(save_directory)

70
        model_index_dict = self.config
Patrick von Platen's avatar
Patrick von Platen committed
71
        model_index_dict.pop("_class_name")
72
        model_index_dict.pop("_diffusers_version")
73
        model_index_dict.pop("_module")
Patrick von Platen's avatar
Patrick von Platen committed
74

75
        for name, (library_name, class_name) in model_index_dict.items():
Patrick von Platen's avatar
Patrick von Platen committed
76
77
            importable_classes = LOADABLE_CLASSES[library_name]

78
79
80
81
            # TODO: Suraj
            if library_name == self.__module__:
                library_name = self

Patrick von Platen's avatar
Patrick von Platen committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
            library = importlib.import_module(library_name)
            class_obj = getattr(library, class_name)
            class_candidates = {c: getattr(library, c) for c in importable_classes.keys()}

            save_method_name = None
            for class_name, class_candidate in class_candidates.items():
                if issubclass(class_obj, class_candidate):
                    save_method_name = importable_classes[class_name][0]

            save_method = getattr(getattr(self, name), save_method_name)
            save_method(os.path.join(save_directory, name))

    @classmethod
    def from_pretrained(cls, pretrained_model_name_or_path: Optional[Union[str, os.PathLike]], **kwargs):
96
97
98
99
100
101
102
103
104
105
106
        r"""
            Add docstrings
        """
        cache_dir = kwargs.pop("cache_dir", DIFFUSERS_CACHE)
        force_download = kwargs.pop("force_download", False)
        resume_download = kwargs.pop("resume_download", False)
        proxies = kwargs.pop("proxies", None)
        output_loading_info = kwargs.pop("output_loading_info", False)
        local_files_only = kwargs.pop("local_files_only", False)
        use_auth_token = kwargs.pop("use_auth_token", None)

Patrick von Platen's avatar
Patrick von Platen committed
107
        # use snapshot download here to get it working from from_pretrained
Patrick von Platen's avatar
Patrick von Platen committed
108
        if not os.path.isdir(pretrained_model_name_or_path):
109
110
111
112
113
114
115
116
117
118
            cached_folder = snapshot_download(
                pretrained_model_name_or_path,
                cache_dir=cache_dir,
                force_download=force_download,
                resume_download=resume_download,
                proxies=proxies,
                output_loading_info=output_loading_info,
                local_files_only=local_files_only,
                use_auth_token=use_auth_token,
            )
Patrick von Platen's avatar
Patrick von Platen committed
119
120
        else:
            cached_folder = pretrained_model_name_or_path
121

patil-suraj's avatar
patil-suraj committed
122
        config_dict = cls.get_config_dict(cached_folder)
123

patil-suraj's avatar
patil-suraj committed
124
125
        module = config_dict["_module"]
        class_name_ = config_dict["_class_name"]
126

127
128
129
130
        if class_name_ == cls.__name__:
            pipeline_class = cls
        else:
            pipeline_class = get_class_from_dynamic_module(cached_folder, module, class_name_, cached_folder)
131

132
        init_dict, _ = pipeline_class.extract_init_dict(config_dict, **kwargs)
Patrick von Platen's avatar
Patrick von Platen committed
133
134
135

        init_kwargs = {}

patil-suraj's avatar
patil-suraj committed
136
        for name, (library_name, class_name) in init_dict.items():
Patrick von Platen's avatar
Patrick von Platen committed
137
138
            importable_classes = LOADABLE_CLASSES[library_name]

139
140
141
142
            if library_name == module:
                # TODO(Suraj)
                pass

Patrick von Platen's avatar
Patrick von Platen committed
143
144
145
146
147
148
149
150
151
152
153
            library = importlib.import_module(library_name)
            class_obj = getattr(library, class_name)
            class_candidates = {c: getattr(library, c) for c in importable_classes.keys()}

            load_method_name = None
            for class_name, class_candidate in class_candidates.items():
                if issubclass(class_obj, class_candidate):
                    load_method_name = importable_classes[class_name][1]

            load_method = getattr(class_obj, load_method_name)

Patrick von Platen's avatar
Patrick von Platen committed
154
            if os.path.isdir(os.path.join(cached_folder, name)):
155
156
157
                loaded_sub_model = load_method(os.path.join(cached_folder, name))
            else:
                loaded_sub_model = load_method(cached_folder)
Patrick von Platen's avatar
Patrick von Platen committed
158

159
            init_kwargs[name] = loaded_sub_model  # UNet(...), # DiffusionSchedule(...)
Patrick von Platen's avatar
Patrick von Platen committed
160

161
        model = pipeline_class(**init_kwargs)
Patrick von Platen's avatar
Patrick von Platen committed
162
        return model