Skip to content

Commit 99bf65c

Browse files
committed
Updated README
1 parent 3c33d47 commit 99bf65c

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ LangChain Coder AI is a state-of-the-art code generation tool powered by OpenAI
2222
- **Save and Execute Code**: Provides options to save the generated code and execute it instantly.
2323
- **Coding Guidelines**: Ensures the generated code adheres to standards like modularity, exception handling, error handling, logging, comments, efficiency, robustness, memory management, speed optimization, and naming conventions.
2424
- **Advanced Code Editor**: Customize your coding experience with features like adjustable font size, tab size, themes, keybindings, line numbers, print margins, wrapping, auto-updates, read-only mode, and language selection.
25-
- **Customizable Vertex AI Settings**: Adjust settings like temperature, max tokens, model name, project, region, and credentials file for Vertex AI.
25+
- **Customizable Settings**: Adjust settings like temperature, max tokens, model name, project, region, and credentials file for Vertex AI.
2626
- **Offline and Online Compilation Modes**: Choose between offline and online compiler modes for code execution.
2727

2828
## AI-Sections.
@@ -31,7 +31,7 @@ LangChain Coder AI is a state-of-the-art code generation tool powered by OpenAI
3131
- **Model Selection**: Choose from a variety of models including GPT 3.5, GPT 3.5 Turbo, and the latest GPT 4.
3232

3333
### 🌐 Vertex AI
34-
- **Customizable Settings**: Fine-tune Tokens, Temperature, and set your API Key in the settings.
34+
- **Customizable Settings**: Fine-tune Tokens, Temperature, and set your Credentials Key in the settings.
3535
- **Model Selection**: Opt for models like **Code Gecko** for completions and **Code Bison** for code generation. These models are designed to support code completion and generation, enhancing your coding experience.
3636

3737

@@ -43,12 +43,41 @@ LangChain Coder AI is a state-of-the-art code generation tool powered by OpenAI
4343
🎨 Behold the canvas after the masterpiece is painted. Code generation was never this beautiful.</br>
4444
![generated_code_ui](https://github.com/haseeb-heaven/LangChain-CoderAI/blob/master/resources/langchain-code-ui.png?raw=true "")
4545

46+
## OpenAI Integration
47+
LangChain Coder AI integrates with [OpenAI](https://openai.com/) to leverage its powerful machine learning models for code generation. OpenAI is an AI research and deployment company that aims to ensure that artificial general intelligence (AGI) benefits all of humanity. For more details on how LangChain integrates with OpenAI, refer to the [official documentation](https://python.langchain.com/docs/integrations/providers/openai).
48+
49+
You need Open AI API **Key** to use LangChain Coder AI. To get your key, follow these steps:
50+
### Get OpenAI API key
51+
52+
1. Go to the [OpenAI website](https://beta.openai.com/signup/).
53+
2. Fill out the form with your information and click “Create Account”.
54+
3. Once you are logged in, click on “API Keys” in the left-hand menu.
55+
4. Click on “Generate New Key” to create a new API key.
56+
5. Copy your API key – we will use it later in our Python code.
57+
4658
## Vertex AI Integration
4759

4860
LangChain Coder AI integrates with [Google Vertex AI](https://cloud.google.com/python/docs/reference/aiplatform/latest) to leverage its powerful machine learning models for code generation. Vertex AI offers a range of tools and services for ML and AI, and LangChain Coder AI taps into these resources to provide top-notch code suggestions. For more details on how LangChain integrates with Vertex AI, refer to the [official documentation](https://python.langchain.com/docs/integrations/llms/google_vertex_ai_palm).
4961

5062
Additionally, the Vertex AI SDK for Python allows for automation of data ingestion, model training, and predictions on Vertex AI. It provides a programmatic way to access most of the functionalities available in the Google Cloud console. For more information, check out the [Vertex AI SDK for Python](https://cloud.google.com/vertex-ai/docs/python-sdk/use-vertex-ai-python-sdk).
5163

64+
You need Google Vertex **Service Account Credentials** to use LangChain Coder AI. To get your credentials, follow these steps:
65+
66+
### Credentials for Google Vertex AI Service account and download JSON file
67+
68+
1. Go to the [Google Cloud Platform Console](https://console.cloud.google.com/).
69+
2. Click the **Menu** button (three horizontal lines) in the top left corner of the page.
70+
3. Select **IAM & Admin** > **Service accounts**.
71+
4. Click the **Create Service Account** button.
72+
5. In the **Service account name** field, enter a name for your service account.
73+
6. Select the **Editor** role for the service account.
74+
7. Click the **Create** button.
75+
8. Click the **Keys** tab.
76+
9. Click the **Add Key** button.
77+
10. Select **JSON** as the key type.
78+
11. Click the **Create** button.
79+
80+
5281
## 📸 Image Showcase
5382
**__Main Screen UI__**
5483
*The main screen of the application.*
@@ -61,7 +90,7 @@ Additionally, the Vertex AI SDK for Python allows for automation of data ingesti
6190
</br>
6291

6392
**__API Rates__**
64-
*Shows the API rates for LangChain Coder AI.*
93+
*Shows the API rates for OpenAi and Vertex AI.*
6594
![langchain-api-rates](https://github.com/haseeb-heaven/LangChain-Coder/blob/master/resources/langchain-api-rates.png?raw=true "")
6695
</br>
6796

0 commit comments

Comments
 (0)