AdaEval-VSPO / README.md
hitsmy's picture
Add README
f430fbc verified

Frozen Lake Visual Spatial Planning Dataset

    ## Dataset Description

    This dataset contains visual maze navigation and path verification tasks based on the Frozen Lake environment.

    ### Dataset Summary

    - **Total samples**: 1670
    - **Tasks**: Path Navigation and Path Verification
    - **Splits**:
    - `navigation_test`: 900 samples
  • verify_test: 770 samples

      ### Task Types
    
      1. **Path Verification**: Given a maze image and an action sequence, determine if the path is safe (avoids holes and reaches the goal).
      2. **Path Navigation**: Given a maze image, generate an optimal action sequence from start to goal while avoiding holes.
    
      ### Data Fields
    
      Common fields:
      - `idx`: Unique identifier
      - `original_id`: Original data ID
      - `image`: RGB image of the maze
      - `text`: Task instruction and prompt
      - `answer`: Ground truth answer
      - `task_type`: Type of task (verify/navigation)
      - `split`: Data split (sft/rl/test)
      - `size`: Maze size (grid dimension)
      - `gym_map`: Gym environment map representation (JSON string)
    
      Path Verification specific fields:
      - `path_length`: Length of the action sequence
      - `path`: Action sequence string
    
      Path Navigation specific fields:
      - `start_coords`: Starting coordinates (JSON string)
      - `goal_coords`: Goal coordinates (JSON string)
      - `obstacle_coords`: Obstacle coordinates (JSON string)
      - `astar_path`: A* algorithm path (if available)
    
      ### Actions
    
      - `L`: Move left
      - `R`: Move right
      - `U`: Move up
      - `D`: Move down
    
      ### Maze Elements
    
      - `S`: Start position
      - `G`: Goal position
      - `F`: Frozen (safe) tile
      - `H`: Hole (unsafe)
    
      ## Usage
    
      ```python
      from datasets import load_dataset
    
      # Load specific split
      dataset = load_dataset("YOUR_USERNAME/frozen-lake-vsp", split="navigation_test")
    
      # Access an example
      example = dataset[0]
      image = example['image']
      prompt = example['text']
      answer = example['answer']
      ## Citation
      If you use this dataset, please cite:
    
      @dataset{temp,
      title={temp},
      author={Your Name},
      year={2024}
      }
    
      License
      Apache 2.0