Metadata-Version: 2.1
Name: intercode-bench
Version: 0.1.4
Summary: The official InterCode benchmark package - a framework for interactive code tasks
Home-page: http://github.com/intercode-benchmark/intercode-benchmark
Author: John Yang
Author-email: byjohnyang@gmail.com
Project-URL: Documentation, https://github.com/intercode-benchmark/intercode-benchmark
Project-URL: Bug Reports, https://github.com/intercode-benchmark/intercode-benchmark/issues
Project-URL: Source Code, https://github.com/intercode-benchmark/intercode-benchmark
Project-URL: Website, https://intercode-benchmark.github.io/
Keywords: nlp,benchmark,interaction,code,rl,decision making
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: gymnasium
Requires-Dist: mysql-connector-python
Requires-Dist: scikit-learn (>=1.2.2)
Requires-Dist: pandas
Requires-Dist: rich
Requires-Dist: docker

# 🤖💻 Intercode
Build interactive code environments for training, testing, and augmenting code and decision making agents

<p>
    <a href="https://badge.fury.io/py/intercode-bench">
        <img src="https://badge.fury.io/py/intercode-bench.svg">
    </a>
    <a href="https://www.python.org/">
        <img alt="Build" src="https://img.shields.io/badge/Python-3.8+-1f425f.svg?color=purple">
    </a>
    <a href="https://copyright.princeton.edu/policy">
        <img alt="License" src="https://img.shields.io/badge/License-MIT-blue">
    </a>
</p>

## 👋 Overview
InterCode is a **lightweight, flexible, and easy-to-use framework** for designing interactive code environments. Following the popular [`gym`](https://gymnasium.farama.org/) interface definition, InterCode makes it easy to quickly define a code environment and deploy an agent to operate in code within the context of the environment.

For an overview of InterCode, building interactive code tasks with InterCode, and evaluating agents on InterCode environments, please check out our [wiki](TO DO) and the original paper:

**[InterCode: Standardizing and Benchmarking Interactive Coding with Execution Feedback](https://intercode-benchmark.github.io/)**  

## 🛠️ Installation
```
pip install intercode-bench
```

## 🚀 Quick Start
* Clone the [InterCode starter repository](https://github.com/intercode-benchmark/starter-files)
* Run `./setup.sh`
* Run `python run_sql.py` 

If InterCode was installed successfully, the InterCode SQL environment should be started successfully and a CLI interpreter should appear, allowing you to enter `SQL` commands
to interact with the task setting.

## 🔎 Learn More
To learn more about the InterCode framework, please check out the [website](https://intercode-benchmark.github.io/) and GitHub [repository](https://github.com/intercode-benchmark/intercode-benchmark)

## 🪪 License
Check `LICENSE.md`
