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.24.tar.gz (85.4 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.24-py3-none-any.whl (97.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_core-0.1.24.tar.gz
Algorithm Hash digest
SHA256 ae877d0867c212c8515444a9ed77770b45d49b6088bc0e31dd0f35be0de77737
MD5 58f2641c886a627718eb54598bbd9e35
BLAKE2b-256 a4a16d73c27bde3dc2f174f7273c7e513ea158b3885507af00c5cb1f7efc29ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 70614eb7fff290b0ae684aea4b93c566553640830ad655075159e93eb0f1c157
MD5 7bb6bbe1e8fb0683207c79aad0278217
BLAKE2b-256 392949b705a4b3bc9822722029de995a2b729f309601d9a97f3c8e35c244b780

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