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.25.tar.gz (150.8 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.25-py3-none-any.whl (164.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_core-0.1.25.tar.gz
Algorithm Hash digest
SHA256 8131a0af72776021fd7cffd84f6af74ee7c5f9218c005d994360e8752b03fd7c
MD5 18b2f8ad320a7ce8067a2dd8a266cd19
BLAKE2b-256 2d31a9944ac0fbbd21a3dd7042832534e38f6c3f7a3f3043d5aa418857733946

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_core-0.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 01f5ce2fbff8a1b8adf7e20badd265a902c90186de328aad3471e856d3f349b0
MD5 3983741424336ba6e3994aab0eea014b
BLAKE2b-256 79c86afbc7056b2f7a7f558cb1d804f3892ed96f3df34943437818e9ee06f6c2

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