Skip to main content

Core functionality of dojo

Project description

Dojo SDK Core

Core models and types for the Dojo RL environment framework. Not intended for standalone use by end users.

Overview

dojo-sdk-core provides the core components shared across the Dojo ecosystem:

  • Action Types - Standardized action models for computer use (click, type, scroll, etc.)
  • Reward Functions - Reward functions for dojos that need custom validation
  • Shared Types - Common data structures for tasks, scores, and configurations
  • Settings - Loading of environment variables used by the Dojo SDK
  • Task Loaders - Loading of tasks from local files or remote datasets

Installation

uv add dojo-sdk-core

Key Components

Action Types

Set of computer-use actions: KEY, CLICK, RIGHT_CLICK, DOUBLE_CLICK, MIDDLE_CLICK, DRAG, MOVE_TO, PRESS, HOTKEY, SCROLL, TYPE, DONE, WAIT

Reward Functions

Reward functions provide custom validation logic for tasks that cannot be completed by simple state comparison. Each reward function follows a standard signature:

def reward_function(initial_state: Dict[str, Any], final_state: Dict[str, Any]) -> Tuple[float, str]:
    """
    Args:
        initial_state: The state before any actions were executed
        final_state: Current state of the environment

    Returns:
        Tuple of (score, reason) where:
        - score: float between 0.0 and 1.0 where environment is considered completed if score is 1.0
        - reason: human readable string explaining the validation result
    """

Available reward functions:

  • _validate_get_2048: Checks if a 2048 tile is present on the game board
  • _validate_search_for_dzaka: Validates successful search for a specific user in LinkedIn
  • _validate_drag_to_different_column: Validates issue movement to a different column in Linear
  • _validate_drag_two_issues_same_user: Validates multiple issues moved within same user's board

Documentation

Visit docs.trydojo.ai for complete documentation.

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

dojo_sdk_core-0.1.19.tar.gz (55.2 kB view details)

Uploaded Source

Built Distribution

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

dojo_sdk_core-0.1.19-py3-none-any.whl (65.9 kB view details)

Uploaded Python 3

File details

Details for the file dojo_sdk_core-0.1.19.tar.gz.

File metadata

  • Download URL: dojo_sdk_core-0.1.19.tar.gz
  • Upload date:
  • Size: 55.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for dojo_sdk_core-0.1.19.tar.gz
Algorithm Hash digest
SHA256 33b2c3130c7ef517fb5ce6db7e427a04d1b952e36365601f124614d434a1c051
MD5 1bcfb4a4e8aa2e5fdfe0209157434508
BLAKE2b-256 21d39e89e509b352e4845f5708c157d01bf3a36bf84309930d43bbc217e4cc15

See more details on using hashes here.

File details

Details for the file dojo_sdk_core-0.1.19-py3-none-any.whl.

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 e346ec918fc5c73dca9124263612d948cea412b78af3b8b7d6643f4630da7b3d
MD5 613028a9d9db3c63573db5d2889f7227
BLAKE2b-256 469e944c404980a4a9b9c94718b6ca23a38f5dd8f6d123f055ecb8b2dfdc6499

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