Merge pull request #168 from fastlabel/feature/dataset-name-to-slug

feat: dataset slug to name

Author: Jiei-S

README.md

@@ -2392,8 +2392,7 @@ Create a new dataset.
 
 ```python
 dataset = client.create_dataset(
-    name="Japanese Dogs",
-    slug="japanese-dogs",
+    name="object-detection", # Only lowercase alphanumeric characters + hyphen is available
     type="image"
 )
 ```
@@ -2405,8 +2404,7 @@ See API docs for details.
 ```python
 {
     'id': 'YOUR_DATASET_ID',
-    'name': 'Japanese Dogs',
-    'slug': 'japanese-dogs',
+    'name': 'object-detection',
     'type': 'image',
     'createdAt': '2022-10-31T02:20:00.248Z',
     'updatedAt': '2022-10-31T02:20:00.248Z'
@@ -2450,7 +2448,7 @@ Update a single dataset.
 
 ```python
 dataset = client.update_dataset(
-    dataset_id="YOUR_DATASET_ID", name="World dogs"
+    dataset_id="YOUR_DATASET_ID", name="object-detection"
 )
 ```
 
@@ -2630,7 +2628,6 @@ See API docs for details.
     {
         'datasetId': 'YOUR_DATASET_ID',
         'datasetName': 'YOUR_DATASET_NAME',
-        'datasetSlug': 'YOUR_DATASET_SLUG',
         'datasetVersionId': 'YOUR_DATASET_VERSION_ID',
         'datasetVersionName': 'YOUR_DATASET_VERSION_NAME',
         'downloadCount': 1,

examples/create_dataset.py

@@ -4,7 +4,5 @@
 
 client = fastlabel.Client()
 
-dataset = client.create_dataset(
-    name="Japanese Dogs", slug="japanese-dogs", type="image"
-)
+dataset = client.create_dataset(name="object-detection", type="image")
 pprint(dataset)

examples/update_dataset.py

@@ -4,5 +4,5 @@
 
 client = fastlabel.Client()
 
-dataset = client.update_dataset(dataset_id="YOUR_DATASET_ID", name="New Name")
+dataset = client.update_dataset(dataset_id="YOUR_DATASET_ID", name="object-detection")
 pprint(dataset)

fastlabel/__init__.py

@@ -3866,20 +3866,17 @@ def create_dataset(
         self,
         type: str,
         name: str,
-        slug: str,
     ) -> dict:
         """
         Create a dataset.
 
         type can be 'image', 'video', 'audio' (Required).
-        name is name of your dataset (Required).
-        slug is slug of your dataset (Required).
+        name is name of your dataset. Only lowercase alphanumeric characters + hyphen is available (Required).
         """
         endpoint = "datasets"
         payload = {
             "type": type,
             "name": name,
-            "slug": slug,
         }
         return self.api.post_request(endpoint, payload=payload)