-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
hub.py
311 lines (233 loc) · 8.99 KB
/
hub.py
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
95
96
97
98
99
100
101
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# Copyright (c) 2021 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.
import os
import shutil
import sys
import zipfile
from paddle.utils.download import get_path_from_url
__all__ = []
DEFAULT_CACHE_DIR = '~/.cache'
VAR_DEPENDENCY = 'dependencies'
MODULE_HUBCONF = 'hubconf.py'
HUB_DIR = os.path.expanduser(os.path.join('~', '.cache', 'paddle', 'hub'))
def _remove_if_exists(path):
if os.path.exists(path):
if os.path.isfile(path):
os.remove(path)
else:
shutil.rmtree(path)
def _import_module(name, repo_dir):
sys.path.insert(0, repo_dir)
try:
hub_module = __import__(name)
sys.modules.pop(name)
except ImportError:
sys.path.remove(repo_dir)
raise RuntimeError(
'Please make sure config exists or repo error messages above fixed when importing'
)
sys.path.remove(repo_dir)
return hub_module
def _git_archive_link(repo_owner, repo_name, branch, source):
if source == 'github':
return 'https://github.com/{}/{}/archive/{}.zip'.format(
repo_owner, repo_name, branch
)
elif source == 'gitee':
return 'https://gitee.com/{}/{}/repository/archive/{}.zip'.format(
repo_owner, repo_name, branch
)
def _parse_repo_info(repo, source):
branch = 'main' if source == 'github' else 'master'
if ':' in repo:
repo_info, branch = repo.split(':')
else:
repo_info = repo
repo_owner, repo_name = repo_info.split('/')
return repo_owner, repo_name, branch
def _make_dirs(dirname):
try:
from pathlib import Path
except ImportError:
from pathlib2 import Path
Path(dirname).mkdir(exist_ok=True)
def _get_cache_or_reload(repo, force_reload, verbose=True, source='github'):
# Setup hub_dir to save downloaded files
hub_dir = HUB_DIR
_make_dirs(hub_dir)
# Parse github/gitee repo information
repo_owner, repo_name, branch = _parse_repo_info(repo, source)
# Github allows branch name with slash '/',
# this causes confusion with path on both Linux and Windows.
# Backslash is not allowed in Github branch name so no need to
# to worry about it.
normalized_br = branch.replace('/', '_')
# Github renames folder repo/v1.x.x to repo-1.x.x
# We don't know the repo name before downloading the zip file
# and inspect name from it.
# To check if cached repo exists, we need to normalize folder names.
repo_dir = os.path.join(
hub_dir, '_'.join([repo_owner, repo_name, normalized_br])
)
use_cache = (not force_reload) and os.path.exists(repo_dir)
if use_cache:
if verbose:
sys.stderr.write(f'Using cache found in {repo_dir}\n')
else:
cached_file = os.path.join(hub_dir, normalized_br + '.zip')
_remove_if_exists(cached_file)
url = _git_archive_link(repo_owner, repo_name, branch, source=source)
fpath = get_path_from_url(
url,
hub_dir,
check_exist=not force_reload,
decompress=False,
method=('wget' if source == 'gitee' else 'get'),
)
shutil.move(fpath, cached_file)
with zipfile.ZipFile(cached_file) as cached_zipfile:
extraced_repo_name = cached_zipfile.infolist()[0].filename
extracted_repo = os.path.join(hub_dir, extraced_repo_name)
_remove_if_exists(extracted_repo)
# Unzip the code and rename the base folder
cached_zipfile.extractall(hub_dir)
_remove_if_exists(cached_file)
_remove_if_exists(repo_dir)
# rename the repo
shutil.move(extracted_repo, repo_dir)
return repo_dir
def _load_entry_from_hubconf(m, name):
'''load entry from hubconf'''
if not isinstance(name, str):
raise ValueError(
'Invalid input: model should be a str of function name'
)
func = getattr(m, name, None)
if func is None or not callable(func):
raise RuntimeError(f'Cannot find callable {name} in hubconf')
return func
def _check_module_exists(name):
try:
__import__(name)
return True
except ImportError:
return False
def _check_dependencies(m):
dependencies = getattr(m, VAR_DEPENDENCY, None)
if dependencies is not None:
missing_deps = [
pkg for pkg in dependencies if not _check_module_exists(pkg)
]
if len(missing_deps):
raise RuntimeError(
'Missing dependencies: {}'.format(', '.join(missing_deps))
)
def list(repo_dir, source='github', force_reload=False):
r"""
List all entrypoints available in `github` hubconf.
Args:
repo_dir(str): github or local path.
github path (str): a str with format "repo_owner/repo_name[:tag_name]" with an optional
tag/branch. The default branch is `main` if not specified.
local path (str): local repo path
source (str): `github` | `gitee` | `local`, default is `github`.
force_reload (bool, optional): whether to discard the existing cache and force a fresh download, default is `False`.
Returns:
entrypoints: a list of available entrypoint names
Example:
.. code-block:: python
import paddle
paddle.hub.list('lyuwenyu/paddlehub_demo:main', source='github', force_reload=False)
"""
if source not in ('github', 'gitee', 'local'):
raise ValueError(
'Unknown source: "{}". Allowed values: "github" | "gitee" | "local".'.format(
source
)
)
if source in ('github', 'gitee'):
repo_dir = _get_cache_or_reload(
repo_dir, force_reload, True, source=source
)
hub_module = _import_module(MODULE_HUBCONF.split('.')[0], repo_dir)
entrypoints = [
f
for f in dir(hub_module)
if callable(getattr(hub_module, f)) and not f.startswith('_')
]
return entrypoints
def help(repo_dir, model, source='github', force_reload=False):
"""
Show help information of model
Args:
repo_dir(str): github or local path.
github path (str): a str with format "repo_owner/repo_name[:tag_name]" with an optional
tag/branch. The default branch is `main` if not specified.
local path (str): local repo path.
model (str): model name.
source (str): `github` | `gitee` | `local`, default is `github`.
force_reload (bool, optional): default is `False`.
Return:
docs
Example:
.. code-block:: python
import paddle
paddle.hub.help('lyuwenyu/paddlehub_demo:main', model='MM', source='github')
"""
if source not in ('github', 'gitee', 'local'):
raise ValueError(
'Unknown source: "{}". Allowed values: "github" | "gitee" | "local".'.format(
source
)
)
if source in ('github', 'gitee'):
repo_dir = _get_cache_or_reload(
repo_dir, force_reload, True, source=source
)
hub_module = _import_module(MODULE_HUBCONF.split('.')[0], repo_dir)
entry = _load_entry_from_hubconf(hub_module, model)
return entry.__doc__
def load(repo_dir, model, source='github', force_reload=False, **kwargs):
"""
Load model
Args:
repo_dir(str): github or local path.
github path (str): a str with format "repo_owner/repo_name[:tag_name]" with an optional
tag/branch. The default branch is `main` if not specified.
local path (str): local repo path.
model (str): model name.
source (str): `github` | `gitee` | `local`, default is `github`.
force_reload (bool, optional): default is `False`.
**kwargs: parameters using for model
Return:
paddle model
Example:
.. code-block:: python
import paddle
paddle.hub.load('lyuwenyu/paddlehub_demo:main', model='MM', source='github')
"""
if source not in ('github', 'gitee', 'local'):
raise ValueError(
'Unknown source: "{}". Allowed values: "github" | "gitee" | "local".'.format(
source
)
)
if source in ('github', 'gitee'):
repo_dir = _get_cache_or_reload(
repo_dir, force_reload, True, source=source
)
hub_module = _import_module(MODULE_HUBCONF.split('.')[0], repo_dir)
_check_dependencies(hub_module)
entry = _load_entry_from_hubconf(hub_module, model)
return entry(**kwargs)