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.27.tar.gz (1.7 MB 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.27-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_core-0.1.27.tar.gz
Algorithm Hash digest
SHA256 d6aa1d13e526fc9b47f76d5b924c5bd87ecbedabd2065c99e75a4bb5bc2e4fdd
MD5 4e5f3d141b4e59ad7725a31d20294468
BLAKE2b-256 f5f266be0bd3fb8d69aebef040d2d6e06a3ed24fac8f8d33b7fa402100e0811f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 33bcbbda3d5c4144d151951df1c613db370c5bb2188ba8c76f007d10f9cf10b0
MD5 6f4454c1813c99e93b65e7be2bb77380
BLAKE2b-256 4fd6e0337ecf7ea11969a24d4689b256fba75391bb939e2e33a7cb4e932a8032

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