Skip to content

Commit 0e0a37f

Browse files
gustavocidornelaswhoseoyster
authored andcommitted
Deprecated name and included dataset commit message
1 parent a556c08 commit 0e0a37f

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

unboxapi/__init__.py

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ def add_model(
447447
endpoint = f"projects/{project_id}/ml-models"
448448
payload = dict(
449449
name=name,
450-
project_id=project_id,
450+
projectId=project_id,
451451
description=description,
452452
classNames=class_names,
453453
architectureType=model_type.name,
@@ -468,7 +468,6 @@ def add_model(
468468

469469
def add_dataset(
470470
self,
471-
name: str,
472471
task_type: TaskType,
473472
file_path: str,
474473
class_names: List[str],
@@ -479,15 +478,13 @@ def add_dataset(
479478
tag_column_name: Optional[str] = None,
480479
language: str = "en",
481480
sep: str = ",",
482-
description: Optional[str] = None,
481+
commit_message: Optional[str] = None,
483482
project_id: str = None,
484483
) -> Dataset:
485484
r"""Uploads a dataset to the Unbox platform (from a csv).
486485
487486
Parameters
488487
----------
489-
name : str
490-
Name of your dataset.
491488
task_type : :obj:`TaskType`
492489
Type of ML task. E.g. :obj:`TaskType.TextClassification`.
493490
file_path : str
@@ -521,7 +518,7 @@ def add_dataset(
521518
The language of the dataset in ISO 639-1 (alpha-2 code) format.
522519
sep : str, default ','
523520
Delimiter to use. E.g. `'\\t'`.
524-
description : str, default None
521+
commit_message : str, default None
525522
Commit message for this version.
526523
527524
Returns
@@ -569,7 +566,6 @@ def add_dataset(
569566
You can now upload this dataset to Unbox:
570567
571568
>>> dataset = client.add_dataset(
572-
... name='Churn Validation',
573569
... task_type=task_type,
574570
... file_path='/path/to/dataset.csv',
575571
... class_names=class_names,
@@ -602,7 +598,6 @@ def add_dataset(
602598
You can now upload this dataset to Unbox:
603599
604600
>>> dataset = client.add_dataset(
605-
... name='Churn Validation',
606601
... task_type=task_type,
607602
... file_path='/path/to/dataset.csv',
608603
... class_names=class_names,
@@ -655,9 +650,8 @@ def add_dataset(
655650
)
656651
endpoint = f"projects/{project_id}/datasets"
657652
payload = dict(
658-
name=name,
659-
project_id=project_id,
660-
description=description,
653+
projectId=project_id,
654+
commitMessage=commit_message,
661655
taskType=task_type.value,
662656
classNames=class_names,
663657
labelColumnName=label_column_name,
@@ -678,15 +672,14 @@ def add_dataset(
678672

679673
def add_dataframe(
680674
self,
681-
name: str,
682675
task_type: TaskType,
683676
df: pd.DataFrame,
684677
class_names: List[str],
685678
label_column_name: str,
686679
feature_names: List[str] = [],
687680
text_column_name: Optional[str] = None,
688681
categorical_feature_names: List[str] = [],
689-
description: Optional[str] = None,
682+
commit_message: Optional[str] = None,
690683
tag_column_name: Optional[str] = None,
691684
language: str = "en",
692685
project_id: str = None,
@@ -695,8 +688,6 @@ def add_dataframe(
695688
696689
Parameters
697690
----------
698-
name : str
699-
Name of your dataset.
700691
task_type : :obj:`TaskType`
701692
Type of ML task. E.g. :obj:`TaskType.TextClassification`.
702693
df : pd.DataFrame
@@ -715,7 +706,7 @@ def add_dataframe(
715706
categorical_features_map : Dict[str, List[str]], default {}
716707
A dict containing a list of category names for each feature that is categorical. E.g. `{'Weather': ['Hot', 'Cold']}`.
717708
Only applicable if your ``task_type`` is :obj:`TaskType.TabularClassification` or :obj:`TaskType.TabularRegression`.
718-
description : str, default None
709+
commit_message : str, default None
719710
Commit message for this version.
720711
tag_column_name : str, default None
721712
Column header in the csv containing tags you want pre-populated in Unbox.
@@ -775,7 +766,6 @@ def add_dataframe(
775766
You can now upload this dataset to Unbox:
776767
777768
>>> dataset = client.add_dataset(
778-
... name='Churn Validation',
779769
... task_type=task_type,
780770
... df=df,
781771
... class_names=class_names,
@@ -807,7 +797,6 @@ def add_dataframe(
807797
You can now upload this dataset to Unbox:
808798
809799
>>> dataset = client.add_dataset(
810-
... name='Churn Validation',
811800
... task_type=task_type,
812801
... df=df,
813802
... class_names=class_names,
@@ -825,8 +814,7 @@ def add_dataframe(
825814
class_names=class_names,
826815
label_column_name=label_column_name,
827816
text_column_name=text_column_name,
828-
name=name,
829-
description=description,
817+
commit_message=commit_message,
830818
tag_column_name=tag_column_name,
831819
language=language,
832820
feature_names=feature_names,

0 commit comments

Comments
 (0)