vrr/ProxyAI
2
0
Fork 0
mirror of https://github.com/carlrobertoh/ProxyAI.git synced 2026-04-28 03:30:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: extract getting started guide into its own doc

Browse source
This commit is contained in:
Carl-Robert Linnupuu 2024-04-07 17:38:00 +03:00
parent 3c2d185b8a
commit 3ef9aba488
2 changed files with 87 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

86
GETTING_STARTED.md Normal file
View file

@ -0,0 +1,86 @@
## Getting Started
1. **Download the Plugin**
2. **Choose Your Preferred Service**:
a) **OpenAI** - Requires authentication via OpenAI API key.
b) **Azure** - Requires authentication via Active Directory or API key.
c) **Custom OpenAI-compatible service** - Choose between multiple different providers, such as Together, Anyscale,
Groq, Ollama and many more.
d) **Anthropic** - Requires authentication via API key.
e) **You.com** - A free, web-connected service with an optional upgrade to You⚡Pro for enhanced features.
f) **LLaMA C/C++ Port** - Recommended to have a decent computer to handle the computational requirements of running
inference.
> **Note**: Currently supported only on Linux and MacOS.
3. **Start Using the Features**
### Installation
The plugin is available from [JetBrains Marketplace][plugin-repo].
You can install it directly from your IDE via the `File | Settings/Preferences | Plugins` screen.
On the `Marketplace` tab simply search for `codegpt` and select the `CodeGPT` suggestion:
![marketplace][marketplace-img]
### OpenAI
After successful installation, configure your API key. Navigate to the plugin's settings via **File |
Settings/Preferences | Tools | CodeGPT**. Paste your OpenAI API key into the field and click `Apply/OK`.
### Azure OpenAI
For Azure OpenAI services, you'll need to input three additional fields:
- **Resource name**: The name of your Azure OpenAI Cognitive Services. It's the first part of the url you're provided to
use the service: "https://**my-resource-name**.openai.azure.com/". You can find it in your Azure Cognitive Services
page, under `Resource Management` → `Resource Management` → `Keys and Endpoints`.
- **Deployment ID**: The name of your Deployment. You can find it in the Azure AI Studio,
under `Management` → `Deployment` → `Deployment Name` column in the table.
- **API version**: The most recent non-preview version.
In addition to these, you need to input one of the two API Keys provided, found along with the `Resource Name`.
### You.com (Free)
**You.com** is a search engine that summarizes the best parts of the internet for **you**, with private ads and with
privacy options.
**You⚡Pro**
Use the **CodeGPT** coupon for a free month of unlimited GPT-4 usage.
Check out the full [feature list](https://about.you.com/hc/youpro/what-features-are-included-in-youpro/) for more
details.
### LLaMA C/C++ Port (Free, Local)
> **Note**: Currently supported only on Linux and MacOS.
The main goal of `llama.cpp` is to run the LLaMA model using 4-bit integer quantization on a MacBook.
#### Getting Started
1. **Select the Model**: Depending on your hardware capabilities, choose the appropriate model from the provided list.
Once selected, click on the `Download Model` link. A progress bar will appear, indicating the download process.
2. **Start the Server**: After successfully downloading the model, initiate the server by clicking on the `Start Server`
button. A status message will be displayed, indicating that the server is starting up.
3. **Apply Settings**: With the server running, you can now apply the settings to start using the features. Click on
the `Apply/OK` button to save your settings and start using the application.
<img alt="animated" style="max-width: 100%; width: 600px;" src="https://github.com/carlrobertoh/CodeGPT-docs/blob/main/images/llama-settings.png?raw=true" />
> **Note**: If you're already running a server and wish to configure the plugin against that, then simply select the
> port and click `Apply/OK`.
[marketplace-img]: https://github.com/carlrobertoh/CodeGPT-docs/blob/main/images/marketplace.png?raw=true
[plugin-repo]: https://plugins.jetbrains.com/plugin/21056-codegpt

73
README.md
View file

@ -84,78 +84,7 @@ CodeGPT supports a completely offline development workflow by allowing you to co
![Offline Development Support](https://github.com/carlrobertoh/CodeGPT-docs/blob/main/images/new/llama-settings.png?raw=true)
## Getting Started
1. **Download the Plugin**
2. **Choose Your Preferred Service**:
a) **OpenAI** - Requires authentication via OpenAI API key.
b) **Azure** - Requires authentication via Active Directory or API key.
c) **Custom OpenAI-compatible service** - Choose between multiple different providers, such as Together, Anyscale, Groq, Ollama and many more.
d) **Anthropic** - Requires authentication via API key.
e) **You.com** - A free, web-connected service with an optional upgrade to You⚡Pro for enhanced features.
f) **LLaMA C/C++ Port** - Recommended to have a decent computer to handle the computational requirements of running inference.
> **Note**: Currently supported only on Linux and MacOS.
3. **Start Using the Features**
### Installation
The plugin is available from [JetBrains Marketplace][plugin-repo].
You can install it directly from your IDE via the `File | Settings/Preferences | Plugins` screen.
On the `Marketplace` tab simply search for `codegpt` and select the `CodeGPT` suggestion:
![marketplace][marketplace-img]
### OpenAI
After successful installation, configure your API key. Navigate to the plugin's settings via **File | Settings/Preferences | Tools | CodeGPT**. Paste your OpenAI API key into the field and click `Apply/OK`.
### Azure OpenAI
For Azure OpenAI services, you'll need to input three additional fields:
- **Resource name**: The name of your Azure OpenAI Cognitive Services. It's the first part of the url you're provided to use the service: "https://**my-resource-name**.openai.azure.com/". You can find it in your Azure Cognitive Services page, under `Resource Management` → `Resource Management` → `Keys and Endpoints`.
- **Deployment ID**: The name of your Deployment. You can find it in the Azure AI Studio, under `Management` → `Deployment` → `Deployment Name` column in the table.
- **API version**: The most recent non-preview version.
In addition to these, you need to input one of the two API Keys provided, found along with the `Resource Name`.
### You.com (Free)
**You.com** is a search engine that summarizes the best parts of the internet for **you**, with private ads and with privacy options.
**You⚡Pro**
Use the **CodeGPT** coupon for a free month of unlimited GPT-4 usage.
Check out the full [feature list](https://about.you.com/hc/youpro/what-features-are-included-in-youpro/) for more details.
### LLaMA C/C++ Port (Free, Local)
> **Note**: Currently supported only on Linux and MacOS.
The main goal of `llama.cpp` is to run the LLaMA model using 4-bit integer quantization on a MacBook.
#### Getting Started
1. **Select the Model**: Depending on your hardware capabilities, choose the appropriate model from the provided list. Once selected, click on the `Download Model` link. A progress bar will appear, indicating the download process.
2. **Start the Server**: After successfully downloading the model, initiate the server by clicking on the `Start Server` button. A status message will be displayed, indicating that the server is starting up.
3. **Apply Settings**: With the server running, you can now apply the settings to start using the features. Click on the `Apply/OK` button to save your settings and start using the application.
<img alt="animated" style="max-width: 100%; width: 600px;" src="https://github.com/carlrobertoh/CodeGPT-docs/blob/main/images/llama-settings.png?raw=true" />
> **Note**: If you're already running a server and wish to configure the plugin against that, then simply select the port and click `Apply/OK`.
### Running locally
## Running locally
**Linux or macOS**
```shell