Registry / ai-ml / encord

encord

JSON →
library0.1.197pypypi✓ verified 90d ago

Encord is an end-to-end platform for AI-assisted annotation, quality control, and data management for computer vision and multimodal AI. The Encord Python SDK client allows programmatic interaction with the Encord API to create automated pipelines and integrate Encord functionalities directly into existing MLOps workflows. The library is currently at version 0.1.192 and is actively maintained with frequent updates, including multiple releases within the last month.

pip install encord
INSTALL
IMPORT
SIG · ENCORD
E
encord
ai-mlpythonv0.1.197
Install
14.0s avg
Import
2653ms
Disk
255MB
Pass rate
7/ 10
Env Coverage7 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v0.1.197 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
glibc
py 3.10
✕ build_error
✓ 19.43s
py 3.11
✕ build_error
✓ 17.53s
py 3.12
✓ —
✓ 4.48s
py 3.13
✓ —
✓ 4.38s
py 3.9
✕ build_error
✓ 24.08s
255MB installed
● package 255MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

EncordUserClient
✓ from encord.user_client import EncordUserClient
StorageLocation
✓ from encord.orm.dataset import StorageLocation
LabelRowV2
✓ from encord.objects import LabelRowV2

Initializes the Encord client using an SSH private key from environment variables (supporting both EMEA and US deployments) and then lists the first 5 accessible datasets. A private key must be generated from the Encord web app and set as an environment variable (ENCORD_KEY or ENCORD_US_KEY).

import os from encord.user_client import EncordUserClient # For EMEA clients, use 'ENCORD_KEY'. For US clients, use 'ENCORD_US_KEY'. # Replace with your actual private key content or set the environment variable. # Example: export ENCORD_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----" private_key = os.environ.get('ENCORD_KEY', os.environ.get('ENCORD_US_KEY', '')) if not private_key: print("Error: Encord private key not found in environment variables (ENCORD_KEY or ENCORD_US_KEY).") print("Please set the environment variable or replace the placeholder in the code.") else: try: user_client = EncordUserClient.create_with_ssh_private_key(private_key) print("Successfully authenticated with Encord.") # Example: List up to 5 datasets accessible by the user datasets = user_client.list_datasets(page_size=5) if datasets: print("\nFirst 5 datasets:") for ds in datasets: print(f" - {ds.title} (ID: {ds.dataset_hash})") else: print("No datasets found.") except Exception as e: print(f"Authentication or API call failed: {e}")
Debug
Known issues
gotchaDatasets cannot be deleted via the Python SDK or API; they must be removed directly through the Encord platform web interface.
fix
Access the Encord platform GUI to manage dataset deletion.
affects: All versions
gotchaWhen working with remote storage (AWS S3, GCP, Azure), Cross-Origin Resource Sharing (CORS) policies must be correctly configured for images or videos to load properly in the Encord application. Failure to do so will result in loading errors.
fix
Ensure a valid CORS policy is applied to your remote storage bucket, allowing Encord's domains. Consult provider-specific documentation for CORS setup (e.g., AWS S3 bucket policy).
affects: All versions
gotchaCalling `user_client.get_project()` on very large projects can lead to timeouts.
fix
Consider increasing the timeout setting for your Encord client instance, or break down operations into smaller queries if possible.
affects: All versions
deprecatedSome 'Label / Activity logs' functionalities within project management are marked as deprecated.
fix
Refer to the latest Encord documentation for updated methods or alternatives for accessing label and activity logs.
affects: Mentioned in current documentation
gotchaVideo re-encoding issues (e.g., 'ghost frames' from negative timestamps, unexpected behavior with audio frames, variable frame rates) can cause annotation misalignment.
fix
Utilize Encord's platform or SDK re-encoding functions to process videos. The platform detects and warns about such issues, offering re-encoding solutions (e.g., dropping audio, re-encoding video frames, converting formats).
affects: All versions
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'python_dotenv'
The `python-dotenv` package is not installed, but it is required if you are using a `.env` file for local environment variable management.
fix
Install the missing dependency: `pip install python-dotenv` or `pip install encord python-dotenv`.
Authentication or API call failed: Invalid private key provided.
The SSH private key used for authentication is either incorrect, malformed, or has expired. The client cannot establish a secure connection.
fix
Verify that your SSH private key is correct, unexpired, and properly formatted. Ensure you are using the correct key for your Encord region (EMEA or US) and that it has the necessary permissions.
Failed to load image/video from remote storage
This error often indicates a misconfigured Cross-Origin Resource Sharing (CORS) policy on your cloud storage bucket (e.g., AWS S3, GCP, Azure), preventing Encord from accessing the media.
fix
Update the CORS policy for your remote storage bucket to allow access from Encord's domains. Consult your cloud provider's documentation for specific instructions on setting up CORS.
requests.exceptions.ReadTimeout: HTTPConnectionPool(...) Read timed out.
This timeout typically occurs when `user_client.get_project()` is called on an exceptionally large project, and the default network timeout is exceeded while fetching project data.
fix
Increase the timeout for your Encord client or consider fetching project data in smaller, more manageable queries if the API supports it. Check the Encord documentation for client configuration options related to timeouts.
Upgrade
Version history
0.1.197latest on PyPI · released May 15, 2026
Audit
Dependencies
python-dotenvoptionalOptional, for loading environment variables from a .env file for authentication.
Agent activity
32 hits · last 30 days
node
30
OpenAI (training)
1
Resources
encord — pip install encord · libregistry