Use Dataset

Overview

Search, download, and inspect datasets from the AgentSociety platform. All operations use the public API -- no authentication required. Always read the README before operating on dataset contents to avoid misinterpretation of column types, units, and semantics.

Use the Python interpreter from .env. See CLAUDE.md for setup.

When to Use

• User needs external datasets for experiments or analysis
• Searching for survey data, agent profiles, or simulation results
• User says "download dataset", "find data", "browse datasets", or "search datasets"

Do NOT use when:

• User wants to create or upload a dataset (use agentsociety-create-dataset)
• User needs to design experiments from scratch (use experiment-config)

Quick Reference

Run commands from the workspace root through .agentsociety/bin/ags.py.

Workflow

digraph use_dataset_flow {
    rankdir=LR;
    node [shape=box, style=filled, fillcolor="#E8F4FD"];
    browse [label="browse or search"];
    readme [label="read README"];
    download [label="download"];
    inspect [label="inspect files"];
    update [label="check for updates"];

    browse -> readme -> download -> inspect -> update;
}

For listing examples and status value details, see references/listing-guide.md. For the downloaded metadata.json schema, see references/metadata-format.md.

Common Mistakes

Pipeline Position

Predecessors: create-dataset (for locally created datasets), otherwise none (standalone) Successors: experiment-config (for experiment setup), analysis (for data analysis)