Skip to content

Commit 19d479c

Browse files
committed
Closes UNB-2166 by reverting back to using enums
1 parent 2484b69 commit 19d479c

File tree

5 files changed

+51
-660
lines changed

5 files changed

+51
-660
lines changed

docs/source/reference/upload.rst

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,13 @@ Upload functions
2323
UnboxClient.add_dataset
2424
UnboxClient.add_dataframe
2525

26-
Model types
27-
-----------
26+
Model / Task types
27+
------------------
2828
.. autosummary::
2929
:toctree: api/
30-
:template: class.rst
3130

3231
ModelType
33-
ModelType.fasttext
34-
ModelType.sklearn
35-
ModelType.pytorch
36-
ModelType.tensorflow
37-
ModelType.transformers
38-
ModelType.keras
39-
ModelType.rasa
40-
ModelType.custom
41-
42-
Task types
43-
-----------
44-
.. autosummary::
45-
:toctree: api/
46-
:template: class.rst
47-
4832
TaskType
49-
TaskType.TextClassification
50-
TaskType.TabularClassification
51-
TaskType.TabularRegression
5233

5334
Objects
5435
-------
@@ -57,6 +38,6 @@ Objects
5738
:template: class.rst
5839

5940
Model
60-
Model.to_dict
6141
Dataset
42+
Model.to_dict
6243
Dataset.to_dict

unboxapi/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def add_model(
7777
description: str = None,
7878
**kwargs,
7979
) -> Model:
80-
"""Uploads a model.
80+
"""Uploads a model to the Unbox platform.
8181
8282
Parameters
8383
----------
@@ -430,7 +430,7 @@ def add_dataset(
430430
sep: str = ",",
431431
description: Optional[str] = None,
432432
) -> Dataset:
433-
r"""Uploads a dataset from a csv.
433+
r"""Uploads a dataset to the Unbox platform (from a csv).
434434
435435
Parameters
436436
----------
@@ -627,7 +627,7 @@ def add_dataframe(
627627
tag_column_name: Optional[str] = None,
628628
language: str = "en",
629629
) -> Dataset:
630-
"""Uploads a dataset from a dataframe.
630+
r"""Uploads a dataset to the Unbox platform (from a pandas DataFrame).
631631
632632
Parameters
633633
----------

unboxapi/datasets.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
class Dataset:
2-
"""Dataset class."""
2+
"""An object containing information about a dataset on the Unbox platform."""
33

44
def __init__(self, json):
55
self._json = json
@@ -20,10 +20,10 @@ def __repr__(self):
2020
return f"Dataset({self._json})"
2121

2222
def to_dict(self):
23-
"""Returns object properties as a dict
23+
"""Returns object properties as a dict.
2424
2525
Returns
2626
-------
27-
Dict with object properties
27+
Dict with object properties.
2828
"""
2929
return self._json

0 commit comments

Comments
 (0)