Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #51

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+13 −3
Open

Update README.md #51

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebed0c2
Update README.md
mavaddat Jun 1, 2023
05e3c6c
Update README.md
mavaddat Jun 1, 2023
0ca9cd3
Update README.md
mavaddat Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Wolverine

<p align="center">

<img alt="Self-healing polymers animation" src="https://github.com/biobootloader/wolverine/assets/5055400/cde545a6-6c63-45ee-9708-275e1ecf09a0" />

</p>

## About

Give your python scripts regenerative healing abilities!
Expand Down Expand Up @@ -43,19 +49,23 @@ You can also use flag `--confirm=True` which will ask you `yes or no` before mak
| ------------------- | ----------------------------------------------------------------- | ------------- |
| OPENAI_API_KEY | OpenAI API key | None |
| DEFAULT_MODEL | GPT model to use | "gpt-4" |
| VALIDATE_JSON_RETRY | Number of retries when requesting OpenAI API (-1 means unlimites) | -1 |
| VALIDATE_JSON_RETRY | Number of retries when requesting OpenAI API (-1 means unlimited) | -1 |

## Future Plans

This is just a quick prototype I threw together in a few hours. There are many possible extensions and contributions are welcome:

- add flags to customize usage, such as asking for user confirmation before running changed code
- further iterations on the edit format that GPT responds in. Currently it struggles a bit with indentation, but I'm sure that can be improved
- a suite of example buggy files that we can test prompts on to ensure reliability and measure improvement
- a suite of example buggy files that we can test prompts to ensure reliability and measure improvement
- multiple files / codebases: send GPT everything that appears in the stacktrace
- graceful handling of large files - should we just send GPT relevant classes / functions?
- graceful handling of large files &mdash; sould we send GPT just the relevant classes / functions?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- graceful handling of large files &mdash; sould we send GPT just the relevant classes / functions?
- graceful handling of large files &mdash; should we send GPT just the relevant classes / functions?

- extension to languages other than python

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=biobootloader/wolverine&type=Date)](https://star-history.com/#biobootloader/wolverine)

<sup>🌟Graph courtesy of [star-history.com](https://star-history.com/).</sup>

<sup>Gif [fair-use](https://en.wikipedia.org/wiki/Fair_use) derivative of Rowan, SJ (2011) In: _Self-healing polymer fixes scratches._ https://youtu.be/h-fka0wfY8w. Accessed 1 Jun 2023 </sup>