instalabel 0.0.1

InstaLabel Inc.

InstaLabel Python SDK

Welcome to the InstaLabel SDK! This SDK provides a convenient way to interact with the InstaLabel API, allowing you to manage projects, upload images, and retrieve information about your data. Below, you'll find detailed instructions on how to set up and use the SDK.

Table of Contents

1. Installation
2. Getting Started
3. Usage
   • Authentication
   • Projects
     • Creating a Project
     • Retrieving Projects
     • Updating a Project
   • Images
     • Uploading a Single Image
     • Uploading Multiple Images
     • Uploading Images from a Directory
     • Retrieving Project Images
4. Examples
5. Contributing
6. License

Installation

To install the InstaLabel SDK, simply use pip:

pip install instalabel

Getting Started

To start using the SDK, you need to import the necessary modules and create an instance of the InstaLabel class.

from instalabel import InstaLabel

Usage

Authentication

Before making any API requests, you need to authenticate yourself. Use the login method to obtain an access token.

il = InstaLabel()
il.login(username="your_username", password="your_password")

Projects

Creating a Project

To create a new project, use the create_project method. You need to provide the project name, task type, and an optional description.

new_project = il.create_project(
    project_name="New Project",
    task="semantic segmentation",  # Replace with your desired task type
    project_description="This is a sample project"
)
print(new_project)

Retrieving Projects

You can retrieve all projects associated with your account using the get_projects method.

projects = il.get_projects()

To retrieve a specific project, use the get_project method with the project ID.

project = il.get_project(project_id="project_id_here")
print(project)

Updating a Project

To update the details of an existing project, use the update_project method on a Project instance.

project.update_project(
    project_name="Updated Project Name",
    project_description="Updated description"
)

Images

Uploading a Single Image

To upload a single image to a project, use the upload_single_image method.

image = project.upload_single_image(file_path="path_to_image.jpg")
print(image)

Uploading Multiple Images

You can upload multiple images by providing a list of file paths to the upload_images method.

image_paths = ["path_to_image1.jpg", "path_to_image2.jpg"]
project.upload_images(image_paths=image_paths)

Uploading Images from a Directory

To upload all images from a directory, use the upload_directory method. It will automatically find all supported image files.

project.upload_directory(dataset_path="path_to_directory")

Retrieving Project Images

To retrieve all images associated with a project, use the get_images method on a Project instance.

images = project.get_images()
for image in images:
    print(image)

Examples

Here are some practical examples of using the SDK for common tasks:

1. Authenticate and Retrieve All Projects

   This example demonstrates how to authenticate and list all projects associated with your account.

   from instalabel import InstaLabel
   
   # Initialize InstaLabel client
   il = InstaLabel()
   
   # Authenticate with your credentials
   il.login(username="your_username", password="your_password")
   
   # Retrieve and print all projects
   projects = il.get_projects()
   for project_id, project in projects.items():
       print(f"Project ID: {project_id}, Name: {project.name}, Task: {project.task.value}")
   

2. Create a New Project and Upload a Directory of Images

   This example shows how to create a new project and upload all images from a specified directory.

   from instalabel import InstaLabel
   
   # Initialize InstaLabel client
   il = InstaLabel()
   
   # Authenticate with your credentials
   il.login(username="your_username", password="your_password")
   
   # Create a new project
   new_project = instalabel.create_project(
       project_name="Image Classification Project",
       task="object detection",
       project_description="A project for image classification tasks."
   )
   
   # Upload all images from a directory
   dataset_directory = "path/to/your/image/directory"
   new_project.upload_directory(dataset_path=dataset_directory)
   
   # Output the uploaded project details
   print(f"Project created: {new_project.name} with ID {new_project.id}")
   

3. Retrieve and Print All Images from a Project

   This example retrieves all images from a specific project and prints their details.

   from instalabel import InstaLabel
   
   # Initialize InstaLabel client
   il = InstaLabel()
   
   # Authenticate with your credentials
   il.login(username="your_username", password="your_password")
   
   # Retrieve a specific project
   project_id = "your_project_id_here"
   project = il.get_project(project_id=project_id)
   
   # Retrieve and print all images in the project
   images = project.get_images()
   for image in images:
       print(f"Image ID: {image.id}, Filename: {image.filename}, Status: {image.status}")
   

---