1 | """ |
---|
2 | Core model handling routines. |
---|
3 | """ |
---|
4 | from __future__ import print_function |
---|
5 | |
---|
6 | __all__ = [ |
---|
7 | "list_models", "load_model", "load_model_info", |
---|
8 | "build_model", "precompile_dlls", |
---|
9 | ] |
---|
10 | |
---|
11 | import os |
---|
12 | from os.path import basename, join as joinpath |
---|
13 | from glob import glob |
---|
14 | import re |
---|
15 | |
---|
16 | import numpy as np # type: ignore |
---|
17 | |
---|
18 | from . import generate |
---|
19 | from . import modelinfo |
---|
20 | from . import product |
---|
21 | from . import mixture |
---|
22 | from . import kernelpy |
---|
23 | from . import kernelcuda |
---|
24 | from . import kernelcl |
---|
25 | from . import kerneldll |
---|
26 | from . import custom |
---|
27 | |
---|
28 | # pylint: disable=unused-import |
---|
29 | try: |
---|
30 | from typing import List, Union, Optional, Any |
---|
31 | from .kernel import KernelModel |
---|
32 | from .modelinfo import ModelInfo |
---|
33 | except ImportError: |
---|
34 | pass |
---|
35 | # pylint: enable=unused-import |
---|
36 | |
---|
37 | CUSTOM_MODEL_PATH = os.environ.get('SAS_MODELPATH', "") |
---|
38 | if CUSTOM_MODEL_PATH == "": |
---|
39 | CUSTOM_MODEL_PATH = joinpath(os.path.expanduser("~"), ".sasmodels", "custom_models") |
---|
40 | #if not os.path.isdir(CUSTOM_MODEL_PATH): |
---|
41 | # os.makedirs(CUSTOM_MODEL_PATH) |
---|
42 | |
---|
43 | # TODO: refactor composite model support |
---|
44 | # The current load_model_info/build_model does not reuse existing model |
---|
45 | # definitions when loading a composite model, instead reloading and |
---|
46 | # rebuilding the kernel for each component model in the expression. This |
---|
47 | # is fine in a scripting environment where the model is built when the script |
---|
48 | # starts and is thrown away when the script ends, but may not be the best |
---|
49 | # solution in a long-lived application. This affects the following functions: |
---|
50 | # |
---|
51 | # load_model |
---|
52 | # load_model_info |
---|
53 | # build_model |
---|
54 | |
---|
55 | KINDS = ("all", "py", "c", "double", "single", "opencl", "1d", "2d", |
---|
56 | "nonmagnetic", "magnetic") |
---|
57 | def list_models(kind=None): |
---|
58 | # type: (str) -> List[str] |
---|
59 | """ |
---|
60 | Return the list of available models on the model path. |
---|
61 | |
---|
62 | *kind* can be one of the following: |
---|
63 | |
---|
64 | * all: all models |
---|
65 | * py: python models only |
---|
66 | * c: c models only |
---|
67 | * single: c models which support single precision |
---|
68 | * double: c models which require double precision |
---|
69 | * opencl: c models which run in opencl |
---|
70 | * dll: c models which do not run in opencl |
---|
71 | * 1d: models without orientation |
---|
72 | * 2d: models with orientation |
---|
73 | * magnetic: models supporting magnetic sld |
---|
74 | * nommagnetic: models without magnetic parameter |
---|
75 | |
---|
76 | For multiple conditions, combine with plus. For example, *c+single+2d* |
---|
77 | would return all oriented models implemented in C which can be computed |
---|
78 | accurately with single precision arithmetic. |
---|
79 | """ |
---|
80 | if kind and any(k not in KINDS for k in kind.split('+')): |
---|
81 | raise ValueError("kind not in " + ", ".join(KINDS)) |
---|
82 | files = sorted(glob(joinpath(generate.MODEL_PATH, "[a-zA-Z]*.py"))) |
---|
83 | available_models = [basename(f)[:-3] for f in files] |
---|
84 | if kind and '+' in kind: |
---|
85 | all_kinds = kind.split('+') |
---|
86 | condition = lambda name: all(_matches(name, k) for k in all_kinds) |
---|
87 | else: |
---|
88 | condition = lambda name: _matches(name, kind) |
---|
89 | selected = [name for name in available_models if condition(name)] |
---|
90 | |
---|
91 | return selected |
---|
92 | |
---|
93 | def _matches(name, kind): |
---|
94 | if kind is None or kind == "all": |
---|
95 | return True |
---|
96 | info = load_model_info(name) |
---|
97 | pars = info.parameters.kernel_parameters |
---|
98 | # TODO: may be adding Fq to the list at some point |
---|
99 | is_pure_py = callable(info.Iq) |
---|
100 | if kind == "py": |
---|
101 | return is_pure_py |
---|
102 | elif kind == "c": |
---|
103 | return not is_pure_py |
---|
104 | elif kind == "double": |
---|
105 | return not info.single and not is_pure_py |
---|
106 | elif kind == "single": |
---|
107 | return info.single and not is_pure_py |
---|
108 | elif kind == "opencl": |
---|
109 | return info.opencl |
---|
110 | elif kind == "dll": |
---|
111 | return not info.opencl and not is_pure_py |
---|
112 | elif kind == "2d": |
---|
113 | return any(p.type == 'orientation' for p in pars) |
---|
114 | elif kind == "1d": |
---|
115 | return all(p.type != 'orientation' for p in pars) |
---|
116 | elif kind == "magnetic": |
---|
117 | return any(p.type == 'sld' for p in pars) |
---|
118 | elif kind == "nonmagnetic": |
---|
119 | return not any(p.type == 'sld' for p in pars) |
---|
120 | return False |
---|
121 | |
---|
122 | def load_model(model_name, dtype=None, platform='ocl'): |
---|
123 | # type: (str, str, str) -> KernelModel |
---|
124 | """ |
---|
125 | Load model info and build model. |
---|
126 | |
---|
127 | *model_name* is the name of the model, or perhaps a model expression |
---|
128 | such as sphere*hardsphere or sphere+cylinder. |
---|
129 | |
---|
130 | *dtype* and *platform* are given by :func:`build_model`. |
---|
131 | """ |
---|
132 | return build_model(load_model_info(model_name), |
---|
133 | dtype=dtype, platform=platform) |
---|
134 | |
---|
135 | def load_model_info(model_string): |
---|
136 | # type: (str) -> modelinfo.ModelInfo |
---|
137 | """ |
---|
138 | Load a model definition given the model name. |
---|
139 | |
---|
140 | *model_string* is the name of the model, or perhaps a model expression |
---|
141 | such as sphere*cylinder or sphere+cylinder. Use '@' for a structure |
---|
142 | factor product, e.g. sphere@hardsphere. Custom models can be specified by |
---|
143 | prefixing the model name with 'custom.', e.g. 'custom.MyModel+sphere'. |
---|
144 | |
---|
145 | This returns a handle to the module defining the model. This can be |
---|
146 | used with functions in generate to build the docs or extract model info. |
---|
147 | """ |
---|
148 | if "+" in model_string: |
---|
149 | parts = [load_model_info(part) |
---|
150 | for part in model_string.split("+")] |
---|
151 | return mixture.make_mixture_info(parts, operation='+') |
---|
152 | elif "*" in model_string: |
---|
153 | parts = [load_model_info(part) |
---|
154 | for part in model_string.split("*")] |
---|
155 | return mixture.make_mixture_info(parts, operation='*') |
---|
156 | elif "@" in model_string: |
---|
157 | p_info, q_info = [load_model_info(part) |
---|
158 | for part in model_string.split("@")] |
---|
159 | return product.make_product_info(p_info, q_info) |
---|
160 | # We are now dealing with a pure model |
---|
161 | elif "custom." in model_string: |
---|
162 | pattern = "custom.([A-Za-z0-9_-]+)" |
---|
163 | result = re.match(pattern, model_string) |
---|
164 | if result is None: |
---|
165 | raise ValueError("Model name in invalid format: " + model_string) |
---|
166 | model_name = result.group(1) |
---|
167 | # Use ModelName to find the path to the custom model file |
---|
168 | model_path = joinpath(CUSTOM_MODEL_PATH, model_name + ".py") |
---|
169 | if not os.path.isfile(model_path): |
---|
170 | raise ValueError("The model file {} doesn't exist".format(model_path)) |
---|
171 | kernel_module = custom.load_custom_kernel_module(model_path) |
---|
172 | return modelinfo.make_model_info(kernel_module) |
---|
173 | kernel_module = generate.load_kernel_module(model_string) |
---|
174 | return modelinfo.make_model_info(kernel_module) |
---|
175 | |
---|
176 | |
---|
177 | def build_model(model_info, dtype=None, platform="ocl"): |
---|
178 | # type: (modelinfo.ModelInfo, str, str) -> KernelModel |
---|
179 | """ |
---|
180 | Prepare the model for the default execution platform. |
---|
181 | |
---|
182 | This will return an OpenCL model, a DLL model or a python model depending |
---|
183 | on the model and the computing platform. |
---|
184 | |
---|
185 | *model_info* is the model definition structure returned from |
---|
186 | :func:`load_model_info`. |
---|
187 | |
---|
188 | *dtype* indicates whether the model should use single or double precision |
---|
189 | for the calculation. Choices are 'single', 'double', 'quad', 'half', |
---|
190 | or 'fast'. If *dtype* ends with '!', then force the use of the DLL rather |
---|
191 | than OpenCL for the calculation. |
---|
192 | |
---|
193 | *platform* should be "dll" to force the dll to be used for C models, |
---|
194 | otherwise it uses the default "ocl". |
---|
195 | """ |
---|
196 | composition = model_info.composition |
---|
197 | if composition is not None: |
---|
198 | composition_type, parts = composition |
---|
199 | models = [build_model(p, dtype=dtype, platform=platform) for p in parts] |
---|
200 | if composition_type == 'mixture': |
---|
201 | return mixture.MixtureModel(model_info, models) |
---|
202 | elif composition_type == 'product': |
---|
203 | P, S = models |
---|
204 | return product.ProductModel(model_info, P, S) |
---|
205 | else: |
---|
206 | raise ValueError('unknown mixture type %s'%composition_type) |
---|
207 | |
---|
208 | # If it is a python model, return it immediately |
---|
209 | if callable(model_info.Iq): |
---|
210 | return kernelpy.PyModel(model_info) |
---|
211 | |
---|
212 | numpy_dtype, fast, platform = parse_dtype(model_info, dtype, platform) |
---|
213 | source = generate.make_source(model_info) |
---|
214 | if platform == "dll": |
---|
215 | #print("building dll", numpy_dtype) |
---|
216 | return kerneldll.load_dll(source['dll'], model_info, numpy_dtype) |
---|
217 | elif platform == "cuda": |
---|
218 | return kernelcuda.GpuModel(source, model_info, numpy_dtype, fast=fast) |
---|
219 | else: |
---|
220 | #print("building ocl", numpy_dtype) |
---|
221 | return kernelcl.GpuModel(source, model_info, numpy_dtype, fast=fast) |
---|
222 | |
---|
223 | def precompile_dlls(path, dtype="double"): |
---|
224 | # type: (str, str) -> List[str] |
---|
225 | """ |
---|
226 | Precompile the dlls for all builtin models, returning a list of dll paths. |
---|
227 | |
---|
228 | *path* is the directory in which to save the dlls. It will be created if |
---|
229 | it does not already exist. |
---|
230 | |
---|
231 | This can be used when build the windows distribution of sasmodels |
---|
232 | which may be missing the OpenCL driver and the dll compiler. |
---|
233 | """ |
---|
234 | numpy_dtype = np.dtype(dtype) |
---|
235 | if not os.path.exists(path): |
---|
236 | os.makedirs(path) |
---|
237 | compiled_dlls = [] |
---|
238 | for model_name in list_models(): |
---|
239 | model_info = load_model_info(model_name) |
---|
240 | if not callable(model_info.Iq): |
---|
241 | source = generate.make_source(model_info)['dll'] |
---|
242 | old_path = kerneldll.SAS_DLL_PATH |
---|
243 | try: |
---|
244 | kerneldll.SAS_DLL_PATH = path |
---|
245 | dll = kerneldll.make_dll(source, model_info, dtype=numpy_dtype) |
---|
246 | finally: |
---|
247 | kerneldll.SAS_DLL_PATH = old_path |
---|
248 | compiled_dlls.append(dll) |
---|
249 | return compiled_dlls |
---|
250 | |
---|
251 | def parse_dtype(model_info, dtype=None, platform=None): |
---|
252 | # type: (ModelInfo, str, str) -> (np.dtype, bool, str) |
---|
253 | """ |
---|
254 | Interpret dtype string, returning np.dtype, fast flag and platform. |
---|
255 | |
---|
256 | Possible types include 'half', 'single', 'double' and 'quad'. If the |
---|
257 | type is 'fast', then this is equivalent to dtype 'single' but using |
---|
258 | fast native functions rather than those with the precision level |
---|
259 | guaranteed by the OpenCL standard. 'default' will choose the appropriate |
---|
260 | default for the model and platform. |
---|
261 | |
---|
262 | Platform preference can be specfied ("ocl", "cuda", "dll"), with the |
---|
263 | default being OpenCL or CUDA if available, otherwise DLL. If the dtype |
---|
264 | name ends with '!' then platform is forced to be DLL rather than GPU. |
---|
265 | The default platform is set by the environment variable SAS_OPENCL, |
---|
266 | SAS_OPENCL=driver:device for OpenCL, SAS_OPENCL=cuda:device for CUDA |
---|
267 | or SAS_OPENCL=none for DLL. |
---|
268 | |
---|
269 | This routine ignores the preferences within the model definition. This |
---|
270 | is by design. It allows us to test models in single precision even when |
---|
271 | we have flagged them as requiring double precision so we can easily check |
---|
272 | the performance on different platforms without having to change the model |
---|
273 | definition. |
---|
274 | """ |
---|
275 | # Assign default platform, overriding ocl with dll if OpenCL is unavailable |
---|
276 | # If opencl=False OpenCL is switched off |
---|
277 | if platform is None: |
---|
278 | platform = "ocl" |
---|
279 | |
---|
280 | # Check if type indicates dll regardless of which platform is given |
---|
281 | if dtype is not None and dtype.endswith('!'): |
---|
282 | platform = "dll" |
---|
283 | dtype = dtype[:-1] |
---|
284 | |
---|
285 | # Make sure model allows opencl/gpu |
---|
286 | if not model_info.opencl: |
---|
287 | platform = "dll" |
---|
288 | |
---|
289 | # Make sure opencl is available, or fallback to cuda then to dll |
---|
290 | if platform == "ocl" and not kernelcl.use_opencl(): |
---|
291 | platform = "cuda" if kernelcuda.use_cuda() else "dll" |
---|
292 | |
---|
293 | # Convert special type names "half", "fast", and "quad" |
---|
294 | fast = (dtype == "fast") |
---|
295 | if fast: |
---|
296 | dtype = "single" |
---|
297 | elif dtype == "quad": |
---|
298 | dtype = "longdouble" |
---|
299 | elif dtype == "half": |
---|
300 | dtype = "float16" |
---|
301 | |
---|
302 | # Convert dtype string to numpy dtype. Use single precision for GPU |
---|
303 | # if model allows it, otherwise use double precision. |
---|
304 | if dtype is None or dtype == "default": |
---|
305 | numpy_dtype = (generate.F32 if model_info.single and platform in ("ocl", "cuda") |
---|
306 | else generate.F64) |
---|
307 | else: |
---|
308 | numpy_dtype = np.dtype(dtype) |
---|
309 | |
---|
310 | # Make sure that the type is supported by GPU, otherwise use dll |
---|
311 | if platform == "ocl": |
---|
312 | env = kernelcl.environment() |
---|
313 | elif platform == "cuda": |
---|
314 | env = kernelcuda.environment() |
---|
315 | else: |
---|
316 | env = None |
---|
317 | if env is not None and not env.has_type(numpy_dtype): |
---|
318 | platform = "dll" |
---|
319 | if dtype is None: |
---|
320 | numpy_dtype = generate.F64 |
---|
321 | |
---|
322 | return numpy_dtype, fast, platform |
---|
323 | |
---|
324 | def test_composite_order(): |
---|
325 | """ |
---|
326 | Check that mixture models produce the same result independent of ordder. |
---|
327 | """ |
---|
328 | def test_models(fst, snd): |
---|
329 | """Confirm that two models produce the same parameters""" |
---|
330 | fst = load_model(fst) |
---|
331 | snd = load_model(snd) |
---|
332 | # Un-disambiguate parameter names so that we can check if the same |
---|
333 | # parameters are in a pair of composite models. Since each parameter in |
---|
334 | # the mixture model is tagged as e.g., A_sld, we ought to use a |
---|
335 | # regex subsitution s/^[A-Z]+_/_/, but removing all uppercase letters |
---|
336 | # is good enough. |
---|
337 | fst = [[x for x in p.name if x == x.lower()] for p in fst.info.parameters.kernel_parameters] |
---|
338 | snd = [[x for x in p.name if x == x.lower()] for p in snd.info.parameters.kernel_parameters] |
---|
339 | assert sorted(fst) == sorted(snd), "{} != {}".format(fst, snd) |
---|
340 | |
---|
341 | def build_test(first, second): |
---|
342 | """Construct pair model test""" |
---|
343 | test = lambda description: test_models(first, second) |
---|
344 | description = first + " vs. " + second |
---|
345 | return test, description |
---|
346 | |
---|
347 | yield build_test( |
---|
348 | "cylinder+sphere", |
---|
349 | "sphere+cylinder") |
---|
350 | yield build_test( |
---|
351 | "cylinder*sphere", |
---|
352 | "sphere*cylinder") |
---|
353 | yield build_test( |
---|
354 | "cylinder@hardsphere*sphere", |
---|
355 | "sphere*cylinder@hardsphere") |
---|
356 | yield build_test( |
---|
357 | "barbell+sphere*cylinder@hardsphere", |
---|
358 | "sphere*cylinder@hardsphere+barbell") |
---|
359 | yield build_test( |
---|
360 | "barbell+cylinder@hardsphere*sphere", |
---|
361 | "cylinder@hardsphere*sphere+barbell") |
---|
362 | yield build_test( |
---|
363 | "barbell+sphere*cylinder@hardsphere", |
---|
364 | "barbell+cylinder@hardsphere*sphere") |
---|
365 | yield build_test( |
---|
366 | "sphere*cylinder@hardsphere+barbell", |
---|
367 | "cylinder@hardsphere*sphere+barbell") |
---|
368 | yield build_test( |
---|
369 | "barbell+sphere*cylinder@hardsphere", |
---|
370 | "cylinder@hardsphere*sphere+barbell") |
---|
371 | yield build_test( |
---|
372 | "barbell+cylinder@hardsphere*sphere", |
---|
373 | "sphere*cylinder@hardsphere+barbell") |
---|
374 | |
---|
375 | def test_composite(): |
---|
376 | # type: () -> None |
---|
377 | """Check that model load works""" |
---|
378 | #Test the the model produces the parameters that we would expect |
---|
379 | model = load_model("cylinder@hardsphere*sphere") |
---|
380 | actual = [p.name for p in model.info.parameters.kernel_parameters] |
---|
381 | target = ("sld sld_solvent radius length theta phi" |
---|
382 | " radius_effective volfraction " |
---|
383 | " structure_factor_type effective_radius_type" |
---|
384 | " A_sld A_sld_solvent A_radius").split() |
---|
385 | assert target == actual, "%s != %s"%(target, actual) |
---|
386 | |
---|
387 | def list_models_main(): |
---|
388 | # type: () -> int |
---|
389 | """ |
---|
390 | Run list_models as a main program. See :func:`list_models` for the |
---|
391 | kinds of models that can be requested on the command line. |
---|
392 | """ |
---|
393 | import sys |
---|
394 | kind = sys.argv[1] if len(sys.argv) > 1 else "all" |
---|
395 | try: |
---|
396 | models = list_models(kind) |
---|
397 | print("\n".join(models)) |
---|
398 | except Exception: |
---|
399 | print(list_models.__doc__) |
---|
400 | return 1 |
---|
401 | return 0 |
---|
402 | |
---|
403 | if __name__ == "__main__": |
---|
404 | list_models_main() |
---|