Skip to content

Commit

Permalink
Merge pull request #11 from haseeb-heaven/haseeb-heaven-patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Jones-HM authored Feb 27, 2024
2 parents 84e246e + ec1cea2 commit 7d1d367
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AutoBard-Coder
# Gemini-Coder
![cover_logo](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/logo.png?raw=true "")</br>
### **Hosting and Spaces:**
[![Plugin](https://img.shields.io/badge/Bard%20Coder-Repo-blue)](https://replit.com/@HaseebMir/AutoBard-Coder)
Expand All @@ -8,13 +8,13 @@
<a href="https://www.buymeacoffee.com/haseebheaven"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=haseebheaven&button_colour=40DCA5&font_colour=ffffff&font_family=Cookie&outline_colour=000000&coffee_colour=FFDD00" /></a>

## 🌟 General Information 🌟
**AutoBard-Coder** is a _code generator_ and _code interpreter_ for [Google Bard](https://bard.google.com/).🙌👩‍💻👨‍💻 It now uses the **Official** [Bard API](https://makersuite.google.com/app/apikey) provided by Google, which is safe to use. 🛡️
**Gemini-Coder** is a _code generator_ and _code interpreter_ for [Google Gemini](https://gemini.google.com/).🙌👩‍💻👨‍💻 It now uses the **Official** [Gemini API](https://makersuite.google.com/app/apikey) provided by Google, which is safe to use. 🛡️
This application interacts with Google Bard and refines the results for coding purposes. 🎯
The main purpose of this is for **research** 🧪 and **educational** 🎓 purposes. It can be very useful for **data analysis** 📊 and **Programmers** 💻.

## Application main UI.
### BardCoder:
![bard_coder](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/bardcoder_main.png?raw=true "")</br>
### GeminiCoder:
![gemini_coder](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/bardcoder_main.png?raw=true "")</br>

### Code Interpreter:
![code_interpreter](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/code_interpreter_main_ui.png?raw=true "")</br>
Expand Down Expand Up @@ -42,19 +42,19 @@ The main purpose of this is for **research** 🧪 and **educational** 🎓 purpo

## Usage
There are 3 components of this application:
1. **_BardCoder_**: A coding assistant from Bard which automatically generates code from bard responses and refines it for coding purposes. This can be used by developers to get the correct code from Bard when they need help because the output is refined and fixed multiple times to provide the correct code.
1. **_Geminioder_**: A coding assistant from Gemini which automatically generates code from Gemini responses and refines it for coding purposes. This can be used by developers to get the correct code from Gemini when they need help because the output is refined and fixed multiple times to provide the correct code.
- File: `bardcoder.py`

2. **_Code Interpreter_**: This is an interpreter for bardcoder which can be used to run the code generated from bardcoder. This can be very useful for all users who want to do data analysis and machine learning with bard. This can generate graphs and charts from bard responses and can be used to do data analysis.
- File: `bardcode_interpreter.py`
2. **_Code Interpreter_**: This is an interpreter for Gemini which can be used to run the code generated from Geminicoder. This can be very useful for all users who want to do data analysis and machine learning with Gemini. This can generate graphs and charts from Gemini responses and can be used to do data analysis.
- File: `Geminicode_interpreter.py`

3. **_BardCoder Lib_**: This is a library for bardcoder which can be used to generate code from bard responses and refine it for coding purposes. You can use it to build your own application using bard.
3. **_GeminiCoder Lib_**: This is a library for Geminicoder which can be used to generate code from bard responses and refine it for coding purposes. You can use it to build your own application using Gemini.
- File: `bardcoder_lib.py`

## Using BardCoder:
To use BardCoder, you will need to run the following command:
To use GeminiCoder, you will need to run the following command:
```python bardcoder.py```
This will open the BardCoder UI in the terminal. And will be asked to enter prompts for bard.
This will open the GeminiCoder UI in the terminal. And will be asked to enter prompts for Gemini.
![bard_coder](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/bardcoder_main.png?raw=true "")</br>
Not this assumes you have already set the `API KEY` in your local environment. If you have not, please refer to the setup process.
The code generated will be placed in folder `codes` and the response will be placed in folder `response`.
Expand All @@ -77,7 +77,7 @@ Before prompting you should check the **Options** to change **Filenames** and **
You can set the `Upload Data` in **Options** to upload data for data analysis. (Right now this only supports Text files).
![upload_data_ui](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/upload_data_ui.png?raw=true "")</br>

After uploading the files you can ask for the prompts from bard. And you will get the output like this.
After uploading the files you can ask for the prompts from Gemini. And you will get the output like this.
![upload_data_output](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/upload_data_output.png?raw=true "")</br>

You can also set the `Expected Output` in **Options** to get the **Accuracy** of the code generated.
Expand Down Expand Up @@ -107,7 +107,7 @@ This has advanced **safety measures** and can detect the **safety** of the code
### Graphs and Visual Charts output:
To get Graphs and Charts output for your data visualization, you will install python packages `matplotlib`, `seaborn`, `cartopy`, `plotnine` and more. and run the following command: </br>
```python bardcode_interpreter.py``` </br>
And ask for the prompts from bard. And you will get the output like this:
And ask for the prompts from Gemini. And you will get the output like this:
Example Prompt:
```
In Python write me program to.
Expand All @@ -121,23 +121,23 @@ And you will get output like this.
![expected_output](https://github.com/haseeb-heaven/AutoBard-Coder/blob/master/resources/employees_chart.png?raw=true "")</br>

## Directory Structure
This application uses the Bard API to interact with bard and refine the results for coding purposes. All data that is generated is stored in the following directories:
- `response`: This directory contains all the responses from bard.
- `codes`: This directory contains all the code generated from bard.
- `uploads`: This directory contains all the data that is uploaded to bard.
- `lib`: This directory contains all the libraries for bardcoder.
- `resources`: This directory contains all the resources for bardcoder.
This application uses the Gemini API to interact with Gemini and refine the results for coding purposes. All data that is generated is stored in the following directories:
- `response`: This directory contains all the responses from Gemini.
- `codes`: This directory contains all the code generated from Gemini.
- `uploads`: This directory contains all the data that is uploaded to Gemini.
- `lib`: This directory contains all the libraries for Geminicoder.
- `resources`: This directory contains all the resources for Geminicoder.

## Features
Some of the features of AutoBard-Coder include:
- **Automatic** _code generation_ from bard responses
Some of the features of Gemini-Coder include:
- **Automatic** _code generation_ from Gemini responses
- **Refinement** of code for coding purposes
- Ability to **fix/debug** its own code
- Ability to generate **single** or **multiple** responses from bard
- Ability to generate **single** or **multiple** responses from Gemini
- Ability to **save** responses and run them locally
- Ability to access _local files_ for code interpretation
- **Data analysis** and machine learning capabilities
- **Graphs** and **Charts** generation from bard responses
- **Graphs** and **Charts** generation from Gemini responses
- Ability to **upload files** for data analysis and machine learning.
- Share code with others with powerered by **ShareGPT**.
- Advanced **safety measures** to detect the safety of the code generated.
Expand Down Expand Up @@ -166,4 +166,4 @@ All notable changes to this project will be documented in this file.


## License and Author
AutoBard-Coder was created by HeavenHM and is licensed under the MIT license.
Gemini-Coder was created by HeavenHM and is licensed under the MIT license.

0 comments on commit 7d1d367

Please sign in to comment.