Skip to main content

ScienceWorld: An interactive text environment to study AI agents on accomplishing tasks from the standardized elementary science curriculum.

Project description

ScienceWorld

ScienceWorld is a text-based virtual environment centered around accomplishing tasks from the standardized elementary science curriculum. This code accompanies the paper ScienceWorld: Is your Textual Agent Smarter than a 5th grader?.

Demo and examples

You can try ScienceWorld yourself via our HuggingFace Space or read some of the playthrough transcripts.

Citation

@misc{scienceworld2022,
    title={ScienceWorld: Is your Agent Smarter than a 5th Grader?},
    author={Ruoyao Wang and Peter Jansen and Marc-Alexandre C{\^o}t{\'e} and Prithviraj Ammanabrolu},
    year={2022},
    eprint={2203.07540},
    archivePrefix={arXiv},
    primaryClass={cs.CL},
    url={https://arxiv.org/abs/2203.07540}
}

Quickstart

Before running: You will have to have Java 1.8+ installed on your system (shipped with most linux distributions).

Install with pip:

conda create --name scienceworld python=3.8
conda activate scienceworld
pip install scienceworld

Run an example random agent, on task 13 (classification: place a non-living thing in a box), for 5 episodes:

python examples/random_agent.py --task-num=13 --num-episodes=5 --simplifications-preset easy

Run a user console where you can interact with the environment, on task 3 (change of state: melting):

python examples/human.py --task-num=3 --num-episodes=5

Web Server Demo

A web server demo is also available, that allows running a ScienceWorld user console that can be interacted with in a web browser.

To run the web server demo:

conda create --name scienceworld python=3.8
conda activate scienceworld
pip install scienceworld[webserver]

Run the web server:

python examples/scienceworld-web-server-example.py

Point your web browser to: localhost:8080

ScienceWorld Design

ScienceWorld is written in Scala (2.12.9), and compiles using sbt into a JAR file that is run with java. For convenience, a python API is provided, which interfaces using the py4j package.

Tasks

The subtasks and their associated subtask indices are listed below. Subtask indices are automatically assigned by sorting task names:

SubTask # Task Name
0 task-1-boil
1 task-1-change-the-state-of-matter-of
2 task-1-freeze
3 task-1-melt
4 task-10-measure-melting-point-(known-substance)
5 task-10-measure-melting-point-(unknown-substance)
6 task-10-use-thermometer
7 task-2-power-component
8 task-2-power-component-(renewable-vs-nonrenewable-energy)
9 task-2a-test-conductivity
10 task-2a-test-conductivity-of-unknown-substances
11 task-3-find-animal
12 task-3-find-living-thing
13 task-3-find-non-living-thing
14 task-3-find-plant
15 task-4-grow-fruit
16 task-4-grow-plant
17 task-5-chemistry-mix
18 task-5-chemistry-mix-paint-(secondary-color)
19 task-5-chemistry-mix-paint-(tertiary-color)
20 task-6-lifespan-(longest-lived)
21 task-6-lifespan-(longest-lived-then-shortest-lived)
22 task-6-lifespan-(shortest-lived)
23 task-7-identify-life-stages-1 (animal)
24 task-7-identify-life-stages-2 (plant)
25 task-8-inclined-plane-determine-angle
26 task-8-inclined-plane-friction-(named-surfaces)
27 task-8-inclined-plane-friction-(unnamed-surfaces)
28 task-9-mendelian-genetics-(known-plant)
29 task-9-mendelian-genetics-(unknown-plant)

Baseline Agents

DRRN: https://github.com/cognitiveailab/drrn-scienceworld

KG-A2C: https://github.com/cognitiveailab/kga2c-scienceworld

CALM: https://github.com/cognitiveailab/calm-scienceworld

Behavior Cloning and Decision Transformer: https://github.com/cognitiveailab/t5-scienceworld

Additional Documentation

Coming soon!

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

scienceworld-1.1.1.tar.gz (7.3 MB view details)

Uploaded Source

Built Distribution

scienceworld-1.1.1-py3-none-any.whl (7.3 MB view details)

Uploaded Python 3

File details

Details for the file scienceworld-1.1.1.tar.gz.

File metadata

  • Download URL: scienceworld-1.1.1.tar.gz
  • Upload date:
  • Size: 7.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for scienceworld-1.1.1.tar.gz
Algorithm Hash digest
SHA256 25fe311a806b04518325d6cbd94ffd05a53b37ffa0f5b74be48d97304216f1fa
MD5 c6c214e297bd838f8be41e075411016e
BLAKE2b-256 75556b0ada4caa6c06be135ea6ccd2b4cca1a074c94b8e61f0e277410a5181a6

See more details on using hashes here.

File details

Details for the file scienceworld-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scienceworld-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eb52ce646274ca4c8b88653365504fda005c3379fcf13a43b328179b31707943
MD5 294cca254e96c16ca374f71b1c7eae1d
BLAKE2b-256 5eac0826f3dcaf4a4af62c00ec31704aba760c914c93a1c4a45245df94073a8c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page