Skip to content

Commit

Permalink
update code documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ddangelov committed Oct 15, 2020
1 parent 4dc19fb commit 879e02c
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions top2vec/Top2Vec.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ class Top2Vec:
the universal sentence encoder options. For more information visit:
https://www.sbert.net/docs/pretrained_models.html
embedding_model_path: string (Optional)
Pre-trained embedding models will be downloaded automatically by default. However
they can also be uploaded from a file that is in the location of embedding_model_path.
Warning: the model at embedding_model_path must match the embedding_model parameter
type.
documents: List of str
Input corpus, should be a list of strings.
Expand Down Expand Up @@ -766,8 +773,10 @@ def _validate_documents(documents):
def update_embedding_model_path(self, embedding_model_path):
"""
Update the path of the embedding model to be loaded. The model will no longer
be downloaded but loaded from the path location. This must match the embedding model
use to train the model.
be downloaded but loaded from the path location.
Warning: the model at embedding_model_path must match the embedding_model parameter
type.
Parameters
----------
Expand Down

0 comments on commit 879e02c

Please sign in to comment.