Awesome

This is the source code repo for the ICLR paper LambdaNet: Probabilistic Type Inference using Graph Neural Networks. For an overview of how LambdaNet works, see our video from ICLR 2020.

This branch contains the latest improvement and features. To reproduce the results presented by the paper, please see the ICLR20 branch.

Instructions

After cloning this repo, please follow the steps below:

1. Install all the dependencies (Java, sbt, TypeScript, etc.) See the "Using Docker" section below.
   1. If you are not using docker, you will need to either set the environment variable OMP_NUM_THREADS=1 or prefix all the commands in the following step with export OMP_NUM_THREADS=1;.
2. To run pre-trained model
   1. Download the model using this link (predicts user defined type) or this link (predicts library types only). Unzip the file to a desired location.
   2. To run the model in interactive mode, which outputs (source code position, predicted type) pairs for the specified files:
      1. If not exiting, create the file configs/modelPath.txt and write the location of the model directory into it. The location should be the directory that directly contains the model.serialized file.
      2. Under project root, run sbt "runMain lambdanet.TypeInferenceService".
      3. After it finishes loading the model into memory, simply enter the directory path that contains the TypeScript files of interest. Since LambdaNet only works with TypeScript files and assumes the files follow a TypeScript project structure, if you want to run it on JavaScript files, you will need to change all file extensions to .ts.
      4. Note that in this version of LambdaNet, the model will take any existing user type annotations in the source files as part of its input and only predict types for the locations where a type annotation is missing.
3. Managing compute resources (Optional)
   • Memory: LambdaNet can be memory-hungry, especially during training. If you encountered out of memory issues, you can specify the amount of memory available to the model by creating a configs/memory.txt file, which should contain two numbers, each on a separate line. The first specifies the maximum heap size (in GB), and the second specifies the maximum off-heap size used by the native tensor library (in GB). For example, when training with 24 threads, we use 10 and 80, respectively.
   • You can set the max number of threads used by LambdaNet by creating a configs/threads.txt file, which should contain a single number. By default, LambdaNet will use half of the available threads, which is often optimal for the native tensor library.
4. To train LambdaNet from scratch
   1. Download the TypeScript projects used in our experiments and prepare the TS projects into a serialization format. This can be achieved using the main function defined in src/main/scala/lambdanet/PrepareRepos.scala. Check the source code and make sure you uncomment all the steps (Some steps may have been commented out), then run it using sbt "runMain lambdanet.PrepareRepos.
   2. Check the main defined in src/main/scala/lambdanet/train/Training.scala to adjust any training configuration to your setting (e.g., whether to predict user-defiend types, whether to predict Any), then run it using sbt "runMain lambdanet.train.Training".

The TypeScript files used for manual comparison with JSNice are put under the directory data/comparison/.

Using Docker

We also provide a Docker file to automatically download and install all the dependencies. (If on linux, you can also install the dependencies into your system by manually running the commands defined inside Dockerfile.) Here are the steps to run pre-trained LambdaNet model inside a Docker Container:

1. First, make sure you have installed Docker.

2. Put pre-trained model weights somewhere accessible to the docker instance (e.g., inside the lambdanet project root). Then config the model path following the instruction above (instruction 2.2.1).

3. Under project root, run docker build -t lambdanet:v1 . && docker run --name lambdanet --memory 14g -t -i lambdanet:v1 . (Make sure the machine you are using has enough memory for the docker run command.)

4. After the Docker container has successfully started, follow the steps described above.