Lamner Comment Generator README

This extension interfaces with a server-based AI model that returns a text comment describing a function passed to the model as a parameter.

This extension utilizes Rishab Sharma's machine learning model. Nathan Nesbitt built the client-side server application, which uses Rishab Sharma's model. Finally, Guy Kaminsky made the Visual Studio Code extension with the help of Rocco Ruscitti and published it to the visual studio marketplace.

The extension is an academic project which is not consistently maintained. It is currently in a beta-testing state.

Comments are generated using a locally run server and are not sent anywhere external.
 

Disclaimers

• Only works for Java files.
• Only works on Windows.
• The Lamner Model server is installed onto C:/Users/$USER/Appdata/Local.
   

Features

• Currently produces one function level comment for a singly selected Java function per execution

• Presents the user with an in-text preview with a continue/cancel prompt

Use the keyboard combination of  CTRL + ALT + ; to generate the comment

Requirements

Please have Git installed on to the system PATH, you can refer to the following website for reference.

Please have Python installed on to the system PATH, you can refer to the following website for reference.
 

Usage

1. Make sure to follow the Requirements section to properly run the server to load in the lamner model.
2. Run the following command Lamner: Install Server through the VSCode command palette (only need to do it once after the extension is first installed).
3. Next, run the following command Lamner: Run Server through the VSCode command palette.
4. Now you can select your desired functions, and use the keyboard shortcut to find the generated comment.
5. To shutdown the server you can either:
   • Close the VSCode edtior.
   • Click the 'trash bin' icon on the terminal.
   • Enter CTRL + C on the terminal.
   • Or simply run the Lamner: Shutdown Server command through the VSCode command palette.
      

Extension Settings, Commands

This extension contributes the following palette commands:

• 'vsgencomments.insertComment': executes the model using the currently selected text.
• 'vsgencomments.install': clones the lamner model to the user's local machine.
• 'vsgencomments.run': runs the lamner model.
• 'vsgencomments.shutdown': disposes of the terminal instance which runs the lamner model.
   

General Issues

No known issues to date.
 

Security Issues

We are not aware of any security issues. The server is run locally using an open source machine learning model, but this extension project does not maintain that code repository, thus we cannot guarantee changes to that code will may compromise security. See the following section for a link to the server model's repository.
 

Lamner Model

The following link will lead to the model that is installed in this extension.
 

Release Notes

1.0.2

Initial development release of Lamner Comment Generator.