Skip to main content

Unified toolkit for building, training, and testing digital and physical operators.

Project description

Operator (optr)

A unified Python framework for building, training, and deploying intelligent operators across digital and physical environments.

[!WARNING]
Early Alpha — APIs and behavior will change without notice.

Overview

optr provides a flexible architecture for creating operators that can:

  • Automate desktop applications via GUI interaction
  • Control physical robots through simulation and hardware interfaces
  • Learn from demonstrations using imitation learning and reinforcement learning
  • Record and replay episodes for testing and training
  • Bridge multiple environments with unified connector interfaces

Key Features

  • Desktop Automation - Click, type, and interact with GUI elements
  • Robot Control - MuJoCo simulation and physical robot support
  • Learning Algorithms - Imitation learning, Pi0, and custom algorithms
  • Episode Recording - Capture and replay operator sequences
  • Modular Connectors - Extensible interface for any environment
  • Validation & Safety - Built-in sentinel guards and validators
  • Training Pipeline - Dataset management and model training

Installation

Basic Install

pip install optr

Development Install (using uv)

git clone https://github.com/codecflow/optr

cd optr

uv sync --dev

Quick Start

Desktop Automation

Create an operator that automates login:

# my_app/operators/login.py

from optr.operator import Operator
from optr.connector.desktop import DesktopConnector

async def login_operator():
    op = Operator({"desktop": DesktopConnector()})
    
    # Click username field
    await op.execute_action("click", selector="#username")
    await op.execute_action("type", text="demo_user")
    
    # Click password field  
    await op.execute_action("click", selector="#password")
    await op.execute_action("type", text="secure_pass")
    
    # Submit form
    await op.execute_action("click", selector="#submit")
    
    return op

Robot Control (MuJoCo)

Control a simulated robot:

# my_app/operators/robot.py

from optr.operator import Operator
from optr.simulator.mujoco import MuJoCoSimulation

async def robot_operator():
    sim = MuJoCoSimulation("models/robot.xml")
    op = Operator({"robot": sim.get_connector()})
    
    # Move to target position
    await op.execute_action("move", 
                           connector_name="robot",
                           position=[0.5, 0.3, 0.2])
    
    # Grasp object
    await op.execute_action("grasp", 
                           connector_name="robot",
                           force=10.0)
    
    return op

Core Concepts

Operators

The main abstraction for defining automated behaviors. Operators can work with multiple connectors simultaneously.

Connectors

Interfaces to different environments (desktop, robot, web, etc.). Each connector provides state observation and action execution.

Algorithms

Learning algorithms for training operators from demonstrations or through reinforcement learning.

Episodes

Recorded sequences of states and actions that can be replayed or used for training.

Sentinel

Safety and validation layer that ensures operators behave within defined constraints.

Roadmap

  • Cloud API connectors
  • Distributed operator coordination
  • Model zoo with pre-trained operators
  • Real-time monitoring dashboard

License

MIT © CodecFlow

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optr-0.0.0a4.tar.gz (21.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optr-0.0.0a4-py3-none-any.whl (114.5 kB view details)

Uploaded Python 3

File details

Details for the file optr-0.0.0a4.tar.gz.

File metadata

  • Download URL: optr-0.0.0a4.tar.gz
  • Upload date:
  • Size: 21.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.12

File hashes

Hashes for optr-0.0.0a4.tar.gz
Algorithm Hash digest
SHA256 b70ebfcc8832475c009f5a90ab5fd6d45fc4a008c940ffec3ade9f86dfb4436f
MD5 c5dd552edfcabfbcd9f73915d56db6aa
BLAKE2b-256 84c3ea68a8f8cb8008371d7a7e00230d14eb87f8b126440111eb248b65aaaa46

See more details on using hashes here.

File details

Details for the file optr-0.0.0a4-py3-none-any.whl.

File metadata

  • Download URL: optr-0.0.0a4-py3-none-any.whl
  • Upload date:
  • Size: 114.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.12

File hashes

Hashes for optr-0.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 f5927d305c734bc6f37c7ce17e3f2b2c65deb719dc55cb0b77b8ffa40c9b1468
MD5 1636a38427e15a995f2f27a841aedebb
BLAKE2b-256 7431cb661998248e3bf2a24933c714c0df91fe4f4b554f8aa1513814317b14ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page