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.17.tar.gz (49.3 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.17-py3-none-any.whl (59.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_core-0.1.17.tar.gz
Algorithm Hash digest
SHA256 8fa34d9f4ebe9bb2c8a6d84e286be5837bbc14f200a63fcc3703a39bbb8b6ef2
MD5 e871836206dd5c25e1316052b8c475dd
BLAKE2b-256 71330443c4b75d8f61a7d28f99db92a15b337feb92c82fa847925aa2c0639b0e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 033abbab3dde76d607e3809351e1ac1a361dc027245fb39a6737ab08efe24bc2
MD5 699e7961c94286ca3f30fef2e84b7537
BLAKE2b-256 1d119153dce4babaaa442db39fd0b7ebff19d6ee292176fc338dfc5a5bb60bf4

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