Skip to main content

A simple model that learns to predict Python source code

Project description

PyPI - Python Version PyPI Status Join Slack Twitter

Python Autocomplete

The full length Python autocompletion Video and a Twitter thread describing how it works

This is a learning/demo project to show how deep learning can be used to auto complete Python code. You can experiment with LSTM and Transformer models. We also have built a simple VSCode extension to try out the trained models.

Training model: Open In Colab

Evaluating trained model: Open In Colab

It gives quite decent results by saving above 30% key strokes in most files, and close to 50% in some. We calculated key strokes saved by making a single (best) prediction and selecting it with a single key.

The dataset we use is the python code found in repos linked in Awesome-pytorch-list. We download all the repositories as zip files, extract them, remove non python files and split them randomly to build training and validation datasets.

We train a character level model without any tokenization of the source code, since it's the simplest.

Try it yourself

  1. Clone this repo
  2. Install requirements from requirements.txt
  3. Run python_autocomplete/create_dataset.py.
    • It collects repos mentioned in PyTorch awesome list
    • Downloads the zip files of the repos
    • Extract the zips
    • Remove non python files
    • Collect all python code to data/train.py and, data/eval.py
  4. Run python_autocomplete/train.py to train the model. Try changing hyper-parameters like model dimensions and number of layers.
  5. Run evaluate.py to evaluate the model.

You can also run the training notebook on Google Colab.

Open In Colab

VSCode extension

  1. Clone this repo

  2. Install requirements from requirements.txt

  3. Install npm packages

You need to have Node.JS installed

cd vscode_extension
npm install # This will install the NPM packages
  1. Start the server python_autocomplete/serve.py

  2. Open the extension project (folder) in VSCode

cd vscode_extension
code . # This will open vscode_extension in VSCode

If you don't have VSCode command line launcher start VSCode and open the project with File > Open

  1. Run the extension from VSCode
Run > Start Debugging

This will open another VSCode editor window, with the extension

  1. Create or open a python file and start editing!

Sample

Here's a sample evaluation of a trained transformer model.

Colors:

  • yellow: the token predicted is wrong and the user needs to type that character.
  • blue: the token predicted is correct and the user selects it with a special key press, such as TAB or ENTER.
  • green: autocompleted characters based on the prediction

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

labml_python_autocomplete-0.0.8.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

labml_python_autocomplete-0.0.8-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file labml_python_autocomplete-0.0.8.tar.gz.

File metadata

  • Download URL: labml_python_autocomplete-0.0.8.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for labml_python_autocomplete-0.0.8.tar.gz
Algorithm Hash digest
SHA256 d65f2b714d8b869a1ef0debe9f4996e307315ccb186b491b9795f32962f9eb70
MD5 af6e25386373e3b8c80dc1c0c8257113
BLAKE2b-256 cd0bd19a9cc30d5f5648d02b29b6974136959b77994653753756fbaf03ef708e

See more details on using hashes here.

File details

Details for the file labml_python_autocomplete-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: labml_python_autocomplete-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 27.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for labml_python_autocomplete-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6df9949bd44b6bcb0fcf10f6e17aca4d766b545a0c577334cc69460148ebf099
MD5 57ce63c039a2451dbfe98cbdbdca4239
BLAKE2b-256 bf1fe730dfb9e9072a9d3f6156738b75fe43bafeff1f56fae3ec737bb2152e9d

See more details on using hashes here.

Supported by

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