Skip to content

Commit

Permalink
modify the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arifin-chemist89 committed Mar 28, 2024
1 parent e8356d6 commit db7b1ce
Showing 1 changed file with 39 additions and 11 deletions.
50 changes: 39 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,46 @@
[![Open in Codespaces](https://classroom.github.com/assets/launch-codespace-7f7980b617ed060a017424585567c406b6ee15c891e84e1186181d67ecf80aa0.svg)](https://classroom.github.com/open-in-codespaces?assignment_repo_id=14501082)
# <Your Project Name>
[![Open in Codespaces](https://classroom.github.com/assets/launch-codespace-7f7980b617ed060a017424585567c406b6ee15c891e84e1186181d67ecf80aa0.svg)](https://classroom.github.com/open-in-codespaces?assignment_repo_id=14501082)

<Short description of your project>
<p align="center">
<img src="images/logo.png" alt="SimpleGPT-BO Logo" width="200" height="200">
</p>

## Overview
# SimpleGPT-BO

<Long description of your project>
SimpleGPT-BO is an intuitive tool designed to democratize the power of ChatGPT-driven Bayesian Optimization, making it accessible and straightforward for both beginners and experienced users alike. By leveraging the MyGPT platform provided by ChatGPT, SimpleGPT-BO offers generated instructions and codes, allowing users to experience Bayesian Optimization (BO) under ChatGPT with minimal hassle.

## Setup command
## Features

See `postCreateCommand` from [`devcontainer.json`](.devcontainer/devcontainer.json).
- **Guided Bayesian Optimization**: Step-by-step guidance to perform Bayesian optimizations with the support of a Language Learning Model (LLM).
- **Multiple Acquisition Functions**: Includes four acquisition functions (PI, EI, UCB, TPE) to cater to different optimization needs.
- **Multi-objective Optimization**: Supports multi-objective optimizations through the weighted single objective transformation for comprehensive analysis and results.

## Run command
`pytest`
## Advantages

## Notes
- pip's install path is not included in the PATH var by default, so without installing via `sudo -H`, pytest would be unaccessible.
- **No Installation Required**: Use directly within ChatGPT without the need for any installations, making it accessible from any language environment.
- **Low Effort**: All instructions and codes are generated, significantly reducing the effort required for implementations.
- **Accessibility**: Can be used from anywhere, providing a seamless experience for users worldwide.
- **Innovative Integration**: Takes advantage of ChatGPT's capabilities for an enhanced Bayesian optimization process.

## Usage

1. **Via ChatGPT**: Login to ChatGPT and search for SimpleGPT-BO from the Explore GPTs section.
2. **Direct Access**: You can also access SimpleGPT-BO directly through [SimpleGPT-BO's URL](https://chat.openai.com/g/g-3pVerd4XF-simplegpt-bo).

## Limitations

- **Simple Optimizations**: Primarily designed for simple optimization tasks using basic acquisition functions.
- Additional limitations include a potential lack of depth in complex scenario analysis and a reliance on the quality of the generated instructions.

## Contributions

We welcome contributions from the community to make SimpleGPT-BO even better. Here are a few areas where you can help:

- **Extend Applications**: Contribute to extending the tool's capabilities to include access to more sophisticated BO tools through APIs.
- **Improve Instructions**: Enhance the quality and clarity of the generated instructions for better user interaction.
- **Personalize User Experience**: Work on improving the tool's personalization features to cater to user-specific needs and preferences.

Other areas for contributions include improving the documentation, reporting bugs, and suggesting new features.

---

We are excited to see how SimpleGPT-BO evolves with your support and contributions. Let's democratize Bayesian Optimization together!

0 comments on commit db7b1ce

Please sign in to comment.