rebranded and finetune prompts

Author: carusyte

.gitignore

@@ -2,4 +2,4 @@ out
 dist
 node_modules
 .vscode-test/
-# *.vsix
+*.vsix

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-11-13
+
+First beta release.

NOTICE

@@ -0,0 +1,10 @@
+# Notice @2023-11-10, author of GAI-Choy
+
+This work is based off of the Apache 2.0 licensed project https://github.com/WisdomShell/codeshell-vscode
+
+Major modification includes:
+
+- Add support for Azure OpenAI service integration
+- Enhancements and bugfixes
+- Tweaked appearances of the UI
+- Rebranding of the extension

README.md

@@ -1,170 +1,121 @@
-# CodeShell VSCode Extension
+# GAI Choy VSCode Extension
 
-[![English readme](https://img.shields.io/badge/README-English-blue)](README_EN.md)
+GAI Choy stands for G̲enerative A̲I̲ empowered, C̲ode H̲elper O̲n Y̲our side.
 
-`codeshell-vscode`项目是基于[CodeShell大模型](https://github.com/WisdomShell/codeshell)开发的支持[Visual Studio Code](https://code.visualstudio.com/Download)的智能编码助手插件，支持python、java、c++/c、javascript、go等多种编程语言，为开发者提供代码补全、代码解释、代码优化、注释生成、对话问答等功能，旨在通过智能化的方式帮助开发者提高编程效率。
+Gai Choy, also known as Chinese mustard greens, is a type of leafy vegetable having a distinct, pungent flavor that is often described as spicy, slightly bitter, or peppery. Its strong flavor makes it a popular choice for adding depth and complexity to a variety of dishes. Despite its toughness, it becomes tender and more palatable when cooked, making it a versatile ingredient in the kitchen.
 
-## 环境要求
+<p align="center"><img src="assets/logo.png"></p>
 
-- [node](https://nodejs.org/en)版本v18及以上
-- Visual Studio Code版本要求 1.68.1 及以上
-- [CodeShell 模型服务](https://github.com/WisdomShell/llama_cpp_for_codeshell)已启动
+This project is forked from [codeshell-vscode](https://github.com/WisdomShell/codeshell-vscode), with additional support for Azure OpenAI (AOAI) service integration and a couple of other enhancements. See [NOTICE](NOTICE) for more details.
 
-## 编译插件
+The `GAI Choy` project is an open-source plugin developed based on the [CodeShell LLM](https://github.com/WisdomShell/codeshell) and Azure OpenAI service that supports [Visual Studio Code](https://code.visualstudio.com/Download). It serves as an intelligent coding assistant, offering support for various programming languages such as Python, Java, C/C++, JavaScript, Go, and more. This plugin provides features like code completion, code interpretation, code optimization, comment generation, and conversational Q&A to help developers enhance their coding efficiency in an intelligent manner.
 
-如果要从源码进行打包，需要安装 `node` v18 以上版本，并执行以下命令：
+## Why another extension for AOAI?
 
-```zsh
-git clone https://github.com/WisdomShell/codeshell-vscode.git
-cd codeshell-vscode
-npm install
-npm exec vsce package
-```
-
-然后会得到一个名为`codeshell-vscode-${VERSION_NAME}.vsix`的文件。
-
-##  模型服务
-
-[`llama_cpp_for_codeshell`](https://github.com/WisdomShell/llama_cpp_for_codeshell)项目提供[CodeShell大模型](https://github.com/WisdomShell/codeshell) 4bits量化后的模型，模型名称为`codeshell-chat-q4_0.gguf`。以下为部署模型服务步骤：
-
-### 编译代码
-
-+ Linux / Mac(Apple Silicon设备)
-
-  ```bash
-  git clone https://github.com/WisdomShell/llama_cpp_for_codeshell.git
-  cd llama_cpp_for_codeshell
-  make
-  ```
-
-  在 macOS 上，默认情况下启用了Metal，启用Metal可以将模型加载到 GPU 上运行，从而显著提升性能。
-
-+ Mac(非Apple Silicon设备)
-
-  ```bash
-  git clone https://github.com/WisdomShell/llama_cpp_for_codeshell.git
-  cd llama_cpp_for_codeshell
-  LLAMA_NO_METAL=1 make
-  ```
-
-  对于非 Apple Silicon 芯片的 Mac 用户，在编译时可以使用 `LLAMA_NO_METAL=1` 或 `LLAMA_METAL=OFF` 的 CMake 选项来禁用Metal构建，从而使模型正常运行。
-
-+ Windows
-
-  您可以选择在[Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about)中按照Linux的方法编译代码，也可以选择参考[llama.cpp仓库](https://github.com/ggerganov/llama.cpp#build)中的方法，配置好[w64devkit](https://github.com/skeeto/w64devkit/releases)后再按照Linux的方法编译。
+Here's an exhuastive list of extensions I tried:
 
-### 下载模型
+- [openai-vscode](https://marketplace.visualstudio.com/items?itemName=AndrewButson.vscode-openai)
+  - No code-completion feature
+  - Does not seem to support [clustered AOAI setup behind Azure Application Gateway](https://github.com/denlai-mshk/aoai-fwdproxy-funcapp)
+  - Not open sourced
+- [Code GPT](https://marketplace.visualstudio.com/items?itemName=DanielSanMedium.dscodegpt)
+  - Similar to the above. Although it provides audo-code-completion feature, the supported model is limited without plus-subscription.
+  <img src="assets/codegpt_autocomplete_provider.png" width="60%" height="60%"/>
 
-在[Hugging Face Hub](https://huggingface.co/WisdomShell)上，我们提供了三种不同的模型，分别是[CodeShell-7B](https://huggingface.co/WisdomShell/CodeShell-7B)、[CodeShell-7B-Chat](https://huggingface.co/WisdomShell/CodeShell-7B-Chat)和[CodeShell-7B-Chat-int4](https://huggingface.co/WisdomShell/CodeShell-7B-Chat-int4)。以下是下载模型的步骤。
+## Requirements
 
-- 使用[CodeShell-7B-Chat-int4](https://huggingface.co/WisdomShell/CodeShell-7B-Chat-int4)模型推理，将模型下载到本地后并放置在以上代码中的 `llama_cpp_for_codeshell/models` 文件夹的路径
+- [node](https://nodejs.org/en) version v18 and above
+- Visual Studio Code version 1.68.1 and above
+- The [CodeShell](https://github.com/WisdomShell/llama_cpp_for_codeshell) service is running (not required for AOAI integration)
 
- ```
- git clone https://huggingface.co/WisdomShell/CodeShell-7B-Chat-int4/blob/main/codeshell-chat-q4_0.gguf
- ```
+## Compile the Plugin
 
-- 使用[CodeShell-7B](https://huggingface.co/WisdomShell/CodeShell-7B)、[CodeShell-7B-Chat](https://huggingface.co/WisdomShell/CodeShell-7B-Chat)推理，将模型放置在本地文件夹后，使用[TGI](https://github.com/WisdomShell/text-generation-inference.git)加载本地模型，启动模型服务
+If you want to run the package from source code, you need to execute the following command:
 
-```bash
-git clone https://huggingface.co/WisdomShell/CodeShell-7B-Chat
-git clone https://huggingface.co/WisdomShell/CodeShell-7B
-```
-
-### 加载模型
-
-- `CodeShell-7B-Chat-int4`模型使用`llama_cpp_for_codeshell`项目中的`server`命令即可提供API服务
-
-```bash
-./server -m ./models/codeshell-chat-q4_0.gguf --host 127.0.0.1 --port 8080
+```zsh
+git clone https://github.com/carusyte/GAI-Choy.git
+cd GAI-Choy
+npm install
+npm exec vsce package
 ```
 
-注意：对于编译时启用了 Metal 的情况下，若运行时出现异常，您也可以在命令行添加参数 `-ngl 0 `显式地禁用Metal GPU推理，从而使模型正常运行。
-
-- [CodeShell-7B](https://huggingface.co/WisdomShell/CodeShell-7B)和[CodeShell-7B-Chat](https://huggingface.co/WisdomShell/CodeShell-7B-Chat)模型，使用[TGI](https://github.com/WisdomShell/text-generation-inference.git)加载本地模型，启动模型服务
+and it will create a visx package file like: `gai-choy-${VERSION_NAME}.vsix`。
 
-## 模型服务[NVIDIA GPU]
+## Model Service
 
-对于希望使用NVIDIA GPU进行推理的用户，可以使用[`text-generation-inference`](https://github.com/huggingface/text-generation-inference)项目部署[CodeShell大模型](https://github.com/WisdomShell/codeshell)。以下为部署模型服务步骤：
+### Azure OpenAI (AOAI) service
 
-### 下载模型
+The [AOAI service](https://azure.microsoft.com/en-us/products/ai-services/openai-service) setup varies depending on how your cloud infrastructure is designed and implemented. Here's [how-to article](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource) to get you started. For more production-grade setup you may consult cloud architect, engineer or SRE.
 
-在 [Hugging Face Hub](https://huggingface.co/WisdomShell/CodeShell-7B-Chat)将模型下载到本地后，将模型放置在 `$HOME/models` 文件夹的路径下，即可从本地加载模型。
+### CodeShell model
 
-```bash
-git clone https://huggingface.co/WisdomShell/CodeShell-7B-Chat
-```
-
-### 部署模型
-
-使用以下命令即可用text-generation-inference进行GPU加速推理部署：
-
-```bash
-docker run --gpus 'all' --shm-size 1g -p 9090:80 -v $HOME/models:/data \
-        --env LOG_LEVEL="info,text_generation_router=debug" \
-        ghcr.nju.edu.cn/huggingface/text-generation-inference:1.0.3 \
-        --model-id /data/CodeShell-7B-Chat --num-shard 1 \
-        --max-total-tokens 5000 --max-input-length 4096 \
-        --max-stop-sequences 12 --trust-remote-code
-```
-
-更详细的参数说明请参考[text-generation-inference项目文档](https://github.com/huggingface/text-generation-inference)。
+Note that this step is not required for AOAI integration. Please refer to [source repo's README.md](https://github.com/WisdomShell/codeshell-vscode/blob/main/README_EN.md#model-service) for details.
 
+## Configure the Plugin
 
-## 配置插件
+- Set the address for the CodeShell / AOAI service
+- Configure whether to enable automatic code completion suggestions
+- Set the time delay for triggering automatic code completion suggestions
+- Specify the maximum number of tokens for code completion
+- Specify the maximum number of tokens for Q&A
+- Configure the model runtime environment
 
-VSCode中执行`Install from VSIX...`命令，选择`codeshell-vscode-${VERSION_NAME}.vsix`，完成插件安装。
+Note: Different model runtime environments can be configured within the plugin. For the [CodeShell-7B-Chat-int4](https://huggingface.co/WisdomShell/CodeShell-7B-Chat-int4) model, you can choose the `CPU with llama.cpp"`option in the `Code Shell: Run Env For LLMs` menu. However, for the [CodeShell-7B](https://huggingface.co/WisdomShell/CodeShell-7B) and [CodeShell-7B-Chat](https://huggingface.co/WisdomShell/CodeShell-7B-Chat) models, you should select the `GPU with TGI toolkit` option.
 
-- 设置CodeShell大模型服务地址
-- 配置是否自动触发代码补全建议
-- 配置自动触发代码补全建议的时间延迟
-- 配置补全的最大tokens数量
-- 配置问答的最大tokens数量
-- 配置模型运行环境
+To use Azure OpenAI service as the LLM model, there're additional parameters that need to be configured:
 
-注意：不同的模型运行环境可以在插件中进行配置。对于[CodeShell-7B-Chat-int4](https://huggingface.co/WisdomShell/CodeShell-7B-Chat-int4)模型，您可以在`Code Shell: Run Env For LLMs`选项中选择`CPU with llama.cpp`选项。而对于[CodeShell-7B](https://huggingface.co/WisdomShell/CodeShell-7B)和[CodeShell-7B-Chat](https://huggingface.co/WisdomShell/CodeShell-7B-Chat)模型，应选择`GPU with TGI toolkit`选项。
+- Chat model deployed in Azure
+- Completion model deployed in Azure
+- API Key
+- API version
 
-![插件配置截图](https://resource.zsmarter.cn/appdata/codeshell-vscode/screenshots/docs_settings_new.png)
+<img src="assets/settings.png" width="60%" height="60%" />
 
-## 功能特性
+## Features
 
-### 1. 代码补全
+### 1. Code Completion
 
-- 自动触发代码建议
-- 热键触发代码建议
+- Automatic Code Suggestions
+- Keyboard Shortcut for Code Suggestions
 
-在编码过程中，当停止输入时，代码补全建议可自动触发（在配置选项`Auto Completion Delay`中可设置为1~3秒），或者您也可以主动触发代码补全建议，使用快捷键`Alt+\`（对于`Windows`电脑）或`option+\`（对于`Mac`电脑）。
+During the coding process, code completion suggestions can automatically trigger when you pause input (configurable with the `Auto Completion Delay` option, set to 1-3 seconds). Alternatively, you can manually trigger code completion suggestions using the shortcut key `Alt+\` (for Windows) or `Option+\` (for Mac).
 
-当插件提供代码建议时，建议内容以灰色显示在编辑器光标位置，您可以按下Tab键来接受该建议，或者继续输入以忽略该建议。
+When the plugin provides code suggestions, the suggested content appears in gray at the editor's cursor position. You can press the Tab key to accept the suggestion or continue typing to ignore it.
 
 ![代码建议截图](https://resource.zsmarter.cn/appdata/codeshell-vscode/screenshots/docs_completion.png)
 
-### 2. 代码辅助
+### 2. Code Assistance
 
-- 对一段代码进行解释/优化/清理
-- 为一段代码生成注释/单元测试
-- 检查一段代码是否存在性能/安全性问题
+- Explain/Optimize/Cleanse a Code Segment
+- Generate Comments/Unit Tests for Code
+- Check Code for Performance/Security Issues
 
-在vscode侧边栏中打开插件问答界面，在编辑器中选中一段代码，在鼠标右键CodeShell菜单中选择对应的功能项，插件将在问答界面中给出相应的答复。
+In the VSCode sidebar, open the plugin's Q&A interface. Select a portion of code in the editor, right-click to access the CodeShell menu, and choose the corresponding function. The plugin will provide relevant responses in the Q&A interface.
 
 ![代码辅助截图](https://resource.zsmarter.cn/appdata/codeshell-vscode/screenshots/docs_assistants.png)
 
-### 3. 智能问答
+### 3. Code Q&A
 
-- 支持多轮对话
-- 支持会话历史
-- 基于历史会话（做为上文）进行多轮对话
-- 可编辑问题，重新提问
-- 对任一问题，可重新获取回答
-- 在回答过程中，可以打断
+- Support for Multi-turn Conversations
+- Maintain Conversation History
+- Engage in Multi-turn Dialogues Based on Previous Conversations
+- Edit Questions and Rephrase Inquiries
+- Request Fresh Responses for Any Question
+- Interrupt During the Answering Process
 
 ![智能问答截图](https://resource.zsmarter.cn/appdata/codeshell-vscode/screenshots/docs_chat.png)
 
-在问答界面的代码块中，可以点击复制按钮复制该代码块，也可点击插入按钮将该代码块内容插入到编辑器光标处。
+Within the Q&A interface's code block, you can click the copy button to copy the code block or use the insert button to insert the code block's content at the editor's cursor location.
 
-## 开源协议
+## License
 
 Apache 2.0
 
+## Attribution
+
+- [Illustration Vectors by Vecteezy](https://www.vecteezy.com/free-vector/illustration)
+- [Mustard greens by iconnut from Noun Project (CC BY 3.0)](https://thenounproject.com/browse/icons/term/mustard-greens/)
+
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=WisdomShell/codeshell-vscode&type=Date)](https://star-history.com/#WisdomShell/codeshell-vscode&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=carusyte/GAI-Choy.git&type=Date)](https://star-history.com/#carusyte/GAI-Choy.git&Date)