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.14.tar.gz (46.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.14-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_core-0.1.14.tar.gz
Algorithm Hash digest
SHA256 2cefd1fcca3bc84ebb7cb30757299a5ec7a1e79a61a38081d9d0af21a3a658d7
MD5 ab289daff5b7a599252b5a7042433d39
BLAKE2b-256 d9e9f8b15a5eb41b54641ee4261633dce76146d28cd850c290e52af29443b7d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 f82653ae5ab89810ce769b1ac05af83778f644946dccb0260e8d24a49f2074c0
MD5 62e3fe01fb332dc029648fb6021c8af1
BLAKE2b-256 8c96a272907c84afc27dea98fb75be5abb811289a3a534ce2e8c41841cef428a

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