Global and US Encord Platforms

Encord currently supports hosting your platform instance globally or in the US. The Global and the US instances have complete feature parity with each other. The major differences are the following:

• Global and US instances are completely independent of each other.

• Global instance users access the Encord platform using https://app.encord.com/.

• US instance users access the Encord platform using https://app.us.encord.com/.

• Using the SDK with the US instance requires adding domain="https://api.us.encord.com" to their code for authentication.

Authentication with US instances

If you are using Encord’s US based hosted platform, ALL authentication for the SDK MUST include the following:

domain="https://api.us.encord.com"

Template

# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>",
    domain="https://api.us.encord.com",
)

Examples

All templates in the documentation work for both the US and Global deployments. While the examples below use the US deployment for clarity, you can adapt any SDK template to the US deployment by simply updating the domain parameter in the authentication call, even if a US-specific example is not provided.

The US templates MUST include domain for authentication:

user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH,
    domain="https://api.us.encord.com"
)

Add Items to Collection using Preset

This example comes from here.

Global Template

# Import dependencies
from encord import EncordUserClient
from encord.collection import ProjectCollection
from encord.orm.filter_preset import FilterPreset
from encord.objects.coordinates import BoundingBoxCoordinates
from encord.orm.collection import ProjectCollectionType, ProjectDataCollectionItemRequest, ProjectLabelCollectionItemRequest


# Define constants
SSH_PATH = "<file-path-to-ssh-private-key>"

PROJECT_ID = "<project-unique-id>"

COLLECTION_ID = "<collection-unique-id>"

PRESET_ID = "<preset-unique-id>"

# Initialize the user client using the SSH private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Fetch the specific Project by ID
project = user_client.get_project(PROJECT_ID)


# Fetch the specific Collection by ID
collection = project.get_collection(COLLECTION_ID)


collection.add_preset_items(PRESET_ID)

print(f"Added items to collection {COLLECTION_ID}.")

Submit Tasks as Another User in a Stage

This example comes from here.

Global Template

from encord.user_client import EncordUserClient
from encord.workflow.stages.annotation import AnnotationStage, AnnotationTaskStatus
from encord.workflow.stages.consensus_annotation import ConsensusAnnotationStage
from encord.workflow.stages.consensus_review import ConsensusReviewStage
from encord.workflow.stages.review import ReviewStage

SSH_PATH = "<file-path-to-private-key>"

PROJECT_ID="<project-unique-id>"

# Initialize the user client using the SSH private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

project = user_client.get_project(PROJECT_ID)

workflow = project.workflow

annotation_stage = workflow.get_stage(name="<name-of-annotation-stage>", type_=<type-of-workflow-stage>)

for annotation_task in annotation_stage.get_tasks():
    print(annotation_task.data_title)
    
    # Submit as someone explicitly
    annotation_task.submit(assignee='<email-address>')

Import your metadata schema to Encord

This example comes from here.

Global Template

# Import dependencies
from encord import EncordUserClient
from encord.metadata_schema import MetadataSchema

SSH_PATH = "<file-path-to-ssh-private-key>"

# Authenticate with Encord using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Create the schema
metadata_schema = user_client.metadata_schema()

# Add various metadata fields
metadata_schema.add_scalar("metadata_1", data_type="boolean")
metadata_schema.add_scalar("metadata_2", data_type="datetime")
metadata_schema.add_scalar("metadata_3", data_type="number")
metadata_schema.add_scalar("metadata_4", data_type="uuid")
metadata_schema.add_scalar("metadata_5", data_type="varchar")
metadata_schema.add_scalar("metadata_6", data_type="text")

# Add an enum field
metadata_schema.add_enum("my-enum", values=["enum-value-01", "enum-value-02", "enum-value-03"])

# Add embedding fields
metadata_schema.add_embedding('my-test-active-embedding', size=512)
metadata_schema.add_embedding('my-test-index-embedding', size=<values-from-1-to-4096>)

# Save the schema
metadata_schema.save()

# Print the schema for verification
print(metadata_schema)