docs: Add notes about old version in examples (#323)

Co-authored-by: caitlinwheeless <[email protected]>

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",

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"
 

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": {

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

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": [],

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")

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

examples/import_preannotations/import_brush_predictions.py

@@ -1,9 +1,16 @@
+"""
+**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.
+"""
+
 # Create a new project with several tasks and brush preannotations
 # Contributed by https://github.com/berombau:
 # https://github.com/heartexlabs/label-studio-sdk/issues/19#issuecomment-992327281
 
 import numpy as np
-import label_studio_converter.brush as brush
+
+import label_studio_sdk.converter.brush as brush
 from label_studio_sdk import Client
 
 LABEL_STUDIO_URL = "http://localhost:8080"

examples/import_preannotations/import_preannotations.py

@@ -1,11 +1,18 @@
+"""
+**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 tasks with pre-annotations (predictions) using SDK,
 # then calculate agreement scores (accuracy) per tasks.
 
+import pandas as pd
 from evalme.metrics import (
     get_agreement,
 )  # run first `pip install label-studio-evalme` to use this package
+
 from label_studio_sdk import Client
-import pandas as pd
 
 LABEL_STUDIO_URL = "http://localhost:8080"
 API_KEY = "91b3b61589784ed069b138eae3d5a5fe1e909f57"

examples/label_studio_enterprise/assign_10_percent_of_tasks.py

@@ -1,6 +1,10 @@
 """
 This script is meant to automatically tag tasks within a project using a random distribution and
 then assign those that receive a specific tag to a reviewer for further reviewing.
+
+**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

examples/label_studio_enterprise/assigner.py

@@ -1,6 +1,10 @@
 """ This script runs every 10 seconds and assigns users to a new batch of tasks filtered by the specified column.
 
-Notes:
+**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.
+
+Advanced notes:
     1. Don't forget to enable Manual mode in Annotation settings
     2. Be careful when adding email users: users who are not members of the project or workspace will break Data Manager
 
@@ -13,10 +17,11 @@
 Demo video:
     https://www.youtube.com/watch?v=IeqrsCYYQ8k
 """
-import time
+
 import math
-import label_studio_sdk
+import time
 
+import label_studio_sdk
 from label_studio_sdk.data_manager import Filters, Column, Operator, Type
 
 

examples/label_studio_enterprise/assignment.ipynb

@@ -7,6 +7,15 @@
     "This tutorial describes the basics of assigning users to projects, workspaces, and specific tasks in Label Studio Enterprise using the Python SDK."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "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."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -125,7 +134,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from label_studio_sdk.users import UserRole\n",
+    "from label_studio_sdk._legacy.users import UserRole\n",
     "\n",
     "user.set_role(UserRole.REVIEWER)\n",
     "print(user)"

examples/label_studio_enterprise/user_management.ipynb

@@ -4,7 +4,11 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This tutorial describes the basics of managing users in Label Studio Enterprise using the Python SDK."
+    "This tutorial describes the basics of managing users in Label Studio Enterprise using the Python SDK.\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."
    ]
   },
   {
@@ -77,7 +81,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from label_studio_sdk.users import UserRole\n",
+    "from label_studio_sdk._legacy.users import UserRole\n",
     "\n",
     "user.set_role(UserRole.ANNOTATOR)"
    ]

examples/migrate_ls_to_ls/README.md

@@ -22,12 +22,16 @@ Each new run of this script will generate new projects on the destination instan
 
 **Note:** Create a new workspace and get its ID for projects to be mgiratated. 
 
-**SDK v0.0.34**
+**SDK v1.0 or higher**
 
 ```
-pip install label-studio-sdk==0.0.34
+pip install -U label-studio-sdk
 ```
 
+**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.
+
 # How it works? 
 
 1. Get all projects from source LS (or specific projects)

examples/migrate_ls_to_ls/migrate-ls-to-ls.py

@@ -3,6 +3,10 @@
 
 Usage:
 > python3 migrate-ls-to-ls.py --src-url src-ls.com --src-key <src-token> --dst-url dst-ls.com --dst-key <dst-token> --project-ids=123,456
+
+**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 json
@@ -11,8 +15,8 @@
 import time
 
 from label_studio_sdk import Client
+from label_studio_sdk._legacy.users import User
 from label_studio_sdk.data_manager import Filters, Operator, Type, Column
-from label_studio_sdk.users import User
 
 logger = logging.getLogger("migration-ls-to-ls")
 logger.setLevel(logging.DEBUG)

examples/weak_supervision/weak_supervision.ipynb

@@ -13,7 +13,11 @@
    "source": [
     "Perform weak supervision with Label Studio, using noisy labels on a large amount of training data to automatically build a useful training dataset for your supervised learning model. \n",
     "\n",
-    "In this example, use the [Label Studio SDK](https://labelstud.io/sdk/index.html) to write a Python script that adds noisy labels to tasks, then adds those tasks to Label Studio for review and correction in a supervised learning setting. "
+    "In this example, use the [Label Studio SDK](https://labelstud.io/sdk/index.html) to write a Python script that adds noisy labels to tasks, then adds those tasks to Label Studio for review and correction in a supervised learning setting.\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."
    ]
   },
   {

examples/weak_supervision/weak_supervision.py

@@ -1,9 +1,16 @@
+"""
+**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
 import re
 
-from label_studio_sdk import Client
 import pandas as pd
 
+from label_studio_sdk import Client
+
 ls = Client(
     url="http://localhost:8080", api_key="d6f8a2622d39e9d89ff0dfef1a80ad877f4ee9e3"
 )