Giter VIP home page Giter VIP logo

typeevalpy's Introduction


A Micro-benchmarking Framework for Python Type Inference Tools

๐Ÿ“Œ Features:

  • ๐Ÿ“œ Contains 154 code snippets to test and benchmark.
  • ๐Ÿท Offers 845 type annotations across a diverse set of Python functionalities.
  • ๐Ÿ“‚ Organized into 18 distinct categories targeting various Python features.
  • ๐Ÿšข Seamlessly manages the execution of containerized tools.
  • ๐Ÿ”„ Efficiently transforms inferred types into a standardized format.
  • ๐Ÿ“Š Automatically produces meaningful metrics for in-depth assessment and comparison.

๐Ÿ› ๏ธ Supported Tools

Supported โœ… In-progress ๐Ÿ”ง Planned ๐Ÿ’ก
HeaderGen Intellij PSI Llama 2
Jedi Pyre ChatGPT
Pyright PySonar2
HiTyper Pytype
Scalpel TypeT5
Type4Py

๐Ÿ† TypeEvalPy Leaderboard

Below is a comparison showcasing exact matches across different tools, coupled with top_n predictions for ML-based tools.

Rank ๐Ÿ› ๏ธ Tool Top-n Function Return Type Function Parameter Type Local Variable Type Total
1 HeaderGen 1 186 56 322 564
2 Jedi 1 122 0 293 415
3 Pyright 1 100 8 297 405
4 HiTyper 1
3
5
163
173
175
27
37
37
179
225
229
369
435
441
5 HiTyper (static) 1 141 7 102 250
6 Scalpel 1 155 32 6 193
7 Type4Py 1
3
5
39
103
109
19
31
31
99
167
174
157
301
314

(Auto-generated based on the the analysis run on 20-10-23 14:51)


๐Ÿณ Running with Docker

1๏ธโƒฃ Clone the repo

git clone https://github.com/secure-software-engineering/TypeEvalPy.git

2๏ธโƒฃ Build Docker image

docker build -t typeevalpy .

3๏ธโƒฃ Run TypeEvalPy

๐Ÿ•’ Takes about 30mins on first run to build Docker containers.

๐Ÿ“‚ Results will be generated in the results folder within the root directory of the repository. Each results folder will have a timestamp, allowing you to easily track and compare different runs.

docker run \
      -v /var/run/docker.sock:/var/run/docker.sock \
      -v ./results:/app/results \
      typeevalpy

๐Ÿ”ง Optionally, run analysis on specific tools:

docker run \
      -v /var/run/docker.sock:/var/run/docker.sock \
      -v ./results:/app/results \
      typeevalpy --runners headergen scalpel

๐Ÿ› ๏ธ Available options: headergen, pyright, scalpel, jedi, hityper, type4py, hityperdl


Running From Source...

1. ๐Ÿ“ฅ Installation

  1. Clone the repo

    git clone https://github.com/ashwinprasadme/TypeEvalPy.git
  2. Install Dependencies and Set Up Virtual Environment

    Run the following commands to set up your virtual environment and activate the virtual environment.

    python3 -m venv .env
    source .env/bin/activate
    pip install -r requirements.txt

2. ๐Ÿš€ Usage: Running the Analysis

  1. Navigate to the src Directory

    cd src
  2. Execute the Analyzer

    Run the following command to start the benchmarking process on all tools:

    python main_runner.py

    or

    Run analysis on specific tools

    python main_runner.py --runners headergen scalpel
    

๐Ÿค Contributing

Thank you for your interest in contributing! To add support for a new tool, please utilize the Docker templates provided in our repository. After implementing and testing your tool, please submit a pull request (PR) with a descriptive message. Our maintainers will review your submission, and merge them.


โญ๏ธ Show Your Support

Give a โญ๏ธ if this project helped you!

typeevalpy's People

Contributors

samzcodez avatar ashwinprasadme avatar sapkotaruz11 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.