Skip to content

Commit b8b10e2

Browse files
Completes UNB-2629 - State that values in the label_column_name need to be zero-indexed in the API reference
1 parent 2c410da commit b8b10e2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

unboxapi/__init__.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,9 @@ def add_dataset(
766766
E.g. `[negative, positive]` when `[0, 1]` are in your label column.
767767
label_column_name : str
768768
Column header in the csv containing the labels.
769+
770+
.. important::
771+
The labels in this column must be zero-indexed integer values.
769772
feature_names : List[str], default []
770773
List of input feature names. Only applicable if your ``task_type`` is
771774
:obj:`TaskType.TabularClassification` or :obj:`TaskType.TabularRegression`.
@@ -1056,12 +1059,15 @@ def add_dataframe(
10561059
List of class names indexed by label integer in the dataset.
10571060
E.g. `[negative, positive]` when `[0, 1]` are in your label column.
10581061
label_column_name : str
1059-
Column header in the csv containing the labels.
1062+
Column header in the dataframe containing the labels.
1063+
1064+
.. important::
1065+
The labels in this column must be zero-indexed integer values.
10601066
feature_names : List[str], default []
10611067
List of input feature names. Only applicable if your ``task_type`` is
10621068
:obj:`TaskType.TabularClassification` or :obj:`TaskType.TabularRegression`.
10631069
text_column_name : str, default None
1064-
Column header in the csv containing the input text. Only applicable if your
1070+
Column header in the dataframe containing the input text. Only applicable if your
10651071
``task_type`` is :obj:`TaskType.TextClassification`.
10661072
categorical_feature_names : List[str], default []
10671073
A list containing the names of all categorical features in the dataframe.
@@ -1070,7 +1076,7 @@ def add_dataframe(
10701076
commit_message : str, default None
10711077
Commit message for this version.
10721078
tag_column_name : str, default None
1073-
Column header in the csv containing tags you want pre-populated in Unbox.
1079+
Column header in the dataframe containing tags you want pre-populated in Unbox.
10741080
10751081
.. important::
10761082
Each cell in this column must be either empty or contain a list of

0 commit comments

Comments
 (0)