Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supercontrast.com/llms.txt

Use this file to discover all available pages before exploring further.

Hero Light

​
Install

Getting started with supercontrast is easy. You can install via pip: 
pip install supercontrast

​
Quick Start

Supercontrast provides a unified interface for various AI tasks across different cloud providers. Here’s a quick introduction on how to use it:
  1. Import the necessary classes:
from supercontrast import SuperContrastClient, Task, Provider, OCRRequest
  1. Initialize a SuperContrastClient for your desired task and provider:
client = SuperContrastClient(task=Task.OCR, providers=[Provider.GCP])
  1. Create a request object for your task:
request = OCRRequest(image="path/to/image.png")
  1. Make the request and handle the response:
response, metadata = client.request(request)
print(f"Response: {response}")
print(f"Metadata: {metadata}")

​
Example

Here’s a complete example that demonstrates how to use supercontrast for OCR: 
from supercontrast import SuperContrastClient, Task, Provider, OCRRequest

# Initialize the client
client = SuperContrastClient(task=Task.OCR, providers=[Provider.GCP])

# Create a request
request = OCRRequest(image="https://github.com/supercontrast-ai/supercontrast/raw/main/tests/image/test_ocr.png")

# Make the request and handle the response
response, metadata = client.request(request)

# Print the results
print(f"Extracted text: {response}")
print(f"Metadata: {metadata}")
This example shows how to perform OCR on an image using Google Cloud Platform as the provider. The same pattern can be applied to other tasks and providers supported by supercontrast. For other tasks, see the Tasks section of the documentation. To set up providers, see the Providers section of the documentation.