Move files

This commit is contained in:
Andras Schmelczer 2022-07-10 19:48:22 +02:00
parent b97b20ba88
commit c046d64a98
No known key found for this signature in database
GPG key ID: 0EA1BC97D0AB076E
16 changed files with 35 additions and 36 deletions

View file

@ -1,2 +0,0 @@
from .save_model import save_model
from .use_model import model_versions, use_model

View file

@ -19,7 +19,7 @@ def save_model(
>>> from great_ai import use_model
>>> save_model(3, 'my_number')
'my_number:...'
>>> @use_model('my_number')
... def my_function(a, model):
... return a + model

View file

@ -32,17 +32,13 @@ def use_model(
) -> Callable[[F], F]:
"""Inject a model into a function.
Load a model specified by `key` and `version` using the
currently active `LargeFile` implementation. If it's a
single object, it is deserialised using `dill`. If it's
a directory of files, a `pathlib.Path` instance is given.
Load a model specified by `key` and `version` using the currently active `LargeFile`
implementation. If it's a single object, it is deserialised using `dill`. If it's a
directory of files, a `pathlib.Path` instance is given.
By default, the function's `model` parameter is replaced
by the loaded model. This can be customised by changing
`model_kwarg_name`.
Multiple models can be loaded by decorating the same
function with `use_model` multiple times.
By default, the function's `model` parameter is replaced by the loaded model. This
can be customised by changing `model_kwarg_name`. Multiple models can be loaded by
decorating the same function with `use_model` multiple times.
Examples:
>>> from great_ai import save_model