mirror of
https://github.com/Palm1r/QodeAssist.git
synced 2025-05-28 03:10:28 -04:00
Change configure part in description
- Replace codellama to qwen models - Add prefer auto template for ollama provider
This commit is contained in:
parent
4f2dc0c450
commit
50087aa744
52
README.md
52
README.md
@ -29,8 +29,8 @@ QodeAssist is an AI-powered coding assistant plugin for Qt Creator. It provides
|
|||||||
- Side and Bottom panels
|
- Side and Bottom panels
|
||||||
- Support for multiple LLM providers:
|
- Support for multiple LLM providers:
|
||||||
- Ollama
|
- Ollama
|
||||||
- LM Studio
|
- LM Studio (experimental)
|
||||||
- OpenAI-compatible local providers
|
- OpenAI-compatible providers (experimental)
|
||||||
- Extensive library of model-specific templates
|
- Extensive library of model-specific templates
|
||||||
- Custom template support
|
- Custom template support
|
||||||
- Easy configuration and model selection
|
- Easy configuration and model selection
|
||||||
@ -56,13 +56,17 @@ QodeAssist is an AI-powered coding assistant plugin for Qt Creator. It provides
|
|||||||
2. Install [Ollama](https://ollama.com). Make sure to review the system requirements before installation.
|
2. Install [Ollama](https://ollama.com). Make sure to review the system requirements before installation.
|
||||||
3. Install a language models in Ollama via terminal. For example, you can run:
|
3. Install a language models in Ollama via terminal. For example, you can run:
|
||||||
|
|
||||||
For suggestions:
|
For standard computers (minimum 8GB RAM):
|
||||||
```
|
```
|
||||||
ollama run codellama:7b-code
|
ollama run qwen2.5-coder:7b
|
||||||
```
|
```
|
||||||
For chat:
|
For better performance (16GB+ RAM):
|
||||||
```
|
```
|
||||||
ollama run codellama:7b-instruct
|
ollama run qwen2.5-coder:14b
|
||||||
|
```
|
||||||
|
For high-end systems (32GB+ RAM):
|
||||||
|
```
|
||||||
|
ollama run qwen2.5-coder:32b
|
||||||
```
|
```
|
||||||
4. Download the QodeAssist plugin for your QtCreator.
|
4. Download the QodeAssist plugin for your QtCreator.
|
||||||
5. Launch Qt Creator and install the plugin:
|
5. Launch Qt Creator and install the plugin:
|
||||||
@ -73,38 +77,32 @@ ollama run codellama:7b-instruct
|
|||||||
|
|
||||||
## Configure Plugin
|
## Configure Plugin
|
||||||
|
|
||||||
<details>
|
QodeAssist comes with default settings that should work immediately after installing a language model. The plugin is pre-configured to use Ollama with standard templates, so you may only need to verify the settings.
|
||||||
<summary>Configure plugins: (click to expand)</summary>
|
|
||||||
<img src="https://github.com/user-attachments/assets/00ad980f-b470-48eb-9aaa-077783d38798" width="600" alt="Configuere QodeAssist">
|
|
||||||
</details>
|
|
||||||
|
|
||||||
1. Open Qt Creator settings
|
1. Open Qt Creator settings (Edit > Preferences on Linux/Windows, Qt Creator > Preferences on macOS)
|
||||||
2. Navigate to the "Qode Assist" tab
|
2. Navigate to the "Qode Assist" tab
|
||||||
3. Select "General" page
|
3. On the "General" page, verify:
|
||||||
4. Choose your LLM provider (e.g., Ollama)
|
- Ollama is selected as your LLM provider
|
||||||
5. Select the installed model by the "Select Model" button
|
- The URL is set to http://localhost:11434
|
||||||
- For LM Studio you will see current loaded model
|
- Your installed model appears in the model selection
|
||||||
6. Choose the prompt template that corresponds to your model
|
- The prompt template is Ollama Auto FIM
|
||||||
7. Apply the settings
|
4. Click Apply if you made any changes
|
||||||
|
|
||||||
You're all set! QodeAssist is now ready to use in Qt Creator.
|
You're all set! QodeAssist is now ready to use in Qt Creator.
|
||||||
|
|
||||||
[](https://ko-fi.com/P5P412V96G)
|
|
||||||
|
|
||||||
## Supported LLM Providers
|
## Supported LLM Providers
|
||||||
QodeAssist currently supports the following LLM (Large Language Model) providers:
|
QodeAssist currently supports the following LLM (Large Language Model) providers:
|
||||||
- [Ollama](https://ollama.com)
|
- [Ollama](https://ollama.com)
|
||||||
- [LM Studio](https://lmstudio.ai)
|
- [LM Studio](https://lmstudio.ai) (experimental)
|
||||||
- OpenAI compatible providers
|
- OpenAI compatible providers (experimental)
|
||||||
|
|
||||||
## Recommended Models:
|
## Recommended Models:
|
||||||
QodeAssist has been thoroughly tested and optimized for use with the following language models:
|
QodeAssist has been thoroughly tested and optimized for use with the following language models:
|
||||||
|
|
||||||
- Llama
|
- Qwen2.5-coder
|
||||||
- CodeLlama
|
- CodeLlama
|
||||||
- StarCoder2
|
- StarCoder2
|
||||||
- DeepSeek-Coder-V2
|
- DeepSeek-Coder-V2
|
||||||
- Qwen-2.5
|
|
||||||
|
|
||||||
### Ollama:
|
### Ollama:
|
||||||
### For autocomplete(FIM)
|
### For autocomplete(FIM)
|
||||||
@ -122,13 +120,6 @@ ollama run qwen2.5-coder:7b-instruct
|
|||||||
ollama run deepseek-coder-v2
|
ollama run deepseek-coder-v2
|
||||||
```
|
```
|
||||||
|
|
||||||
### LM Studio:
|
|
||||||
similar models, like for ollama
|
|
||||||
|
|
||||||
Please note that while these models have been specifically tested and confirmed to work well with QodeAssist, other models compatible with the supported providers may also work. We encourage users to experiment with different models and report their experiences.
|
|
||||||
|
|
||||||
If you've successfully used a model that's not listed here, please let us know by opening an issue or submitting a pull request to update this list.
|
|
||||||
|
|
||||||
## QtCreator Version Compatibility
|
## QtCreator Version Compatibility
|
||||||
|
|
||||||
- QtCreator 14.0.2 - 0.2.3 - 0.3.x
|
- QtCreator 14.0.2 - 0.2.3 - 0.3.x
|
||||||
@ -191,7 +182,6 @@ If you find QodeAssist helpful, there are several ways you can support the proje
|
|||||||
3. **Spread the Word**: Star our GitHub repository and share QodeAssist with your fellow developers.
|
3. **Spread the Word**: Star our GitHub repository and share QodeAssist with your fellow developers.
|
||||||
|
|
||||||
4. **Financial Support**: If you'd like to support the development financially, you can make a donation using one of the following:
|
4. **Financial Support**: If you'd like to support the development financially, you can make a donation using one of the following:
|
||||||
- [](https://ko-fi.com/P5P412V96G)
|
|
||||||
- Bitcoin (BTC): `bc1qndq7f0mpnlya48vk7kugvyqj5w89xrg4wzg68t`
|
- Bitcoin (BTC): `bc1qndq7f0mpnlya48vk7kugvyqj5w89xrg4wzg68t`
|
||||||
- Ethereum (ETH): `0xA5e8c37c94b24e25F9f1f292a01AF55F03099D8D`
|
- Ethereum (ETH): `0xA5e8c37c94b24e25F9f1f292a01AF55F03099D8D`
|
||||||
- Litecoin (LTC): `ltc1qlrxnk30s2pcjchzx4qrxvdjt5gzuervy5mv0vy`
|
- Litecoin (LTC): `ltc1qlrxnk30s2pcjchzx4qrxvdjt5gzuervy5mv0vy`
|
||||||
|
@ -66,7 +66,7 @@ GeneralSettings::GeneralSettings()
|
|||||||
ccProvider.setReadOnly(true);
|
ccProvider.setReadOnly(true);
|
||||||
ccSelectProvider.m_buttonText = TrConstants::SELECT;
|
ccSelectProvider.m_buttonText = TrConstants::SELECT;
|
||||||
|
|
||||||
initStringAspect(ccModel, Constants::CC_MODEL, TrConstants::MODEL, "codellama:7b-code");
|
initStringAspect(ccModel, Constants::CC_MODEL, TrConstants::MODEL, "qwen2.5-coder:7b");
|
||||||
ccModel.setHistoryCompleter(Constants::CC_MODEL_HISTORY);
|
ccModel.setHistoryCompleter(Constants::CC_MODEL_HISTORY);
|
||||||
ccSelectModel.m_buttonText = TrConstants::SELECT;
|
ccSelectModel.m_buttonText = TrConstants::SELECT;
|
||||||
|
|
||||||
@ -87,7 +87,7 @@ GeneralSettings::GeneralSettings()
|
|||||||
caProvider.setReadOnly(true);
|
caProvider.setReadOnly(true);
|
||||||
caSelectProvider.m_buttonText = TrConstants::SELECT;
|
caSelectProvider.m_buttonText = TrConstants::SELECT;
|
||||||
|
|
||||||
initStringAspect(caModel, Constants::CA_MODEL, TrConstants::MODEL, "codellama:7b-instruct");
|
initStringAspect(caModel, Constants::CA_MODEL, TrConstants::MODEL, "qwen2.5-coder:7b");
|
||||||
caModel.setHistoryCompleter(Constants::CA_MODEL_HISTORY);
|
caModel.setHistoryCompleter(Constants::CA_MODEL_HISTORY);
|
||||||
caSelectModel.m_buttonText = TrConstants::SELECT;
|
caSelectModel.m_buttonText = TrConstants::SELECT;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user