Skip to content

Commit

Permalink
Deprecate LSGM helpers in asreview.__init__.py (#1433)
Browse files Browse the repository at this point in the history
  • Loading branch information
J535D165 committed May 8, 2023
1 parent 1902980 commit 92e3ef6
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 3 deletions.
8 changes: 5 additions & 3 deletions asreview/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
42 changes: 42 additions & 0 deletions asreview/_deprecated.py
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 92e3ef6

Please sign in to comment.