encord 0.1.98

Encord Python SDK Client

Encord Python API Client

The data engine for computer vision

💻 Features

• Minimal low-level Python client that allows you to interact with Encord's API
• Supports Python: 3.8, 3.9, 3.10 and 3.11

✨ Relevant Links

• Encord website
• Encord web app
• Encord documentation

💡 Getting Started

For full documentation, please visit Encord Python SDK.

First, install Encord Python API Client using the pip package manager:

pip install encord

Then, generate an public-private key pair, and upload the public key to Encord website. Detailed guide can be found in the dedicated manual.

Passing the private key to the factory, you can initialise the Encord client directly.

from encord import EncordUserClient

user_client = EncordUserClient.create_with_ssh_private_key(
    "<your_private_key_content>",
    password="<your_private_key_password_if_set_on_key_generation>",
)

Once you have instantiated an Encord client, it is easy to fetch a project information and start working with the platform.

project = user_client.get_project("<project_hash>")
label_rows = project.list_label_rows_v2()

For detailed examples and API reference please refer to Encord SDK documentation

🐛 Troubleshooting

Please report bugs to the GitHub Issues. Just make sure you read the Encord documentation and search for related issues first.