HumanSignal · makseq · Dec 30, 2024
diff --git a/examples/README.md b/examples/README.md
@@ -23,6 +23,7 @@ If your data is hosted in Google Cloud Storage (GCS), you can write a Python scr
   * Create a snapshot
   * Check the snapshot status
   * Download the snapshot
+ * [Export YOLO with images](https://github.com/HumanSignal/label-studio-sdk/blob/master/examples/export_yolo_with_images.py) - This script exports labeled data from a Label Studio project and converts it into the YOLO format, including downloading associated images.
 
 
 ## Machine Learning

diff --git a/examples/active_learning/active_learning.ipynb b/examples/active_learning/active_learning.ipynb
@@ -11,6 +11,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "**Note:** This code utilizes functions from an older version of the Label Studio SDK (v0.0.34). While the newer versions v1.0 and above still support the functionalities of the old version (see `label_studio_sdk._legacy` for reference), we recommend using the latest Label Studio SDK v1.0 or higher.\n",
+    "\n",
     "Active learning is a branch of machine learning that seeks to minimize the total amount of data required for labeling by strategically sampling data that provides insight into the problem you're trying to solve so that you can focus on labeling that data.\n",
     "\n",
     "Follow this example to write a Python script using the [Label Studio SDK](https://labelstud.io/sdk/index.html) that performs active learning with a text classification machine learning model. "
@@ -88,7 +90,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from label_studio_sdk.project import ProjectSampling\n",
+    "from label_studio_sdk._legacy.project import ProjectSampling\n",
     "\n",
     "project = ls.start_project(\n",
     "    title='AL Project Created from SDK - DEMO',\n",

diff --git a/examples/active_learning/active_learning.py b/examples/active_learning/active_learning.py
@@ -1,12 +1,19 @@
+"""
+**Note:** This code utilizes functions from an older version of the Label Studio SDK (v0.0.34). 
+The newer versions v1.0 and above still support the functionalities of the old version, but you will need to specify
+[`label_studio_sdk._legacy`](../../README.md) in your script.
+"""
+
 import random
 
-from label_studio_sdk import Client
-from label_studio_sdk.project import ProjectSampling
 import numpy as np
 from sklearn.feature_extraction.text import TfidfVectorizer
 from sklearn.linear_model import LogisticRegression
 from sklearn.pipeline import make_pipeline
 
+from label_studio_sdk import Client
+from label_studio_sdk._legacy.project import ProjectSampling
+
 LABEL_STUDIO_URL = "http://localhost:8080"
 API_KEY = "91b3b61589784ed069b138eae3d5a5fe1e909f57"
 

diff --git a/examples/adding_new_labels_to_project.ipynb b/examples/adding_new_labels_to_project.ipynb
@@ -7,7 +7,11 @@
    "source": [
     "This tutorial demonstrates how to add new labels to an ongoing project in real-time. The included example showcases the use of the `<Taxonomy>` tag, which can be applied to the entire document. However, this same principle can also be used for other cases, such as \n",
     "- modifying labels for computer vision applications (bounding boxes, polygons, etc.), or segments in text and audio using nested `<Taxonomy>` tags. \n",
-    "- modify other tags that contain lists of labels, such as `<Choices>` and `<Labels>`."
+    "- modify other tags that contain lists of labels, such as `<Choices>` and `<Labels>`.\n",
+    "\n",
+    "**Note:** This code utilizes functions from an older version of the Label Studio SDK (v0.0.34).\n",
+    "The newer versions v1.0 and above still support the functionalities of the old version, but you will need to specify\n",
+    "[`label_studio_sdk._legacy`](../README.md) in your script."
    ]
   },
   {
@@ -222,7 +226,8 @@
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "id": "641c8dd06b76348c"
   },
   {
    "cell_type": "code",
@@ -237,7 +242,8 @@
     "pycharm": {
      "name": "#%%\n"
     }
-   }
+   },
+   "id": "fa55edf2c553b707"
   }
  ],
  "metadata": {

diff --git a/examples/annotate_data_from_gcs/annotate_data_from_gcs.ipynb b/examples/annotate_data_from_gcs/annotate_data_from_gcs.ipynb
@@ -20,7 +20,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Connect to your GCS bucket"
+    "## Get your GCS bucket ready"
    ]
   },
   {
@@ -30,33 +30,20 @@
     "Connect to your GCS bucket and create a list of task references that Label Studio can use, based on the contents of your bucket. "
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install --upgrade google-api-python-client"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
     "import os\n",
-    "from google.cloud import storage as google_storage\n",
-    "\n",
-    "BUCKET_NAME = 'my-bucket'  # specify your bucket name here\n",
-    "GOOGLE_APPLICATION_CREDENTIALS = 'my-service-account-credentials.json'  # specify your GCS credentials\n",
-    "os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = GOOGLE_APPLICATION_CREDENTIALS\n",
     "\n",
-    "google_client = google_storage.Client()\n",
-    "bucket = google_client.get_bucket(BUCKET_NAME)\n",
-    "tasks = []\n",
-    "for filename in bucket.list_blobs():\n",
-    "    tasks.append({'image': f'gs://{BUCKET_NAME}/{filename}'})"
+    "BUCKET_NAME = 'your-bucket'  # specify your bucket name here\n",
+    "PREFIX = 'bucket/subfolder'  # specify your prefix here\n",
+    "# assuming you service account key is stored in GOOGLE_APPLICATION_CREDENTIALS\n",
+    "GOOGLE_APPLICATION_CREDENTIALS_FILE = os.getenv('GOOGLE_APPLICATION_CREDENTIALS') \n",
+    "with open(GOOGLE_APPLICATION_CREDENTIALS_FILE) as f:\n",
+    "    credentials = f.read()"
    ]
   },
   {
@@ -79,12 +66,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from label_studio_sdk import Client\n",
-    "LABEL_STUDIO_URL = 'http://localhost:8000'\n",
-    "API_KEY = '91b3b61589784ed069b138eae3d5a5fe1e909f57'\n",
+    "from label_studio_sdk.client import LabelStudio\n",
+    "LABEL_STUDIO_URL = 'http://localhost:8080'\n",
+    "API_KEY = '27c982caa9e599c9d81b25b00663e7d4f82c9e3c'\n",
     "\n",
-    "ls = Client(url=LABEL_STUDIO_URL, api_key=API_KEY)\n",
-    "ls.check_connection()"
+    "ls = LabelStudio(base_url=LABEL_STUDIO_URL, api_key=API_KEY)"
    ]
   },
   {
@@ -100,14 +86,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project = ls.start_project(\n",
-    "    title='Image Annotation Project from SDK',\n",
+    "project = ls.projects.create(\n",
+    "    title='Using Images from GCS',\n",
     "    label_config='''\n",
     "    <View>\n",
     "        <Image name=\"image\" value=\"$image\"/>\n",
     "        <RectangleLabels name=\"objects\" toName=\"image\">\n",
-    "            <Choice value=\"Airplane\"/>\n",
-    "            <Choice value=\"Car\"/>\n",
+    "            <Label value=\"Airplane\"/>\n",
+    "            <Label value=\"Car\"/>\n",
     "        </RectangleLabels>\n",
     "    </View>\n",
     "    '''\n",
@@ -134,9 +120,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project.connect_google_import_storage(\n",
+    "storage = ls.import_storage.gcs.create(\n",
+    "    project=project.id,\n",
     "    bucket=BUCKET_NAME,\n",
-    "    google_application_credentials=GOOGLE_APPLICATION_CREDENTIALS\n",
+    "    prefix=PREFIX,\n",
+    "    regex_filter='.*\\.jpg',\n",
+    "    google_application_credentials=credentials,\n",
+    "    use_blob_urls=True,\n",
+    "    presign=True\n",
     ")"
    ]
   },
@@ -160,7 +151,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project.import_tasks(tasks)"
+    "ls.import_storage.gcs.sync(id=storage.id)"
    ]
   },
   {

diff --git a/examples/annotate_data_from_gcs/annotate_data_from_gcs.py b/examples/annotate_data_from_gcs/annotate_data_from_gcs.py
@@ -1,6 +1,13 @@
+"""
+Note: This code utilizes functions from an older version of the Label Studio SDK (v0.0.34).
+The newer versions v1.0 and above still support the functionalities of the old version, but you will need to specify
+[`label_studio_sdk._legacy`](../../README.md) in your script.
+"""
+
 import os
 
 from google.cloud import storage as google_storage
+
 from label_studio_sdk import Client
 
 BUCKET_NAME = "my-bucket"  # specify your bucket name here

diff --git a/examples/cloud_storages/cloud_storage_guide.ipynb b/examples/cloud_storages/cloud_storage_guide.ipynb
@@ -10,6 +10,16 @@
    },
    "id": "b0600d1650011dc6"
   },
+  {
+   "metadata": {},
+   "cell_type": "markdown",
+   "source": [
+    "**Note:** This code utilizes functions from an older version of the Label Studio SDK (v0.0.34).\n",
+    "The newer versions v1.0 and above still support the functionalities of the old version, but you will need to specify\n",
+    "[`label_studio_sdk._legacy`](../../README.md) in your script."
+   ],
+   "id": "57cd42b243a4ea45"
+  },
   {
    "cell_type": "code",
    "outputs": [],

diff --git a/examples/export_snapshots.py b/examples/export_snapshots.py
@@ -1,5 +1,12 @@
+"""
+**Note:** This code utilizes functions from an older version of the Label Studio SDK (v0.0.34). 
+The newer versions v1.0 and above still support the functionalities of the old version, but you will need to specify
+[`label_studio_sdk._legacy`](../README.md) in your script.
+"""
+
 import os
 import time
+
 from label_studio_sdk import Client
 
 LABEL_STUDIO_URL = os.getenv("LABEL_STUDIO_URL", default="http://localhost:8080")

diff --git a/examples/export_with_filters.py b/examples/export_with_filters.py
@@ -1,9 +1,13 @@
 """ Export a snapshot with tasks filtered by ID range.
 
-Note: at this moment it's not possible to export snapshots with filters,
+**Note:** at this moment it's not possible to export snapshots with filters,
 LS API doesn't support it yet. However, it's achievable by creating a view
 with a filter and then exporting a snapshot using this view.
 This approach is hidden behind the `project.export()` method.
+
+**Note:** This code utilizes functions from an older version of the Label Studio SDK (v0.0.34). 
+The newer versions v1.0 and above still support the functionalities of the old version, but you will need to specify
+[`label_studio_sdk._legacy`](../README.md) in your script.
 """
 
 from label_studio_sdk import Client