Skip to main content

Labelator.io - python client

Python client for Labelator.io - labeling and ML training studio

Install

pip install labelatorio

Getting your API token

Click on "user" icon in the right-top corner, select "User settings". Click on Get API token. Copy token into clipboard.

Docs:

Full Labelator.io documentation can be found here docs.labelator.io

Page dedicated this client can be found here

Usage

Connecting client

    import labelatorio
    client = labelatorio.Client(api_token="your_api_token")

Getting project info

Package requirements are handled using pip. To install them do

# get project by id
existing_project = client.projects.get("2fab1778-e8b1-4327-ac83-16dd0e783ab4")

# if you have just name
existing_project = client.projects.get_by_name("my name")

# or if you don't know the exact name
existing_project = client.projects.search("my name")

Adding, updating documents

df = pd.DataFrame({
        "key":["first","second"], # mandatory
        "text":["this is my first text", "completely different text..."],  # mandatory
        "my_custom_column":["note 1",None] # optional
        "labels":[["ClassA"],None] #optional if you have labels - should be defined in project
    })

ids = client.documents.add_documents(project_id, data=df)

client.documents.set_labels(project_id,ids[1],["ClassB"])

Quering documents

# simple keyword search ... 
found = client.documents.search(keyword="completely different") 

# find all documents where "ClassA" was predicted
found = client.documents.search( predicted_label="ClassA")

# find all documents where "ClassA" was incorrectly predicted
found = client.documents.search( false_positives="ClassA")

Metadata

Release files for labelatorio 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for labelatorio 0.4.1
File Size Uploaded
labelatorio-0.4.1.tar.gz 17.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for labelatorio 0.4.1
File Interpreter ABI Platform
labelatorio-0.4.1-py3-none-any.whl Python 3 none any Details

Total release size: 35.0 kB

Release files / labelatorio-0.4.1.tar.gz

Download URL labelatorio-0.4.1.tar.gz
Size 17.3 kB
Tags Source
SHA-256 checksum
How to use checksums
03d9b533b1b44a1d670fca3ef97b78215002a9444265f9da59f8e283915dc132
BLAKE2b-256 checksum
How to use checksums
df5a26f9d6d5516fa706d2a3c1df7574733fb6831cbc6f382fe7f908b686ea8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.16

Release files / labelatorio-0.4.1-py3-none-any.whl

Download URL labelatorio-0.4.1-py3-none-any.whl
Size 17.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1bb136e1529d5be4732339b31df6ff22f6d5c1c4d9e37350dccc8bf1e147a787
BLAKE2b-256 checksum
How to use checksums
c80423383899cbc6f678d6f2947eccc22522a30d5a7bf3e768160adf1cb90b69
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.16
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page