README.md

Function Name Analyzer

This analyzer applies a translation model from function identifiers to function names.

Installation

1. Install PyTorch 0.4 with the CUDA option that suits your setup

2. Install the dependencies

    pip install -r requirements.txt
   

3. Install the package

    pip install -e .
   

4. Install babelfish with java driver. Use v1.2.6 for the version of the drivers. For example

    docker run -d --privileged -p 9432:9432 --name bblfshd bblfsh/bblfshd
    docker exec -it bblfshd bblfshctl driver install java bblfsh/java-driver:v1.2.6
   

Usage

1. Start the babelfish server

    docker start bblfshd
   

2. Start the lookout python server

    analyzer run fna --server 0.0.0.0:2000 --db sqlite:////tmp/lookout.sqlite --fs /tmp --log-level DEBUG
   

3. Simulate a pull request with the lookout binary

    lookout review -v ipv4://localhost:2000 --to ... --from ...
   

You should take care to have java files that changed inbetween the to and from revision or the analyzer won't find any function name to run on.