Skip to content

Commit af33c6f

Browse files
committed
feat: update docstring
1 parent ae27c04 commit af33c6f

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

autointent/modules/embedding/_retrieval.py

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@ class LogRegEmbedding(EmbeddingModule):
3636
3737
Examples
3838
--------
39-
.. testsetup::
40-
41-
db_dir = "doctests-db"
42-
4339
.. testcode::
4440
4541
from autointent.modules.embedding import LogRegEmbedding
@@ -48,15 +44,8 @@ class LogRegEmbedding(EmbeddingModule):
4844
retrieval = LogRegEmbedding(
4945
k=3,
5046
embedder_name="sergeyzh/rubert-tiny-turbo",
51-
db_dir=db_dir,
5247
)
5348
retrieval.fit(utterances, labels)
54-
55-
.. testcleanup::
56-
57-
import shutil
58-
shutil.rmtree(db_dir)
59-
6049
"""
6150

6251
classifier: LogisticRegressionCV
@@ -76,7 +65,7 @@ def __init__(
7665
"""
7766
Initialize the LogRegEmbedding.
7867
79-
:param cv:
68+
:param cv: the number of folds used in LogisticRegressionCV
8069
:param k: Number of nearest neighbors to retrieve.
8170
:param embedder_name: Name of the embedder used for creating embeddings.
8271
:param embedder_device: Device to run operations on, e.g., "cpu" or "cuda".
@@ -104,7 +93,7 @@ def from_context(
10493
"""
10594
Create a LogRegEmbedding instance using a Context object.
10695
107-
:param cv:
96+
:param cv: the number of folds used in LogisticRegressionCV
10897
:param context: The context containing configurations and utilities.
10998
:param k: Number of nearest neighbors to retrieve.
11099
:param embedder_name: Name of the embedder to use.

0 commit comments

Comments
 (0)