Skip to content

Commit ee768e0

Browse files
docs: Added info about version 2.0 (#504)
1 parent 044727d commit ee768e0

File tree

1 file changed

+72
-24
lines changed

1 file changed

+72
-24
lines changed

README.md

Lines changed: 72 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,5 @@
11
# Label Studio Python Library
22

3-
<!-- Note about deprecated version <1 -->
4-
---
5-
> :warning: **Note**<br/>
6-
>
7-
> The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
8-
> If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
9-
> OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
10-
>
11-
> ```sh
12-
> git clone https://github.com/HumanSignal/label-studio-sdk.git
13-
> cd label-studio-sdk
14-
> git fetch origin
15-
> git checkout release/0.0.34
16-
> ```
17-
>
18-
> OR you can change your import statements as follows:
19-
> ```python
20-
> from label_studio_sdk import Client
21-
> from label_studio_sdk.data_manager import Filters, Column, Operator, Type
22-
> from label_studio_sdk._legacy import Project
23-
> ```
24-
---
25-
263
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
274
[![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
285

@@ -55,6 +32,77 @@ ls = LabelStudio(
5532
)
5633
```
5734

35+
# Versions
36+
37+
## SDK 2.0.0
38+
39+
In August 2025, we released SDK version 2.0.0.
40+
41+
This version has a number of documentation and functional improvements over SDK 1.
42+
43+
### Enhancements
44+
45+
**Enterprise-only**
46+
47+
- Added a new `projects.stats.iaa` endpoint to return stats from the inter-annotator agreement matrix.
48+
- You can now update tasks that have comments.
49+
- Added support for `sync` to `S3s` (S3 with IAM role) exports.
50+
51+
**Enterprise and open source**
52+
53+
- Expanded support to include all project settings, many of which were missing in SDK 1. For example, in Enterprise environments you can now configure `assignment_settings`, `review_settings`, `annotator_evaluation`, and many more.
54+
- Fixed passing the `project` parameter in `actions.list()` (broken in SDK 1).
55+
- Relaxed request/response validation reduces pydantic errors in SDK 2.
56+
57+
### Breaking changes
58+
59+
**Enterprise-only**
60+
61+
- `comments.create` no longer accepts a `project` argument.
62+
- In `prompts.indicators`, the `pk` parameter is now `id`.
63+
- In `prompts.runs` and `prompts.versions`, the `id` parameter is now `prompt_id`.
64+
- `workspaces.members.list` responses are now objects instead of dictionaries.
65+
66+
**Enterprise and open source**
67+
68+
- In `projects.exports` calls, the project ID is now passed as `id`, while the export ID is passed as `export_pk`.
69+
- Predictions returned in task responses are now objects instead of dictionaries.
70+
71+
## SDK 1.0+
72+
73+
SDK 1 was released in June 2024.
74+
75+
If you use the Label Studio SDK 1 package in any automated pipelines, we strongly recommend pinning your SDK version to `<2.0.0` until you can reconcile the breaking changes.
76+
77+
78+
## SDK <1
79+
80+
The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
81+
82+
<details>
83+
84+
<summary> To use SDK <1 </summary>
85+
86+
If you still want to use the deprecated version, you can install it with `pip install "label-studio-sdk<1"`.
87+
88+
OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
89+
90+
```sh
91+
git clone https://github.com/HumanSignal/label-studio-sdk.git
92+
cd label-studio-sdk
93+
git fetch origin
94+
git checkout release/0.0.34
95+
```
96+
97+
OR you can change your import statements as follows:
98+
```python
99+
from label_studio_sdk import Client
100+
from label_studio_sdk.data_manager import Filters, Column, Operator, Type
101+
from label_studio_sdk._legacy import Project
102+
```
103+
104+
</details>
105+
58106
# Examples
59107

60108
Check more examples [here](https://api.labelstud.io/).
@@ -66,7 +114,7 @@ from label_studio_sdk.label_interface import LabelInterface
66114
from label_studio_sdk.label_interface.create import labels
67115

68116
project = ls.projects.create(
69-
name="Project name",
117+
title="Project name",
70118
description="Project description",
71119
label_config=LabelInterface.create({
72120
"image": "Image",

0 commit comments

Comments
 (0)