From 92e3ef64b46f45ad573a011aa1561612b96ff8f2 Mon Sep 17 00:00:00 2001 From: Jonathan de Bruin Date: Mon, 8 May 2023 15:01:27 +0200 Subject: [PATCH] Deprecate LSGM helpers in asreview.__init__.py (#1433) --- asreview/__init__.py | 8 +++++--- asreview/_deprecated.py | 42 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 3 deletions(-) create mode 100644 asreview/_deprecated.py diff --git a/asreview/__init__.py b/asreview/__init__.py index bcededef4..e20c5d4c4 100644 --- a/asreview/__init__.py +++ b/asreview/__init__.py @@ -16,9 +16,6 @@ from asreview.data.base import load_data from asreview.io.utils import list_readers from asreview.io.utils import list_writers -from asreview.models.feature_extraction.embedding_lstm import load_embedding -from asreview.models.feature_extraction.embedding_lstm import sample_embedding -from asreview.models.feature_extraction.embedding_lstm import text_to_features from asreview.project import ASReviewProject from asreview.project import open_state from asreview.utils import asreview_path @@ -38,3 +35,8 @@ "list_writers", "open_state", ] + +# deprecated in __init__.py, use asreview.models.feature_extraction instead +from asreview._deprecated import load_embedding +from asreview._deprecated import sample_embedding +from asreview._deprecated import text_to_features diff --git a/asreview/_deprecated.py b/asreview/_deprecated.py new file mode 100644 index 000000000..dbda83a98 --- /dev/null +++ b/asreview/_deprecated.py @@ -0,0 +1,42 @@ +import functools +import warnings + +from asreview.models.feature_extraction.embedding_lstm import load_embedding as _load_embedding # NOQA +from asreview.models.feature_extraction.embedding_lstm import sample_embedding as _sample_embedding # NOQA +from asreview.models.feature_extraction.embedding_lstm import text_to_features as _text_to_features # NOQA + + +def _deprecated_func(msg): + def dec(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + warnings.warn(msg) + return func(*args, **kwargs) + + return wrapper + + return dec + + +@_deprecated_func( + "Importing load_embedding from asreview.load_embedding is deprecated, " + "use asreview.models.feature_extraction.load_embedding instead" +) +def load_embedding(*args, **kwargs): + return _load_embedding(*args, **kwargs) + + +@_deprecated_func( + "Importing sample_embedding from asreview.sample_embedding is deprecated, " + "use asreview.models.feature_extraction.sample_embedding instead" +) +def sample_embedding(*args, **kwargs): + return _sample_embedding(*args, **kwargs) + + +@_deprecated_func( + "Importing text_to_features from asreview.text_to_features is deprecated, " + "use asreview.models.feature_extraction.text_to_features instead" +) +def text_to_features(*args, **kwargs): + return _text_to_features(*args, **kwargs)