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.26.tar.gz (760.5 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.26-py3-none-any.whl (782.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_core-0.1.26.tar.gz
Algorithm Hash digest
SHA256 74097eb7a15ea388fc847dcfe2dc1b61c2bdfe364f15d875cc5fb36bfd7b20de
MD5 7c6ffcfac2764b8726c2de0204f1d566
BLAKE2b-256 2779051835708cda19d412171fd726d3a87f4ae4022cd188ccf357753b1fb168

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 f00adc9baec983e5957ecbb67f63d50c7f09e61b682e420dae8bd00364500293
MD5 3aec9567b7ee327d5b50cdc5b51197e4
BLAKE2b-256 fa022f4f3d60cc5df961ce7094cc4f2fec811458893a0a5b4adecb6d5e940441

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