Giter VIP home page Giter VIP logo

mfernandez4 / twinny Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rjmacarthy/twinny

0.0 0.0 0.0 1.87 MB

The most no-nonsense locally hosted (or API hosted) AI code completion plugin for Visual Studio Code, like GitHub Copilot but 100% free and 100% private.

Home Page: https://marketplace.visualstudio.com/items?itemName=rjmacarthy.twinny

License: MIT License

JavaScript 1.49% TypeScript 78.90% CSS 19.61%

twinny's Introduction

twinny

Are you fed up of all of those so called "free" Copilot alternatives with paywalls and signups? Fear not my developer friend!

Twinny is the most no-nonsense locally hosted (or api hosted) AI code completion plugin for Visual Studio Code and any compatible editors (like VSCodium) designed to work seamlessly with:

Like Github Copilot but 100% free and private.

Install twinny on the
Visual Studio Code extension marketplace

Main features

Fill in the middle code completion

Get AI based suggestions in real time. While coding you can let twinny autocomplete the code as you are typing.

Chat with AI about your code

Through the side bar, have a conversation with your model and get explanations about a function, ask it to write tests, ask for a refactor and much more.

Other features

  • Single or multiline fill-in-middle completions
  • Customisable prompt templates to add context to completions
  • Easy installation via vscode extensions marketplace or by downloading and running a binary directly
  • Customisable settings to change API provider, model name, port number and path
  • Ollama, llamacpp, oobabooga and LM Studio API compatible
  • Accept code solutions directly to editor
  • Create new documents from code blocks
  • Copy generated code solution blocks
  • Chat history preserved per workspace

๐Ÿš€ Getting Started

With Ollama

  1. Install the VS code extension link (or if VSCodium)
  2. Install ollama
  3. Choose your model from the library (eg: codellama:7b)
ollama run codellama:7b
  1. Open VS code (if already open a restart might be needed) and press ctr + shift + T to open the side panel.

You should see the ๐Ÿค– icon indicating that twinny is ready to use.

  1. See Keyboard shortcuts to start using while coding ๐ŸŽ‰

With llama.cpp / LM Studio / Oobabooga

  1. Install the VS code extension link (or if VSCodium)

  2. Get llama.cpp / LM Studio / Oobabooga

  3. Download and run the model locally using the chosen provider

  4. Open VS code (if already open a restart might be needed) and press ctr + shift + T to open the side panel.

  5. From the top โš™๏ธ icon open the settings page and in the Api Provider panel change from ollama to llamacpp (or others respectively).

  6. In the left panel you should see the ๐Ÿค– icon indicating that twinny is ready to use.

  7. See Keyboard shortcuts to start using while coding ๐ŸŽ‰

With other providers

Twinny supports the OpenAI API specification so in theory any provider should work as long as it supports the specification.

If you find that isn't the case please open an issue with details of how you are having problems.

Note!

When choosing an API provider the port and API path names will be updated automatically based on the provider you choose to use. These options can also be set manually.

The option for chat model name and fim model name are only applicable to Ollama and Oobabooga providers.

Model support

Twinny works with any model as long as it can run on your machine and it exposes a OpenAI API compliant endpoint.

Choosing a model is influenced a lot by the machine it will be running, a smaller model will give you a faster response but with a loss in accuracy.

There are two functionalities that twinny are expecting from a model:

Models for Chat

Among LLM models, there are models called "instruct models", which are designed for a question & answer mode of chat.

All instruct models should work for chat generations, but the templates might need editing if using something other than codellama (they need to be updated with the special tokens).

  • For computers with a good GPU, use: deepseek-coder:6.7b-base-q5_K_M (or any other good instruct model).

Models for FIM (fill in the middle) completions

For FIM completions, you need to use LLM models called "base models". Unlike instruct models, base models will only try to complete your prompt. They are not designed to answer questions.

If using Llama the model must support the Llama special tokens.

  • For computers with a good GPU, use: deepseek-coder:base or codellama-code (or any other good model that is optimised for code completions).
  • For slower computers or computers using only CPU, use stable-code:3b-code-q4_0 (or any other small base model).

Keyboard shortcuts

Shortcut Description
ALT+\ Trigger inline code completion
CTRL+SHIFT+/ Stop the inline code generation
Tab Accept the inline code generated
CTRL+SHIFT+t Open twinny sidebar

Workspace context

In the settings there is an option called useFileContext this will keep track of sessions, keystrokes, visits and recency of visited files in the current workspace. This can be enabled to help improve the quality of completions, it's turned off by default but I'm considering turning this on by default in the next release.

Known issues

  • If the server settings are incorrectly set chat and fim completion will not work, if this is the case please open an issue with your error message.
  • Sometimes a restart of vscode is required for new settings to take effect, please open an issue if you are having problems with this.
  • Using file context often causes unreliable completions for FIM because small models get confused when provided with more than one file context.
  • See open issues on github to see any known issues that are not yet fixed.

If you have a problem with Twinny or have any suggestions please report them on github issues. Please include your vscode version and OS details in your issue.

Contributing

We are actively looking for contributors who want to help improve the project, if you are interested in helping out please reach out on twitter.

Contributions are welcome please open an issue describing your changes and open a pull request when ready.

This project is under MIT licence, please read the LICENSE file for more information.

Disclaimer

This plugin is provided "as is" and is under active development. This means that at times it may not work fully as expected.

twinny's People

Contributors

rjmacarthy avatar antonkrug avatar allen-li1231 avatar badetitou avatar pacman100 avatar kha84 avatar winniep avatar onel avatar bnorick avatar nav9 avatar sbeardsley avatar oxaronick 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.