Skip to content

Commit

Permalink
serve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
sergioburdisso committed Nov 11, 2019
1 parent 2938aa2 commit 5be2350
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion pyss3/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1480,7 +1480,7 @@ def classify(self, doc, prep=True, sort=True, json=False):
:type prep: bool
:param sort: sort the classification result (from best to worst)
:type sort: bool
:param json: return the result in json format
:param json: return the result in JSON format
:type json: bool
:returns: the document confidence vector if ``sort`` is False.
If ``sort`` is True, a list of pairs
Expand Down
11 changes: 5 additions & 6 deletions pyss3/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ def set_testset(x_test, y_test):
:param x_test: the list of documents to classify
:type x_test: list (of str)
:param y_label: the list of labels
:param y_label: the list of category labels
:type y_label: list (of str)
"""
Server.__clear_testset__()
Expand Down Expand Up @@ -390,11 +390,10 @@ def serve(
:param clf: the SS3 model to be attached to this server.
:type clf: pyss3.SS3
:param test_path: the test set path to visualize.
:type test_path: str
:param folder_label: if True, read category labels from folders,
otherwise, from file names. (default: True)
:type folder_label: bool
:param x_test: the list of documents to (preload and) classify
:type x_test: list (of str)
:param y_label: the list of category labels
:type y_label: list (of str)
:param port: the port to listen on (default: random free port)
:type port: int
:param browser: if True, it automatically opens up the live test on
Expand Down

0 comments on commit 5be2350

Please sign in to comment.