Quickstart Guide
This guide will help you quickly incorporate your OcularAI dataset exports into your Vision-Language Model (VLM) training workflow.Prerequisites
- Python 3.7+
- A valid OcularAI API key
- Access to at least one workspace on the OcularAI platform
Step 1: Navigate to OcularAI Foundry
To get started, navigate to the OcularAI Foundry platform, select the required version to incorporate in your work environment.
Step 2: Create an Export
Click on the create export button and navigate to the previous exports tab to select the required export.
Step 3: Get Your API Key
Configure your API key from OcularAI Foundry platform by navigating to: Workspace settings / developers console / API keys
Step 4: Install the SDK
Install the OcularAI SDK using pip:Step 5: Download Your Dataset
Here’s a simple example of how to download a dataset using the SDK:Alternative: Using Direct Download
If you prefer, you can also use cURL to download your dataset directly:{version_id}
and {export_id}
with your specific IDs.
Store your API key in environment variables to avoid hardcoding it in your scripts. The SDK will automatically look for the
OCULAR_API_KEY
environment variable.