Skip to content

Commit

Permalink
1. update readme link
Browse files Browse the repository at this point in the history
2. update desc in package
  • Loading branch information
duoyw committed Jul 22, 2024
1 parent 6fb06bc commit 7cae893
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 53 deletions.
62 changes: 11 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<h3 align="center"><img src="https://github.com/alibaba/smart-vscode-extension/blob/main/images/ai-logo.png?raw=true" height="64"><br>SmartVscode: Controlling anything of Vscode by natural language</h3>
<h3 align="center"><img src="images/ai-logo-in.png" height="64"><br>SmartVscode: Controlling anything of Vscode by natural language</h3>

<div align="center">

![](https://img.shields.io/visual-studio-marketplace/v/gencay.vscode-chatgpt?color=orange&label=VS%20Code)
![](https://img.shields.io/badge/license-Apache--2.0-black")
[![](https://img.shields.io/badge/Docs-English%7C%E4%B8%AD%E6%96%87-blue?logo=markdown)](https://alibaba.github.io/app-controller/en/index.html)
[![](https://img.shields.io/badge/Docs-English%7C%E4%B8%AD%E6%96%87-blue?logo=markdown)](https://alibaba.github.io/smart-vscode-extension/en/index.html)

</div>

Expand All @@ -26,32 +26,25 @@
## Feature Video

### Tic-tac-toe Game

<!-- https://github.com/alibaba/pilotscope/assets/31238100/eef9765a-8cda-4654-a147-475ed1a13c58 -->
![game](https://github.com/alibaba/smart-vscode-extension/blob/main/images/game8x.gif?raw=true)
![game](images/game8x.gif)

### Style Changing

<!-- https://github.com/alibaba/pilotscope/assets/31238100/18480837-b90f-44d6-8c28-d5f17a4552da -->
![style](https://github.com/alibaba/smart-vscode-extension/blob/main/images/fontsize2x.gif?raw=true)
![style](images/fontsize2x.gif)

### Theme Changing

<!-- https://github.com/alibaba/pilotscope/assets/31238100/2a8cd2fd-22df-4ba0-a564-90cad6c708bb -->
![Theme Changing](https://github.com/alibaba/smart-vscode-extension/blob/main/images/theme1_8x.gif?raw=true)
![Theme Changing](images/theme1_8x.gif)


### Enable auto saving

<!-- https://github.com/alibaba/pilotscope/assets/31238100/77548e8a-2832-4770-8924-ea479646e3a8 -->
![Auto Saving](https://github.com/alibaba/smart-vscode-extension/blob/main/images/autosave2x.gif?raw=true)
![Auto Saving](images/autosave2x.gif)


## Roadmap
- More supported capabilities of Vscode to called by natural language
- Supporting streaming response for user simple question.
- Introducing user feedback for task.
- More beautiful UI view.

## How to use
To begin utilizing this extension, follow these steps:
### Installation
Expand All @@ -60,48 +53,15 @@ To begin utilizing this extension, follow these steps:
### Add Model Config
Once the extension is installed:
- Locate the chat window titled "SmartVscode" in your left sidebar, which should resemble the following:
<p align="center"><img src="https://github.com/alibaba/smart-vscode-extension/blob/main/images/image.png?raw=true" alt="alt text" width="200"/></p>
<p align="center"><img src="images/mainView.png" alt="alt text" width="200"/></p>

- Configure your model settings within the extension:
- Access the our settings by clicking "Settings" button:
- For using OpenAI, input your API key and select your preferred chat and embedding models
<p align="center"><img src="https://github.com/alibaba/smart-vscode-extension/blob/main/images/image-2.png?raw=true" alt="alt text" width="400"/></p>

- For other AI models, like qwen, you should add the model configuration directly to your settings.json file, accessible via the "Edit in settings.json" button:
- ![alt text](https://github.com/alibaba/smart-vscode-extension/blob/main/images/image-3.png?raw=true)
- All format for model config need to obey the [format](https://modelscope.github.io/agentscope/en/tutorial/203-model.html).
- A example on using setting file to configure openAI model.
- ```json
"smartVscode.chatModelConfig": {
"Lightweight": {
"model_type": "openai_chat",
"model_name": "your modelName",
"api_key": "your apiKey",
"client_args": {
"base_url": "your baseUrl"
}
},
"Advanced": {
"model_type": "openai_chat",
"model_name": "your modelName",
"api_key": "your apiKey",
"client_args": {
"base_url": "your baseUrl"
}
}
},
"smartVscode.embeddingModelConfig": {
"model_type": "openai_embedding",
"model_name": "your modelName",
"api_key": "your apiKey",
"client_args": {
"base_url": "your baseUrl"
}
}
```
<p align="center"><img src="images/modelConfig.png" alt="alt text" width="400"/></p>

## Supported Tasks
Here we provide an overview of the tasks supported by SmartVscode.
Here we provide an overview of the tasks supported by SmartVscode. More tasks will be supported quickly.


| Task | Input Example |
Expand Down Expand Up @@ -139,7 +99,7 @@ Here we provide an overview of the tasks supported by SmartVscode.
| Install | Install the extension named "python" |

## Documentation
[Documentation](https://alibaba.github.io/smart-vscode-extension) provides the comprehensive information on how to develop SmartVscode. You can refer to these documentations for an improved experience with SmartVscode.
[Documentation](https://alibaba.github.io/smart-vscode-extension/en/index.html) provides the comprehensive information on how to develop SmartVscode. You can refer to these documentations for an improved experience with SmartVscode.

## License
SmartVscode is released under Apache License 2.0.
Expand Down
Binary file removed images/image-3.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
"gpt-3.5-turbo-1106"
],
"default": "gpt-3.5-turbo-1106",
"markdownDescription": "An lightweight OpenAI models like GPT-3.5 to use for quickly response. [Documentation](https://beta.openai.com/docs/models/models). ",
"markdownDescription": "An lightweight OpenAI models like GPT-3.5 to use for simple steps in reasoning pipeline. [Documentation](https://beta.openai.com/docs/models/models). ",
"order": 3,
"enumItemLabels": [
"gpt-4-turbo",
Expand All @@ -138,7 +138,7 @@
"gpt-3.5-turbo-1106"
],
"default": "gpt-3.5-turbo-1106",
"markdownDescription": "An advanced OpenAI models like GPT-4 to use for boosting performance. [Documentation](https://beta.openai.com/docs/models/models). ",
"markdownDescription": "An advanced OpenAI models like GPT-4 for complex steps in reasoning pipeline. [Documentation](https://beta.openai.com/docs/models/models). ",
"order": 4,
"enumItemLabels": [
"gpt-4-turbo",
Expand Down

0 comments on commit 7cae893

Please sign in to comment.